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

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

Authentication

Login

POST /login

Request Fields

Path Type Description

username

String

The login username

password

String

The login password

HTTP Request

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

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

cURL Request

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

Response Fields

Path Type Description

access_token

String

The access token with JWT format issued by ExtremeCloud IQ

token_type

String

The type of token, only supports "Bearer" currently

expires_in

Number

The lifetime in seconds of the access token

Successful Login Response

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

{
  "access_token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTI0LCJleHAiOjE3ODM5NjM3MjR9.mVQiMHar_YGHnJa3fo81Mq7lbIHpGeKLSgHg7sDL4Vs",
  "token_type" : "Bearer",
  "expires_in" : 604800
}

Unsuccessful Login Response

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

{
  "error_code" : "BAD_REQUEST",
  "error_id" : "6d3761a5109e4e9bbb105e37c26737aa",
  "error_message" : "Access Denied!!!",
  "error_message_code" : "Access Denied!!!",
  "error_message_description" : "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTI0LCJleHAiOjE3ODM5NjM3MjR9.mVQiMHar_YGHnJa3fo81Mq7lbIHpGeKLSgHg7sDL4Vs
Content-Type: application/json
Host: api.extremecloudiq.com

cURL Request

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

Response Fields

No response field will be returned.

Successful Logout Response

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

Unsuccessful Logout Response

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

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

{
  "error_code" : "AUTH_TOKEN_REVOKED",
  "error_id" : "a698d361839145758d3902b1999bc9e7"
}

Authorization

Generate API token

POST /auth/apitoken

Request Fields

Path Type Description

expire_time

Number

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

permissions

Array

The permission list.

description

String

The token description

HTTP Request

POST /auth/apitoken HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js
Content-Length: 118
Host: api.extremecloudiq.com

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

Response Fields

Path Type Description

access_token

String

The API access token.

create_time

String

The create timestamp.

expire_time

String

The expire timestamp.

creator_id

Number

The user ID who created the API token.

customer_id

Number

The customer ID who owns the API token.

description

String

The description for the API token.

permissions

Array

The permissions for the API token.

HTTP Response

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

{
  "access_token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInNjb3BlcyI6WyJyZWFkOmFjY291bnQiXSwidXNlcklkIjoxLCJyb2xlIjoiQWRtaW5pc3RyYXRvciIsIm93bmVySWQiOjEwMiwiZGF0YUNlbnRlciI6IlVTX1dlc3QiLCJpc3MiOiJleHRyZW1lY2xvdWRpcS5jb20iLCJpYXQiOjE1OTgzNTg3NDYsImV4cCI6MTU5ODM2MjM0Nn0.aP5lD3i8TfmGSWeGacXmJfhne9rSI_06iaGOzdzMj4k",
  "create_time" : "2026-07-06T17:28:42.000+0000",
  "expire_time" : "2026-07-06T18:28:42.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js' \
    -d '{
  "expire_time" : 1783362522,
  "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
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js
Host: api.extremecloudiq.com

Response Fields

Path Type Description

user_id

Number

Account ID.

user_name

String

Account login name.

role

String

User role.

owner_id

Number

User’s home ownerId.

data_center

String

User’s data center.

scopes

Array

Login user’s permissions.

issued_at

String

The time at which the JWT was issued.

expiration_time

String

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

expires_in

Number

How many seconds when this token will expires.

HTTP Response

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

{
  "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:home", "account:external", "account:third-party-applications", "vhm:get-setting", "vhm:update-setting", "vhm:get-status", "viq:get-account-info", "viq:backup", "viq:reset", "viq:get-default-device-password", "viq:update-default-device-password", "viq:update-default-device-password-v1", "viq:download", "viq:export", "viq:import", "viq:get-export-import-status", "viq:get-backup-status", "backup:restore", "backup:delete", "backup:get-history-grid", "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:relaxed_read", "device:new", "device:del", "device:cli", "device:deploy", "device:manage", "device:unmanage", "device:reboot", "device:reset", "device:thread-commissioner", "d360:relaxed_read", "dashboard:relaxed_read", "client", "client:r", "applications-reports", "applications-usage", "rmuser-external-list", "rmuser-external-info", "rmuser-me", "rmuser-reports", "rmuser-id", "rmuser-list", "rmuser", "locations", "locations:r", "locations:floor-map-labels", "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", "mac-object-profiles", "mac-object-profiles:r", "mac-firewall-policies", "mac-firewall-policies:r", "ip-firewall-policies", "ip-firewall-policies:r", "tunnel-concentrator", "tunnel-concentrator:r", "network-services", "network-services:r", "radius-proxy", "radius-proxy:r", "radius-server", "radius-server:r", "radsec-proxies", "radsec-proxies:r", "usergroup", "usergroup:r", "credential-distribution-groups", "credential-distribution-groups:r", "third-party-api-connection", "third-party-api-connection: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", "certificate-bundles", "certificate-bundles:r", "radio-profile", "radio-profile:r", "iot-profile", "iot-profile:r", "client-monitor-profile", "client-monitor-profile:r", "user-profile-assignments", "user-profile-assignments:r", "switch-inspector", "copilot-connectivity-wired:r", "copilot-connectivity-wireless:r", "copilot-anomalies", "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", "hotspot-profile", "hotspot-profile:r", "hotspot-service-provider-profile", "hotspot-service-provider-profile:r", "afc:relaxed_read", "afc-filter-metadata:relaxed_read", "afc-export:relaxed_read", "afc-reports:relaxed_read", "floor-afc-details", "floor-afc-details:r", "rtts", "rtts:r", "ng-reports", "ng-reports:r", "acct-api-token", "acct-api-token:r", "site-afc-schedule", "site-afc-schedule:r", "ap-spectrum", "ap-spectrum:r", "afc-candidates", "ng-scheduled-reports:w", "ng-scheduled-get-reports:r", "account-user-external", "account-user-me", "client-user-reports", "account-user-id", "account-user-list", "account-user-create", "client-user-data-usage", "client-user-filter-metadata", "client-user-grid", "client-user-grid-export", "client-user-type-distribution", "account-user-modify", "client-location" ],
  "issued_at" : "2026-07-06T17:28:42.000+0000",
  "expiration_time" : "2026-07-13T17:28:42.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js'

Validate API token

POST /auth/apitoken/:validate

Request Body

eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js

HTTP Request

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

eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js

HTTP Response

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

cURL Request

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

Get user permissions

GET /auth/permissions

HTTP Request

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

Response Fields

Path Type Description

[].name

String

The permission name

[].description

String

The description for the permission

[].category

String

The category for the permission

HTTP Response

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

[ {
  "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:home",
  "description" : "Get home ExtremeCloud IQ account info",
  "category" : "Account"
}, {
  "name" : "account:external",
  "description" : "List accessible external guest accounts",
  "category" : "Account"
}, {
  "name" : "account:third-party-applications",
  "description" : "List Third Party Applications",
  "category" : "Account"
}, {
  "name" : "vhm:get-setting",
  "description" : "Get VHM account setting",
  "category" : "Account"
}, {
  "name" : "vhm:update-setting",
  "description" : "Update VHM account setting",
  "category" : "Account"
}, {
  "name" : "vhm:get-status",
  "description" : "Get VHM account status",
  "category" : "Account"
}, {
  "name" : "viq:get-account-info",
  "description" : "Get VIQ account information",
  "category" : "Account"
}, {
  "name" : "viq:backup",
  "description" : "Backup VIQ",
  "category" : "Account"
}, {
  "name" : "viq:reset",
  "description" : "Reset VIQ",
  "category" : "Account"
}, {
  "name" : "viq:get-default-device-password",
  "description" : "Get default device password",
  "category" : "Account"
}, {
  "name" : "viq:update-default-device-password",
  "description" : "Update default device password",
  "category" : "Account"
}, {
  "name" : "viq:update-default-device-password-v1",
  "description" : "Update default device password with validation",
  "category" : "Account"
}, {
  "name" : "viq:download",
  "description" : "Download VIQ data file and logs",
  "category" : "Account"
}, {
  "name" : "viq:export",
  "description" : "Export VIQ data",
  "category" : "Account"
}, {
  "name" : "viq:import",
  "description" : "Import VIQ data",
  "category" : "Account"
}, {
  "name" : "viq:get-export-import-status",
  "description" : "Get VIQ export and import status",
  "category" : "Account"
}, {
  "name" : "viq:get-backup-status",
  "description" : "Get VIQ backup status",
  "category" : "Account"
}, {
  "name" : "backup:restore",
  "description" : "Backup history restore",
  "category" : "Account"
}, {
  "name" : "backup:delete",
  "description" : "Backup history delete",
  "category" : "Account"
}, {
  "name" : "backup:get-history-grid",
  "description" : "List backup history grid",
  "category" : "Account"
}, {
  "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:relaxed_read",
  "description" : "Read device details with POST",
  "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" : "d360:relaxed_read",
  "description" : "Read D360 with POST",
  "category" : "D360"
}, {
  "name" : "dashboard:relaxed_read",
  "description" : "Read dashboard with POST",
  "category" : "Dashboard"
}, {
  "name" : "client",
  "description" : "Full control of clients",
  "category" : "Client"
}, {
  "name" : "client:r",
  "description" : "Read access to clients",
  "category" : "Client"
}, {
  "name" : "applications-reports",
  "description" : "Access to applications reports listing APIs",
  "category" : "Applications"
}, {
  "name" : "applications-usage",
  "description" : "Access to applications usage listing APIs",
  "category" : "Applications"
}, {
  "name" : "rmuser-external-list",
  "description" : "Admin only - list external users",
  "category" : "users"
}, {
  "name" : "rmuser-external-info",
  "description" : "Admin only - get external user info",
  "category" : "users"
}, {
  "name" : "rmuser-me",
  "description" : "Get current user info",
  "category" : "users"
}, {
  "name" : "rmuser-reports",
  "description" : "Download user reports",
  "category" : "users"
}, {
  "name" : "rmuser-id",
  "description" : "Get user info by ID",
  "category" : "users"
}, {
  "name" : "rmuser-list",
  "description" : "List all users",
  "category" : "users"
}, {
  "name" : "rmuser",
  "description" : "Access to users APIs",
  "category" : "users"
}, {
  "name" : "locations",
  "description" : "Full control of locations",
  "category" : "Locations"
}, {
  "name" : "locations:r",
  "description" : "Read access to locations",
  "category" : "Locations"
}, {
  "name" : "locations:floor-map-labels",
  "description" : "Floor Map Labels",
  "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" : "mac-object-profiles",
  "description" : "Full control of mac object profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "mac-object-profiles:r",
  "description" : "Read access to mac object profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "mac-firewall-policies",
  "description" : "Full control of mac firewall policy",
  "category" : "Configuration - Policy"
}, {
  "name" : "mac-firewall-policies:r",
  "description" : "Read access to mac firewall policy",
  "category" : "Configuration - Policy"
}, {
  "name" : "ip-firewall-policies",
  "description" : "Full control of IP Firewall policy",
  "category" : "Configuration - Policy"
}, {
  "name" : "ip-firewall-policies:r",
  "description" : "Read access to IP Firewall policy",
  "category" : "Configuration - Policy"
}, {
  "name" : "tunnel-concentrator",
  "description" : "Full control of tunnel concentrator service",
  "category" : "Configuration - Network"
}, {
  "name" : "tunnel-concentrator:r",
  "description" : "Read access to tunnel concentrator service",
  "category" : "Configuration - Network"
}, {
  "name" : "network-services",
  "description" : "Full control of network services",
  "category" : "Configuration - Network"
}, {
  "name" : "network-services:r",
  "description" : "Read access to network services",
  "category" : "Configuration - Network"
}, {
  "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" : "radsec-proxies",
  "description" : "Full control of RADSEC proxy",
  "category" : "Configuration - Authentication"
}, {
  "name" : "radsec-proxies:r",
  "description" : "Read access to RADSEC proxy",
  "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" : "credential-distribution-groups",
  "description" : "Full control of Credential Distribution Group",
  "category" : "Administration"
}, {
  "name" : "credential-distribution-groups:r",
  "description" : "Read access to Credential Distribution Group",
  "category" : "Administration"
}, {
  "name" : "third-party-api-connection",
  "description" : "Full control of third party api connections",
  "category" : "Administration"
}, {
  "name" : "third-party-api-connection:r",
  "description" : "Read access to third party api connections",
  "category" : "Administration"
}, {
  "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" : "certificate-bundles",
  "description" : "Full control of certificate bundle",
  "category" : "Configuration - Certificate"
}, {
  "name" : "certificate-bundles:r",
  "description" : "Read access to certificate bundle",
  "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" : "user-profile-assignments",
  "description" : "Full control of user profile assignment",
  "category" : "Configuration - Policy"
}, {
  "name" : "user-profile-assignments:r",
  "description" : "Read access to user profile assignment",
  "category" : "Configuration - Policy"
}, {
  "name" : "switch-inspector",
  "description" : "Switch inspector Diagnostics",
  "category" : "Switch Inspector Panel"
}, {
  "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",
  "description" : "Full control of Copilot Anomalies",
  "category" : "Copilot - Anomalies"
}, {
  "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"
}, {
  "name" : "hotspot-profile",
  "description" : "Full control of Hotspot Profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "hotspot-profile:r",
  "description" : "Read access to Hotspot Profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "hotspot-service-provider-profile",
  "description" : "Full control of Hotspot Service Provider Profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "hotspot-service-provider-profile:r",
  "description" : "Read access to Hotspot Service Provider Profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "afc:relaxed_read",
  "description" : "Read afc device details with POST",
  "category" : "Afc"
}, {
  "name" : "afc-filter-metadata:relaxed_read",
  "description" : "Read afc device details with POST",
  "category" : "Afc"
}, {
  "name" : "afc-export:relaxed_read",
  "description" : "Read afc device details with POST",
  "category" : "Afc"
}, {
  "name" : "afc-reports:relaxed_read",
  "description" : "Read afc device details with POST",
  "category" : "Afc"
}, {
  "name" : "floor-afc-details",
  "description" : "Full control of AFC Related Floor Height and Accuracy data",
  "category" : "Afc"
}, {
  "name" : "floor-afc-details:r",
  "description" : "Read access to AFC Related Floor Height and Accuracy data",
  "category" : "Afc"
}, {
  "name" : "rtts",
  "description" : "Full control of rtts",
  "category" : "rtts-endpoint"
}, {
  "name" : "rtts:r",
  "description" : "Read access to rtts",
  "category" : "rtts-endpoint"
}, {
  "name" : "ng-reports",
  "description" : "Full control of NG-REPORTS",
  "category" : "NG-REPORTS"
}, {
  "name" : "ng-reports:r",
  "description" : "Read access to NG-REPORTS",
  "category" : "NG-REPORTS"
}, {
  "name" : "acct-api-token",
  "description" : "Full control of API Access tokens",
  "category" : "Administration"
}, {
  "name" : "acct-api-token:r",
  "description" : "Read access to API Access tokens",
  "category" : "Administration"
}, {
  "name" : "site-afc-schedule",
  "description" : "Full control of Site Afc Schedule",
  "category" : "afc-endpoint"
}, {
  "name" : "site-afc-schedule:r",
  "description" : "Read access to Site Afc Schedule",
  "category" : "afc-endpoint"
}, {
  "name" : "ap-spectrum",
  "description" : "Full control of AP Spectrum",
  "category" : "afc-endpoint"
}, {
  "name" : "ap-spectrum:r",
  "description" : "Read access to AP Spectrum",
  "category" : "afc-endpoint"
}, {
  "name" : "afc-candidates",
  "description" : "Full control of AP Candidates",
  "category" : "afc-endpoint"
}, {
  "name" : "ng-scheduled-reports:w",
  "description" : "Write access to ng report (create, update, delete)",
  "category" : "NgReports"
}, {
  "name" : "ng-scheduled-get-reports:r",
  "description" : "Read access to ng report",
  "category" : "NgReports"
}, {
  "name" : "account-user-external",
  "description" : "Admin only - manage external users",
  "category" : "users"
}, {
  "name" : "account-user-me",
  "description" : "Get current user info",
  "category" : "users"
}, {
  "name" : "client-user-reports",
  "description" : "Download user reports",
  "category" : "users"
}, {
  "name" : "account-user-id",
  "description" : "Get user info by ID",
  "category" : "users"
}, {
  "name" : "account-user-list",
  "description" : "List all users",
  "category" : "users"
}, {
  "name" : "account-user-create",
  "description" : "Admin only - Create user",
  "category" : "users"
}, {
  "name" : "client-user-data-usage",
  "description" : "Get user data usage",
  "category" : "users"
}, {
  "name" : "client-user-filter-metadata",
  "description" : "List user grid filter metadata",
  "category" : "users"
}, {
  "name" : "client-user-grid",
  "description" : "List users grid",
  "category" : "users"
}, {
  "name" : "client-user-grid-export",
  "description" : "Export users grid data",
  "category" : "users"
}, {
  "name" : "client-user-type-distribution",
  "description" : "Get user type distribution",
  "category" : "users"
}, {
  "name" : "account-user-modify",
  "description" : "Modify user APIs",
  "category" : "users"
}, {
  "name" : "client-location",
  "description" : "Get client location information",
  "category" : "client-location"
} ]

cURL Request

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

Check permissions

POST /auth/permissions/:check

Request Fields

Path Type Description

uri

String

The request URI.

method

String

The HTTP request method.

HTTP Request

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

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

Response Fields

Path Type Description

roles[]

Array

The valid roles for request URI and request method

permissions[].name

String

The permission name.

permissions[].description

String

The permission description.

permissions[].category

String

The category for the permission.

HTTP Response

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

{
  "permissions" : [ {
    "name" : "account",
    "description" : "Full control of account settings",
    "category" : "Account"
  } ],
  "roles" : [ "Operator", "Administrator" ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/auth/permissions/:check' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTA1LCJleHAiOjE3ODM5NjM3MDV9.SrSSIp8wQQq62yVH7brbE5HjneTx6WhKzMJgkSlEEHI
Content-Type: application/json
Host: api.extremecloudiq.com

id=1

Response Fields

Path Type Description

access_token

String

Access token for the new account.

token_type

String

The type of token, only supports "Bearer" currently

expires_in

Number

The lifetime in seconds of the access token

HTTP Response

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

{
  "access_token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTA1LCJleHAiOjE3ODM5NjM3MDV9.SrSSIp8wQQq62yVH7brbE5HjneTx6WhKzMJgkSlEEHI",
  "token_type" : "Bearer",
  "expires_in" : 604800
}

cURL Request

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

List external accounts

GET /account/external

HTTP Request

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

Response Fields

Path Type Description

[].id

Number

The external account ID.

[].name

String

The external account name.

[].create_time

String

The create time.

[].update_time

String

The last update time.

[].data_center

String

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

[].alias

String

The alias of the external account.

[].active

Boolean

Flag to indicate whether external account is active.

HTTP Response

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

[ {
  "id" : 1,
  "create_time" : "2026-07-06T17:28:25.000+0000",
  "update_time" : "2026-07-06T17:28:25.000+0000",
  "name" : "admin1@cust001.com",
  "alias" : "admin1",
  "active" : false,
  "data_center" : "VA2"
}, {
  "id" : 2,
  "create_time" : "2026-07-06T17:28:25.000+0000",
  "update_time" : "2026-07-06T17:28:25.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTA1LCJleHAiOjE3ODM5NjM3MDV9.SrSSIp8wQQq62yVH7brbE5HjneTx6WhKzMJgkSlEEHI'

Get basic info

GET /account/home

HTTP Request

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

Response Fields

Path Type Description

id

Number

Account ID.

name

String

Account name.

create_time

String

Account create time.

update_time

String

The last update time.

account_type

String

Account type.

account_mode

String

Account mode.

quota

String

The max API requests per minute.

data_center

String

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

industry

String

The industry of the account belongs to.

country

String

The country for the account.

state

String

The state for the account, if any.

city

String

The city for the account.

address

String

The address for the account.

zipcode

String

The zipcode of the address.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:25.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTA1LCJleHAiOjE3ODM5NjM3MDV9.SrSSIp8wQQq62yVH7brbE5HjneTx6WhKzMJgkSlEEHI'

Get VIQ info

GET /account/viq

HTTP Request

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

Response Fields

Path Type Description

customer_id

String

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

vhm_id

String

Account name.

owner_id

Number

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

devices

Number

Total # of licensed devices.

standalone

Boolean

Whether HHM/HIQ is enabled or if standalone VIQ.

expired

Boolean

The license subscription expired.

licenses[]

Array

The license info list.

licenses[].id

Number

The license id.

licenses[].status

String

The license status.

licenses[].mode

String

The license mode.

licenses[].create_time

String

The license create time.

licenses[].update_time

String

The license update time.

licenses[].active_date

String

The license active time.

licenses[].expire_date

String

The license expire time.

licenses[].entitlement_key

String

The license entitlement key.

licenses[].entitlement_type

String

The license entitlement type.

licenses[].devices

Number

The device number.

licenses[].activated

Number

The activated device number.

licenses[].available

Number

The available device number.

licenses[].license_type

String

The Gemalto license type.

partner_id

String

The partner ID

partner_email

String

The partner email

HTTP Response

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

{
  "devices" : 10,
  "standalone" : true,
  "expired" : false,
  "customer_id" : "zzzzz-zzzzz-zzzzz-zzzzz-zzzzz-zzzzz",
  "vhm_id" : "VHM-000001",
  "owner_id" : 102,
  "licenses" : [ {
    "id" : 1,
    "create_time" : "2026-07-06T17:28:23.000+0000",
    "update_time" : "2026-07-06T17:28:23.000+0000",
    "status" : "EVAL",
    "active_date" : "2026-07-06T17:28:23.000+0000",
    "expire_date" : "2027-07-06T17:28:23.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" : "2026-05-06T17:28:23.000+0000",
    "update_time" : "2026-05-06T17:28:23.000+0000",
    "status" : "EVAL",
    "active_date" : "2026-06-06T17:28:23.000+0000",
    "expire_date" : "2026-06-29T17:28:23.000+0000",
    "entitlement_key" : "wwwww-wwwww-wwwww-wwwww-wwwww-wwwww",
    "entitlement_type" : "EVALUATION",
    "mode" : "EVAL",
    "devices" : 100,
    "activated" : 0,
    "available" : 0,
    "license_type" : ""
  } ],
  "partner_id" : "MSP-DZEDQVMZ",
  "partner_email" : "hbhatija@extremenetworks.com"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/account/viq' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAzLCJleHAiOjE3ODM5NjM3MDN9.25XsMLOOzpe6f9tGmztKx3oCV3Ku1aw6GGGj1gXWG_4'

Get Vhm Setting

GET /account/vhm/setting

HTTP Request

GET /account/vhm/setting HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAxLCJleHAiOjE3ODM5NjM3MDF9.Maaldn3uou13uPmXr5IR9OWi7A8y9vhZq3WWCEJOjjE
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

id

Number

The VHM Setting ID.

create_time

String

The create time of the VHM Setting.

update_time

String

The update time of the VHM Setting.

vhm_name

String

The VHM account name.

current_status

String

The VIQ Current status.

backed_up_on

Number

The timestamp when the last backup was performed.

enable_copilot

Boolean

Flag indicating whether Co-Pilot should be enabled (true) or disabled (false).

enable_ssh

Boolean

Flag indicating Ssh Availability.

enable_supplemental_cli

Boolean

Flag indicating Supplemental CLI.

enable_wireless_onboarding

Boolean

Flag indicating AP Out-of-the-box Wireless Onboarding.

enable_password_for_exos_voss

Boolean

Flag to enable device management settings for Switch Engine (EXOS) / Fabric Engine (VOSS) switches.

enable_auto_config_push

Boolean

Flag to enable auto config push.

enable_site_isolation

Boolean

Flag to enable site isolation.

enable_legacy_uztna_proxy

Boolean

Flag to enable legacy uztna proxy.

Response Body

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:21.000+0000",
  "update_time" : "2026-07-06T17:28:21.000+0000",
  "vhm_name" : "test_domain1",
  "current_status" : "ACTIVE",
  "backed_up_on" : 1723094719186,
  "enable_copilot" : false,
  "enable_ssh" : true,
  "enable_supplemental_cli" : false,
  "enable_wireless_onboarding" : true,
  "enable_password_for_exos_voss" : true,
  "enable_auto_config_push" : false,
  "enable_site_isolation" : false,
  "enable_legacy_uztna_proxy" : false
}

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:21.000+0000",
  "update_time" : "2026-07-06T17:28:21.000+0000",
  "vhm_name" : "test_domain1",
  "current_status" : "ACTIVE",
  "backed_up_on" : 1723094719186,
  "enable_copilot" : false,
  "enable_ssh" : true,
  "enable_supplemental_cli" : false,
  "enable_wireless_onboarding" : true,
  "enable_password_for_exos_voss" : true,
  "enable_auto_config_push" : false,
  "enable_site_isolation" : false,
  "enable_legacy_uztna_proxy" : false
}

cURL Request

$ curl 'https://api.extremecloudiq.com/account/vhm/setting' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAxLCJleHAiOjE3ODM5NjM3MDF9.Maaldn3uou13uPmXr5IR9OWi7A8y9vhZq3WWCEJOjjE' \
    -H 'Content-Type: application/json'

Update Vhm Setting

PUT /account/vhm/setting/{id}

Path Parameters

Table 1. /account/vhm/setting/{id}
Parameter Description

id

The Vhm Setting ID

Request Fields

Path Type Description

enable_ssh

Boolean

Flag indicating Ssh Availability.

enable_supplemental_cli

Boolean

Flag indicating Supplemental CLI.

enable_wireless_onboarding

Boolean

Flag indicating AP Out-of-the-box Wireless Onboarding.

enable_password_for_exos_voss

Boolean

Flag to enable device management settings for Switch Engine (EXOS) / Fabric Engine (VOSS) switches.

enable_auto_config_push

Boolean

Flag to enable auto config push.

enable_site_isolation

Boolean

Flag to enable site isolation.

enable_legacy_uztna_proxy

Boolean

Flag to enable legacy uztna proxy.

HTTP Request

PUT /account/vhm/setting/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAxLCJleHAiOjE3ODM5NjM3MDF9.Maaldn3uou13uPmXr5IR9OWi7A8y9vhZq3WWCEJOjjE
Content-Type: application/json
Content-Length: 254
Host: api.extremecloudiq.com

{
  "enable_ssh" : true,
  "enable_supplemental_cli" : false,
  "enable_wireless_onboarding" : true,
  "enable_password_for_exos_voss" : true,
  "enable_auto_config_push" : false,
  "enable_site_isolation" : false,
  "enable_legacy_uztna_proxy" : false
}

Response Fields

Path Type Description

id

Number

The VHM Setting ID.

create_time

String

The create time of the VHM Setting.

update_time

String

The update time of the VHM Setting.

enable_ssh

Boolean

Flag indicating Ssh Availability.

enable_supplemental_cli

Boolean

Flag indicating Supplemental CLI.

enable_wireless_onboarding

Boolean

Flag indicating AP Out-of-the-box Wireless Onboarding.

enable_password_for_exos_voss

Boolean

Flag to enable device management settings for Switch Engine (EXOS) / Fabric Engine (VOSS) switches.

enable_auto_config_push

Boolean

Flag to enable auto config push.

enable_site_isolation

Boolean

Flag to enable site isolation.

enable_legacy_uztna_proxy

Boolean

Flag to enable legacy uztna proxy.

Response Body

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:21.000+0000",
  "update_time" : "2026-07-06T17:28:21.000+0000",
  "enable_ssh" : true,
  "enable_supplemental_cli" : false,
  "enable_wireless_onboarding" : true,
  "enable_password_for_exos_voss" : true,
  "enable_auto_config_push" : false,
  "enable_site_isolation" : false,
  "enable_legacy_uztna_proxy" : false
}

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:21.000+0000",
  "update_time" : "2026-07-06T17:28:21.000+0000",
  "enable_ssh" : true,
  "enable_supplemental_cli" : false,
  "enable_wireless_onboarding" : true,
  "enable_password_for_exos_voss" : true,
  "enable_auto_config_push" : false,
  "enable_site_isolation" : false,
  "enable_legacy_uztna_proxy" : false
}

cURL Request

$ curl 'https://api.extremecloudiq.com/account/vhm/setting/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAxLCJleHAiOjE3ODM5NjM3MDF9.Maaldn3uou13uPmXr5IR9OWi7A8y9vhZq3WWCEJOjjE' \
    -H 'Content-Type: application/json' \
    -d '{
  "enable_ssh" : true,
  "enable_supplemental_cli" : false,
  "enable_wireless_onboarding" : true,
  "enable_password_for_exos_voss" : true,
  "enable_auto_config_push" : false,
  "enable_site_isolation" : false,
  "enable_legacy_uztna_proxy" : false
}'

Get Vhm Status

GET /account/vhm/status

HTTP Request

GET /account/vhm/status HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAxLCJleHAiOjE3ODM5NjM3MDF9.Maaldn3uou13uPmXr5IR9OWi7A8y9vhZq3WWCEJOjjE
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

vhm_name

String

The VHM account name.

current_status

String

The VIQ Current status.

Response Body

{
  "vhm_name" : "test_domain1",
  "current_status" : "ACTIVE_STATUS"
}

HTTP Response

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

{
  "vhm_name" : "test_domain1",
  "current_status" : "ACTIVE_STATUS"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/account/vhm/status' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAxLCJleHAiOjE3ODM5NjM3MDF9.Maaldn3uou13uPmXr5IR9OWi7A8y9vhZq3WWCEJOjjE' \
    -H 'Content-Type: application/json'

VIQ backup

POST /account/viq/:backup

HTTP Request

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

HTTP Response

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

cURL Request

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

Get VIQ backup status

GET /account/viq/backup/status

HTTP Request

GET /account/viq/backup/status HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAzLCJleHAiOjE3ODM5NjM3MDN9.25XsMLOOzpe6f9tGmztKx3oCV3Ku1aw6GGGj1gXWG_4
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

status

String

The backup status. Possible values: IDLE, IN_PROGRESS, COMPLETED, FAILED

last_backup_initiated

Number

Epoch millis when the last/current backup was initiated

last_backup_completed

Number

Epoch millis when the last backup completed

HTTP Response

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

{
  "status" : "COMPLETED",
  "last_backup_initiated" : 1715072598000,
  "last_backup_completed" : 1715072898000
}

cURL Request

$ curl 'https://api.extremecloudiq.com/account/viq/backup/status' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAzLCJleHAiOjE3ODM5NjM3MDN9.25XsMLOOzpe6f9tGmztKx3oCV3Ku1aw6GGGj1gXWG_4' \
    -H 'Content-Type: application/json'

VIQ reset

POST /account/viq/:reset

HTTP Request

POST /account/viq/:reset HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAxLCJleHAiOjE3ODM5NjM3MDF9.Maaldn3uou13uPmXr5IR9OWi7A8y9vhZq3WWCEJOjjE
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/account/viq/:reset' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAxLCJleHAiOjE3ODM5NjM3MDF9.Maaldn3uou13uPmXr5IR9OWi7A8y9vhZq3WWCEJOjjE' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAwLCJleHAiOjE3ODM5NjM3MDB9.awwgxFyvRibKaNsss5r6dOmExpjRmuT9HzitfMrT0ss
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

password

String

The default device password.

HTTP Response

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

{
  "password" : ""
}

cURL Request

$ curl 'https://api.extremecloudiq.com/account/viq/default-device-password' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAwLCJleHAiOjE3ODM5NjM3MDB9.awwgxFyvRibKaNsss5r6dOmExpjRmuT9HzitfMrT0ss' \
    -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
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAwLCJleHAiOjE3ODM5NjM3MDB9.awwgxFyvRibKaNsss5r6dOmExpjRmuT9HzitfMrT0ss
Content-Length: 14
Host: api.extremecloudiq.com

"'0qMFXrPXyD'"

HTTP Response

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

cURL Request

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

VIQ Export

GET /account/viq/export

Request Parameters

Parameter Description

timeoutInSeconds

The maximum export duration

excludeDeviceFirmware

Whether exclude device firmwares from VIQ export file or not

HTTP Request

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

timeoutInSeconds=1800

Response Fields

Path Type Description

export_status

String

The viq export status

export_file_name

String

The viq export report file name

log_file_name

String

The viq export log file name

HTTP Response

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

{
  "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAzLCJleHAiOjE3ODM5NjM3MDN9.25XsMLOOzpe6f9tGmztKx3oCV3Ku1aw6GGGj1gXWG_4' \
    -H 'Content-Type: application/json' \
    -d 'timeoutInSeconds=1800'

VIQ Import

GET /account/viq/import

Request Parameters

Parameter Description

timeoutInSeconds

The maximum import duration

resendUserNotifications

Resend Cloud PPSK/RADIUS password through email/SMS

HTTP Request

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

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

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


--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

Response Fields

Path Type Description

import_status

String

The viq import status

log_file_name

String

The viq import log file name

HTTP Response

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

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

cURL Request

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

VIQ Download

GET /account/viq/download

Request Parameters

Parameter Description

reportName

The report full name

HTTP Request

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

HTTP Response

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

/var/lib/jenkins/workspace/XIQ/Continous_Integration/XIQ-RELEASE-BUILDS/RELEASE-25.11.2/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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAzLCJleHAiOjE3ODM5NjM3MDN9.25XsMLOOzpe6f9tGmztKx3oCV3Ku1aw6GGGj1gXWG_4' \
    -H 'Content-Type: application/json'

VIQ Export Import Status

GET /account/viq/export-import-status

Request Parameters

Parameter Description

viqOperationType

The type of operation to get status

HTTP Request

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

Response Fields

Path Type Description

user_name

String

User Name

vhm_id

String

VHM Id of the user

operation

String

Type of Operation export/import

status

String

Status of the request

total_finish_percentage

Number

Total finish percentage of the operation

viq_task_progresses[].task_name

String

Name of the task

viq_task_progresses[].finish_percentage

Number

Percentage of the task

viq_task_progresses[].detail

String

Detailed info of the task

viq_task_progresses[].status

String

Status of the task

export_file_name

String

The viq export report file name

log_file_name

String

The viq export log file name

export_time

Number

The viq export time

start_time

Number

The start time

end_time

Number

The end time

remain_time

Number

The remaining time

HTTP Response

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

{
  "user_name" : "admin@cust001.com",
  "vhm_id" : "VHM-000001",
  "operation" : "EXPORT",
  "status" : "SUCCESS",
  "total_finish_percentage" : 100,
  "export_file_name" : "Exported_VHM-000001_20240814-093707.tar.gz",
  "log_file_name" : "Export_VHM-000001_20240814-093707.log",
  "export_time" : 1723663510729,
  "start_time" : 0,
  "end_time" : 0,
  "remain_time" : 0,
  "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTAzLCJleHAiOjE3ODM5NjM3MDN9.25XsMLOOzpe6f9tGmztKx3oCV3Ku1aw6GGGj1gXWG_4' \
    -H 'Content-Type: application/json'

Backup history restore

POST /backup/history/:restore

Request Parameters

Parameter Description

backupFile

The backup file that needs to be restored.

HTTP Request

POST /backup/history/:restore HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk2LCJleHAiOjE3ODM5NjM2OTZ9.c4EHmvUyLpYw7vLEUmgKwZCv26v1RngLakPkcLE6rxg
Content-Type: application/json
Host: api.extremecloudiq.com

backupFile=24.5.0.0-XASy-SNAPSHOT_1720506173748

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/backup/history/:restore' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk2LCJleHAiOjE3ODM5NjM2OTZ9.c4EHmvUyLpYw7vLEUmgKwZCv26v1RngLakPkcLE6rxg' \
    -H 'Content-Type: application/json' \
    -d 'backupFile=24.5.0.0-XASy-SNAPSHOT_1720506173748'

List backup history grid

GET /backup/history/grid

Request Parameters

Parameter Description

page

Page number

limit

Page size

keyword

The search keyword

order

The sort order

HTTP Request

GET /backup/history/grid?page=1&limit=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk2LCJleHAiOjE3ODM5NjM2OTZ9.c4EHmvUyLpYw7vLEUmgKwZCv26v1RngLakPkcLE6rxg
Content-Type: application/json
Host: api.extremecloudiq.com

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

Number

The backup date.

data[].backup_units

String

The units of the backup.

data[].owner_id

Number

The owner ID.

data[].backup_file_name

String

The filename of the backup entry.

data[].backup_version

String

The version of the backup.

data[].backup_file_suffix

String

The suffix of the backup file.

data[].version_matched

Boolean

If this flag is true, it indicates that backup can be restored.

Response Body

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 3,
  "data" : [ {
    "backup_date" : 1720506187810,
    "backup_units" : "CONFIG",
    "owner_id" : 102,
    "backup_file_name" : "24.5.0.0-XASy-SNAPSHOT_1720506173748",
    "backup_version" : "24.5.0.0-XASy-SNAPSHOT",
    "backup_file_suffix" : ".tar",
    "version_matched" : true
  } ]
}

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 3,
  "data" : [ {
    "backup_date" : 1720506187810,
    "backup_units" : "CONFIG",
    "owner_id" : 102,
    "backup_file_name" : "24.5.0.0-XASy-SNAPSHOT_1720506173748",
    "backup_version" : "24.5.0.0-XASy-SNAPSHOT",
    "backup_file_suffix" : ".tar",
    "version_matched" : true
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/backup/history/grid?page=1&limit=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk2LCJleHAiOjE3ODM5NjM2OTZ9.c4EHmvUyLpYw7vLEUmgKwZCv26v1RngLakPkcLE6rxg' \
    -H 'Content-Type: application/json'

Backup history delete

DELETE /backup/history/delete

Request Parameters

Parameter Description

backupFiles

The list of backup files (comma-separated) that need to be deleted.

HTTP Request

DELETE /backup/history/delete?backupFiles=24.5.0.0-XASy-SNAPSHOT_1720506173748 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk2LCJleHAiOjE3ODM5NjM2OTZ9.c4EHmvUyLpYw7vLEUmgKwZCv26v1RngLakPkcLE6rxg
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/backup/history/delete?backupFiles=24.5.0.0-XASy-SNAPSHOT_1720506173748' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk2LCJleHAiOjE3ODM5NjM2OTZ9.c4EHmvUyLpYw7vLEUmgKwZCv26v1RngLakPkcLE6rxg' \
    -H 'Content-Type: application/json'

User

List users

GET /users

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

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

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The user ID.

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].login_name

String

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

data[].first_name

String

The first name.

data[].last_name

String

The last name, i.e. family name.

data[].display_name

String

The name to display.

data[].phone

String

The Phone Number.

data[].job_title

String

The job title.

data[].locale

String

The locale.

data[].idle_timeout

Number

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

data[].last_login_time

String

The last login time.

data[].org_id

Number

The HIQ org_id if it is HIQ user.

data[].user_role

String

The user role.

data[].location_ids

Array

The assigned location IDs.

data[].access_scope

Number

The user has access on all sites / the authorized sites. 0 = VIQ_SCOPE, 1 = SITE_SCOPE.

data[].viq_access_control

Number

The permissions for Site Scope user on Global Scope resources. 0 = READ_WRITE, 1 = READ_ONLY.

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 2,
  "data" : [ {
    "id" : 1,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.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" : "2026-07-06T17:28:11.000+0000",
    "org_id" : 0,
    "location_ids" : [ 438086664193 ],
    "access_scope" : 0,
    "viq_access_control" : 0
  }, {
    "id" : 2,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.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" : "2026-07-06T17:28:11.000+0000",
    "org_id" : 0,
    "location_ids" : [ 438086664193 ],
    "access_scope" : 0,
    "viq_access_control" : 0
  } ]
}

cURL Request

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

Create new user

POST /users

Request Fields

Path Type Description

login_name

String

The login name

display_name

String

The display name

idle_timeout

Number

The idle timeout in minutes

user_role

String

The user administrative role

location_ids

Array

The location IDs to assign.

access_scope

Number

The user has access on all sites / the authorized sites. 0 = VIQ_SCOPE, 1 = SITE_SCOPE.

viq_access_control

Number

The permissions for Site Scope user on Global Scope resources. 0 = READ_WRITE, 1 = READ_ONLY.

HTTP Request

POST /users HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODkxLCJleHAiOjE3ODM5NjM2OTF9.mzPj6at82468OUIWN0n2bMIqntOmAxifvRmMJqWm3MU
Content-Type: application/json
Content-Length: 219
Host: api.extremecloudiq.com

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

Response Fields

Path Type Description

id

Number

User ID.

create_time

String

User create time.

update_time

String

User update time.

login_name

String

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

first_name

String

The first name.

last_name

String

The last name, i.e. family name.

display_name

String

The name to display.

phone

String

The Phone Number.

job_title

String

The job title.

locale

String

The locale.

idle_timeout

Number

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

last_login_time

String

The last login time.

org_id

Number

The HIQ org_id if it is HIQ user.

user_role

String

The user role.

location_ids

Array

The assigned location IDs.

access_scope

Number

The user has access on all sites / the authorized sites. 0 = VIQ_SCOPE, 1 = SITE_SCOPE.

viq_access_control

Number

The permissions for Site Scope user on Global Scope resources. 0 = READ_WRITE, 1 = READ_ONLY.

HTTP Response

HTTP/1.1 201 Created
RateLimit: "default";r=7215
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 498

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:11.000+0000",
  "update_time" : "2026-07-06T17:28:11.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" : "2026-07-06T17:28:11.000+0000",
  "org_id" : 0,
  "location_ids" : [ ],
  "access_scope" : 0,
  "viq_access_control" : 0
}

cURL Request

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

Get user

GET /users/{id}

Path parameters

Table 2. /users/{id}
Parameter Description

id

User ID

HTTP Request

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

Response Fields

Path Type Description

id

Number

User ID.

create_time

String

User create time.

update_time

String

User update time.

login_name

String

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

first_name

String

The first name.

last_name

String

The last name, i.e. family name.

display_name

String

The name to display.

phone

String

The Phone Number.

job_title

String

The job title.

locale

String

The locale.

idle_timeout

Number

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

last_login_time

String

The last login time.

org_id

Number

The HIQ org_id if it is HIQ user.

user_role

String

The user role.

location_ids

Array

The assigned location IDs.

access_scope

Number

The user has access on all sites / the authorized sites. 0 = VIQ_SCOPE, 1 = SITE_SCOPE.

viq_access_control

Number

The permissions for Site Scope user on Global Scope resources. 0 = READ_WRITE, 1 = READ_ONLY.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:11.000+0000",
  "update_time" : "2026-07-06T17:28:11.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" : "2026-07-06T17:28:11.000+0000",
  "org_id" : 0,
  "location_ids" : [ ],
  "access_scope" : 0,
  "viq_access_control" : 0
}

cURL Request

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

Delete user

DELETE /users/{id}

Path Parameters

Table 3. /users/{id}
Parameter Description

id

The location ID

HTTP Request

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

HTTP Response

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

cURL Request

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

Update user

PATCH /users/{id}

Path Parameters

Table 4. /users/{id}
Parameter Description

id

The location ID

Request Fields

Path Type Description

login_name

String

The login name

display_name

String

The display name

idle_timeout

Number

The idle timeout in minutes

user_role

String

The user administrative role

location_ids

Array

The location IDs to assign.

access_scope

Number

The user has access on all sites / the authorized sites. 0 = VIQ_SCOPE, 1 = SITE_SCOPE.

viq_access_control

Number

The permissions for Site Scope user on Global Scope resources. 0 = READ_WRITE, 1 = READ_ONLY.

HTTP Request

PATCH /users/1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODkxLCJleHAiOjE3ODM5NjM2OTF9.mzPj6at82468OUIWN0n2bMIqntOmAxifvRmMJqWm3MU
Content-Type: application/json
Content-Length: 219
Host: api.extremecloudiq.com

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

Response Fields

Path Type Description

id

Number

User ID.

create_time

String

User create time.

update_time

String

User update time.

login_name

String

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

first_name

String

The first name.

last_name

String

The last name, i.e. family name.

display_name

String

The name to display.

phone

String

The Phone Number.

job_title

String

The job title.

locale

String

The locale.

idle_timeout

Number

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

last_login_time

String

The last login time.

org_id

Number

The HIQ org_id if it is HIQ user.

user_role

String

The user role.

location_ids

Array

The assigned location IDs.

access_scope

Number

The user has access on all sites / the authorized sites. 0 = VIQ_SCOPE, 1 = SITE_SCOPE.

viq_access_control

Number

The permissions for Site Scope user on Global Scope resources. 0 = READ_WRITE, 1 = READ_ONLY.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:11.000+0000",
  "update_time" : "2026-07-06T17:28:11.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" : "2026-07-06T17:28:11.000+0000",
  "org_id" : 0,
  "location_ids" : [ 438086664193 ],
  "access_scope" : 0,
  "viq_access_control" : 0
}

cURL Request

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

List external users

GET /users/external

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

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

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The external user ID.

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].login_name

String

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

data[].org_id

Number

The HIQ org_id if it is HIQ user.

data[].user_role

String

The user role.

data[].location_ids

Array

The assigned location IDs.

data[].grantee_id

Number

The home VIQ user ID of external user.

data[].access_scope

Number

The user has access on all sites / the authorized sites. 0 = VIQ_SCOPE, 1 = SITE_SCOPE.

data[].viq_access_control

Number

The permissions for Site Scope user on Global Scope resources. 0 = READ_WRITE, 1 = READ_ONLY.

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 3,
  "data" : [ {
    "id" : 1,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.000+0000",
    "login_name" : "operator1@extermenetworks.com",
    "user_role" : "OPERATOR",
    "org_id" : 0,
    "location_ids" : [ 438086664193 ],
    "grantee_id" : 1,
    "access_scope" : 0,
    "viq_access_control" : 0
  }, {
    "id" : 2,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.000+0000",
    "login_name" : "operator2@extermenetworks.com",
    "user_role" : "OPERATOR",
    "org_id" : 0,
    "location_ids" : [ 438086664193 ],
    "grantee_id" : 2,
    "access_scope" : 0,
    "viq_access_control" : 0
  }, {
    "id" : 3,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.000+0000",
    "login_name" : "operator3@extermenetworks.com",
    "user_role" : "OPERATOR",
    "org_id" : 0,
    "location_ids" : [ 438086664193 ],
    "grantee_id" : 3,
    "access_scope" : 0,
    "viq_access_control" : 0
  } ]
}

cURL Request

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

Grant external user

POST /users/external

Request Fields

Path Type Description

login_name

String

The login name

user_role

String

The user administrative role

org_id

Number

The HIQ organization ID if it is HIQ user

location_ids

Array

The assigned location IDs.

access_scope

Number

The user has access on all sites / the authorized sites. 0 = VIQ_SCOPE, 1 = SITE_SCOPE.

viq_access_control

Number

The permissions for Site Scope user on Global Scope resources. 0 = READ_WRITE, 1 = READ_ONLY.

HTTP Request

POST /users/external HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODkxLCJleHAiOjE3ODM5NjM2OTF9.mzPj6at82468OUIWN0n2bMIqntOmAxifvRmMJqWm3MU
Content-Type: application/json
Content-Length: 167
Host: api.extremecloudiq.com

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

Response Fields

Path Type Description

id

Number

External user ID.

create_time

String

User create time.

update_time

String

User update time.

login_name

String

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

org_id

Number

The HIQ org_id if it is HIQ user.

user_role

String

The user role.

location_ids

Array

The assigned location IDs.

grantee_id

Number

The home VIQ user ID of external user.

access_scope

Number

The user has access on all sites / the authorized sites. 0 = VIQ_SCOPE, 1 = SITE_SCOPE.

viq_access_control

Number

The permissions for Site Scope user on Global Scope resources. 0 = READ_WRITE, 1 = READ_ONLY.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:11.000+0000",
  "update_time" : "2026-07-06T17:28:11.000+0000",
  "login_name" : "operator1@extermenetworks.com",
  "user_role" : "OPERATOR",
  "org_id" : 0,
  "location_ids" : [ ],
  "grantee_id" : 1,
  "access_scope" : 0,
  "viq_access_control" : 0
}

cURL Request

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

Get external user

GET /users/external/{id}

Path parameters

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

id

The external user ID

HTTP Request

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

Response Fields

Path Type Description

id

Number

External user ID.

create_time

String

User create time.

update_time

String

User update time.

login_name

String

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

org_id

Number

The HIQ org_id if it is HIQ user.

user_role

String

The user role.

location_ids

Array

The assigned location IDs.

grantee_id

Number

The home VIQ user ID of external user.

access_scope

Number

The user has access on all sites / the authorized sites. 0 = VIQ_SCOPE, 1 = SITE_SCOPE.

viq_access_control

Number

The permissions for Site Scope user on Global Scope resources. 0 = READ_WRITE, 1 = READ_ONLY.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:11.000+0000",
  "update_time" : "2026-07-06T17:28:11.000+0000",
  "login_name" : "operator1@extermenetworks.com",
  "user_role" : "OPERATOR",
  "org_id" : 0,
  "location_ids" : [ ],
  "grantee_id" : 1,
  "access_scope" : 0,
  "viq_access_control" : 0
}

cURL Request

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

Revoke external user

DELETE /users/external/{id}

Path Parameters

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

id

The external user ID

HTTP Request

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

HTTP Response

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

cURL Request

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

Update external user

PATCH /users/external/{id}

Path Parameters

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

id

The external user ID

Request Fields

Path Type Description

user_role

String

The user administrative role

org_id

Number

The HIQ organization ID if it is HIQ user

location_ids

Array

The location IDs to assign.

access_scope

Number

The user has access on all sites / the authorized sites. 0 = VIQ_SCOPE, 1 = SITE_SCOPE.

viq_access_control

Number

The permissions for Site Scope user on Global Scope resources. 0 = READ_WRITE, 1 = READ_ONLY.

HTTP Request

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

{
  "user_role" : "OPERATOR"
}

HTTP Response

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

cURL Request

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

Get current user

GET /users/me

HTTP Request

GET /users/me HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODkxLCJleHAiOjE3ODM5NjM2OTF9.mzPj6at82468OUIWN0n2bMIqntOmAxifvRmMJqWm3MU
Host: api.extremecloudiq.com

Response Fields

Path Type Description

id

Number

User ID.

create_time

String

User create time.

update_time

String

User update time.

login_name

String

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

first_name

String

The first name.

last_name

String

The last name, i.e. family name.

display_name

String

The name to display.

phone

String

The Phone Number.

job_title

String

The job title.

locale

String

The locale.

idle_timeout

Number

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

last_login_time

String

The last login time.

org_id

Number

The HIQ org_id if it is HIQ user.

user_role

String

The user role name.

location_ids

Array

The assigned location IDs.

access_scope

Number

The user has access on all sites / the authorized sites. 0 = VIQ_SCOPE, 1 = SITE_SCOPE.

viq_access_control

Number

The permissions for Site Scope user on Global Scope resources. 0 = READ_WRITE, 1 = READ_ONLY.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:11.000+0000",
  "update_time" : "2026-07-06T17:28:11.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" : "2026-07-06T17:28:11.000+0000",
  "org_id" : 0,
  "location_ids" : [ ],
  "access_scope" : 0,
  "viq_access_control" : 0
}

cURL Request

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

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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

reading_org_ids.[]

Array

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

creating_org_id

Number

The organization ID for creating new data.

HTTP Response

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

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

Set HIQ context

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

PUT /hiq/context

Request Fields

Path Type Description

creating_org_id

Number

The organization ID for creating new data.

reading_org_ids

Array

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

HTTP Request

PUT /hiq/context HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo
Content-Type: application/json
Content-Length: 62
Host: api.extremecloudiq.com

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

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/context' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo' \
    -H 'Content-Type: application/json' \
    -d '{
  "reading_org_ids" : [ 1, 2, 3 ],
  "creating_org_id" : 1
}'

Get creating context

Get organization for creating new data

GET /hiq/context/creating

HTTP Request

GET /hiq/context/creating HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

1

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/context/creating' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo' \
    -H 'Content-Type: application/json'

Set creating context

Set organization for creating new data

PUT /hiq/context/creating

HTTP Request

PUT /hiq/context/creating HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo
Content-Type: application/json
Content-Length: 1
Host: api.extremecloudiq.com

1

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/context/creating' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo' \
    -H 'Content-Type: application/json' \
    -d '1'

Get reading context

Get organizations for reading data

GET /hiq/context/reading

HTTP Request

GET /hiq/context/reading HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

[ 1, 2, 3 ]

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/context/reading' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo' \
    -H 'Content-Type: application/json'

Set reading context

Set organizations for reading data

PUT /hhm/context/reading

HTTP Request

PUT /hiq/context/reading HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo
Content-Type: application/json
Content-Length: 11
Host: api.extremecloudiq.com

[ 1, 2, 3 ]

HTTP Response

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

cURL Request

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

Get all organizations

GET /hiq/organizations

HTTP Request

GET /hiq/organizations HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

[].id

Number

The unique identifier.

[].create_time

String

The create time.

[].update_time

String

The last update time.

[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

[].name

String

The organization name.

[].type

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

The organization type.

[].color

String

tagged color for the organization.

HTTP Response

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

[ {
  "id" : 1,
  "create_time" : "2026-07-06T17:28:00.000+0000",
  "update_time" : "2026-07-06T17:28:00.000+0000",
  "org_id" : 1,
  "name" : "Example-corp-0",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 2,
  "create_time" : "2026-07-06T17:28:00.000+0000",
  "update_time" : "2026-07-06T17:28:00.000+0000",
  "org_id" : 2,
  "name" : "Example-corp-1",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 3,
  "create_time" : "2026-07-06T17:28:00.000+0000",
  "update_time" : "2026-07-06T17:28:00.000+0000",
  "org_id" : 3,
  "name" : "Example-corp-2",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 4,
  "create_time" : "2026-07-06T17:28:00.000+0000",
  "update_time" : "2026-07-06T17:28:00.000+0000",
  "org_id" : 4,
  "name" : "Example-corp-3",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 5,
  "create_time" : "2026-07-06T17:28:00.000+0000",
  "update_time" : "2026-07-06T17:28:00.000+0000",
  "org_id" : 5,
  "name" : "Example-corp-4",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 6,
  "create_time" : "2026-07-06T17:28:00.000+0000",
  "update_time" : "2026-07-06T17:28:00.000+0000",
  "org_id" : 6,
  "name" : "Example-corp-5",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 7,
  "create_time" : "2026-07-06T17:28:00.000+0000",
  "update_time" : "2026-07-06T17:28:00.000+0000",
  "org_id" : 7,
  "name" : "Example-corp-6",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 8,
  "create_time" : "2026-07-06T17:28:00.000+0000",
  "update_time" : "2026-07-06T17:28:00.000+0000",
  "org_id" : 8,
  "name" : "Example-corp-7",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 9,
  "create_time" : "2026-07-06T17:28:00.000+0000",
  "update_time" : "2026-07-06T17:28:00.000+0000",
  "org_id" : 9,
  "name" : "Example-corp-8",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 10,
  "create_time" : "2026-07-06T17:28:00.000+0000",
  "update_time" : "2026-07-06T17:28:00.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo' \
    -H 'Content-Type: application/json'

Create organization

POST /hiq/organizations

Request Fields

Path Type Description

name

String

The organization name, must be unique in VIQ.

color

String

The tagged color for the organization.

HTTP Request

POST /hiq/organizations HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo
Content-Type: application/json
Content-Length: 56
Host: api.extremecloudiq.com

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

Response Fields

Path Type Description

id

Number

The unique identifier.

create_time

String

The create time.

update_time

String

The last update time.

org_id

Number

The organization identifier, valid when enabling HIQ feature.

name

String

The organization name.

type

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

The organization type.

color

String

tagged color for the organization.

HTTP Response

HTTP/1.1 201 Created
RateLimit: "default";r=7324
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 199

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:00.000+0000",
  "update_time" : "2026-07-06T17:28:00.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "example-organization",
  "color" : "red"
}'

Delete organization

DELETE /hiq/organizations/{id}

Path Parameters

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

id

Organization ID to delete.

HTTP Request

DELETE /hiq/organizations/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

HTTP/1.1 204 No Content
RateLimit: "default";r=7325
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/organizations/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo' \
    -H 'Content-Type: application/json'

Rename organization

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

Path Parameters

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

id

Organization ID to delete.

HTTP Request

POST /hiq/organizations/438086664193/:rename HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo
Content-Type: application/json
Content-Length: 21
Host: api.extremecloudiq.com

New organization name

HTTP Response

HTTP/1.1 204 No Content
RateLimit: "default";r=7323
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/organizations/438086664193/:rename' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo' \
    -H 'Content-Type: application/json' \
    -d 'New organization name'

Get HIQ status

GET /hiq/status

HTTP Request

GET /hiq/status HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

enabled

Boolean

Whether HIQ is enabled or not.

HTTP Response

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

{
  "enabled" : true
}

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/status' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo' \
    -H 'Content-Type: application/json'

Location

Initialize location

POST /locations/:init

Request Fields

Path Type Description

organization

String

The organization name

country

Number

The organization country code

HTTP Request

POST /locations/:init HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Content-Length: 53
Host: api.extremecloudiq.com

{
  "organization" : "Extreme Org",
  "country" : 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
RateLimit: "default";r=7232
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 674

{
  "id" : 438086664193,
  "create_time" : "2026-07-06T17:28:08.000+0000",
  "update_time" : "2026-07-06T17:28:08.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" : "2026-07-06T17:28:08.000+0000",
    "update_time" : "2026-07-06T17:28:08.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -H 'Content-Type: application/json' \
    -d '{
  "organization" : "Extreme Org",
  "country" : 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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Content-Length: 44
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7212
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 677

{
  "id" : 438086664193,
  "create_time" : "2026-07-06T17:28:08.000+0000",
  "update_time" : "2026-07-06T17:28:08.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" : "2026-07-06T17:28:08.000+0000",
    "update_time" : "2026-07-06T17:28:08.000+0000",
    "org_id" : 0,
    "parent_id" : 438086674192,
    "name" : "test-loc-1",
    "unique_name" : "test-loc1",
    "type" : "loc",
    "address" : "addressLine1, addressLine2, city, state, postalCode",
    "children" : [ ]
  } ]
}

cURL Request

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

Update location

PUT /locations/{id}

Path Parameters

Table 10. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10
Content-Type: application/json
Content-Length: 57
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7239
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 677

{
  "id" : 438086664193,
  "create_time" : "2026-07-06T17:28:07.000+0000",
  "update_time" : "2026-07-06T17:28:07.000+0000",
  "org_id" : 0,
  "parent_id" : 1,
  "name" : "test-loc",
  "unique_name" : "test-loc",
  "type" : "loc",
  "address" : "addressLine1, addressLine2, city, state, postalCode",
  "children" : [ {
    "id" : 438086665192,
    "create_time" : "2026-07-06T17:28:07.000+0000",
    "update_time" : "2026-07-06T17:28:07.000+0000",
    "org_id" : 0,
    "parent_id" : 438086674192,
    "name" : "test-loc-1",
    "unique_name" : "test-loc1",
    "type" : "loc",
    "address" : "addressLine1, addressLine2, city, state, postalCode",
    "children" : [ ]
  } ]
}

cURL Request

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

Delete location

DELETE /locations/{id}

Path Parameters

Table 11. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

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

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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Content-Length: 287
Host: api.extremecloudiq.com

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

Response Fields

Path Type Description

id

Number

The building ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The building name

parent_id

Number

The parent location ID

address.address

String

The building address line1

address.address2

String

The building address line2

address.city

String

The building address city

address.state

String

The building address state

address.postal_code

String

The building address postal/zip code

latitude

Number

The latitude coordinate for the building

longitude

Number

The longitude coordinate for the building

HTTP Response

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

{
  "id" : 438086664193,
  "create_time" : "2026-07-06T17:28:08.000+0000",
  "update_time" : "2026-07-06T17:28:08.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -H 'Content-Type: application/json' \
    -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 12. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10
Content-Type: application/json
Content-Length: 287
Host: api.extremecloudiq.com

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

Response Fields

Path Type Description

id

Number

The building ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The building name

parent_id

Number

The parent location ID

address.address

String

The building address line1

address.address2

String

The building address line2

address.city

String

The building address city

address.state

String

The building address state

address.postal_code

String

The building address postal/zip code

latitude

Number

The latitude coordinate for the building

longitude

Number

The longitude coordinate for the building

HTTP Response

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

{
  "id" : 438086664193,
  "create_time" : "2026-07-06T17:28:07.000+0000",
  "update_time" : "2026-07-06T17:28:07.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10' \
    -H 'Content-Type: application/json' \
    -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 13. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

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

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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7216
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 548

{
  "page" : 1,
  "count" : 0,
  "total_pages" : 0,
  "total_count" : 0,
  "data" : [ {
    "id" : 438086664193,
    "create_time" : "2026-07-06T17:28:08.000+0000",
    "update_time" : "2026-07-06T17:28:08.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -H 'Content-Type: application/json'

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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Content-Length: 310
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7218
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 516

{
  "id" : 438086664193,
  "create_time" : "2026-07-06T17:28:08.000+0000",
  "update_time" : "2026-07-06T17:28:08.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -H 'Content-Type: application/json' \
    -d '{
  "parent_id" : 438086664292,
  "name" : "test-building",
  "address" : {
    "address" : "addressLine1",
    "address2" : "addressLine2",
    "city" : "city",
    "state" : "state",
    "postal_code" : "postalCode"
  },
  "country_code" : 62,
  "latitude" : 37.23846552983368,
  "longitude" : -121.7852542
}'

Update site

PUT /locations/site/{id}

Path Parameters

Table 14. /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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10
Content-Type: application/json
Content-Length: 310
Host: api.extremecloudiq.com

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

Response Fields

Path Type Description

id

Number

The site ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The site name

unique_name

String

The site unique name

parent_id

Number

The site parent ID

type

String

The location type

address.address

String

The site address line1

address.address2

String

The site address line2

address.city

String

The site address city

address.state

String

The site address state

address.postal_code

String

The site address postal/zip code

country_code

Number

The country code for the site

created_by

Number

The user ID used to create the site

latitude

Number

The latitude coordinate for the site

longitude

Number

The longitude coordinate for the site

HTTP Response

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

{
  "id" : 438086664193,
  "create_time" : "2026-07-06T17:28:07.000+0000",
  "update_time" : "2026-07-06T17:28:07.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10' \
    -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 15. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

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

Get site

Get /locations/site/{id}

Path parameters

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

id

The site ID

HTTP Request

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

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
RateLimit: "default";r=7229
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 516

{
  "id" : 438086664193,
  "create_time" : "2026-07-06T17:28:08.000+0000",
  "update_time" : "2026-07-06T17:28:08.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

page

Number

The current page number

count

Number

The element count of the current page

total_pages

Number

The total page number based on request page size

total_count

Number

The total element count

data[].id

Number

The site ID

data[].create_time

String

The create time

data[].update_time

String

The last update time

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature

data[].name

String

The site name

data[].unique_name

String

The site unique name

data[].parent_id

Number

The site parent ID

data[].type

String

The location type

data[].address.address

String

The site address line1

data[].address.address2

String

The site address line2

data[].address.city

String

The site address city

data[].address.state

String

The site address state

data[].address.postal_code

String

The site address postal/zip code

data[].country_code

Number

The country code for the site

data[].created_by

Number

The user ID used to create the site

data[].latitude

Number

The latitude coordinate for the site

data[].longitude

Number

The longitude coordinate for the site

HTTP Response

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

{
  "page" : 1,
  "count" : 0,
  "total_pages" : 0,
  "total_count" : 0,
  "data" : [ {
    "id" : 438086664193,
    "create_time" : "2026-07-06T17:28:07.000+0000",
    "update_time" : "2026-07-06T17:28:07.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10
Content-Type: application/json
Content-Length: 260
Host: api.extremecloudiq.com

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

Response Fields

Path Type Description

id

Number

The floor ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The floor name

unique_name

String

The unique name of floor

parent_id

Number

The parent building ID

environment

String

The RF environment of floor

db_attenuation

Number

The floor attenuation of floor

measurement_unit

String

The measurement unit of floor

installation_height

Number

The installation height of floor

map_size_width

Number

The floor map width

map_size_height

Number

The floor map height

map_name

String

The floor map name

HTTP Response

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

{
  "id" : 438086664193,
  "create_time" : "2026-07-06T17:28:07.000+0000",
  "update_time" : "2026-07-06T17:28:07.000+0000",
  "org_id" : 0,
  "parent_id" : 438086664292,
  "name" : "test-floor",
  "unique_name" : "test-floor",
  "environment" : "OFFICE",
  "db_attenuation" : 1.0,
  "measurement_unit" : "METERS",
  "installation_height" : 2.2,
  "map_size_width" : 1000.0,
  "map_size_height" : 980.0,
  "map_name" : "test-map"
}

cURL Request

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

Update floor

PUT /locations/floor/{id}

Path Parameters

Table 17. /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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Content-Length: 260
Host: api.extremecloudiq.com

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

Response Fields

Path Type Description

id

Number

The floor ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The floor name

unique_name

String

The unique name of floor

parent_id

Number

The parent building ID

environment

String

The RF environment of floor

db_attenuation

Number

The floor attenuation of floor

measurement_unit

String

The measurement unit of floor

installation_height

Number

The installation height of floor

map_size_width

Number

The floor map width

map_size_height

Number

The floor map height

map_name

String

The floor map name

HTTP Response

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

{
  "id" : 438086664193,
  "create_time" : "2026-07-06T17:28:08.000+0000",
  "update_time" : "2026-07-06T17:28:08.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -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 18. /locations/floor/{id}
Parameter Description

id

The floor ID

HTTP Request

DELETE /locations/floor/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/floor/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7242
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 551

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

cURL Request

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

Upload floor plan

POST /locations/floorplan

HTTP Request

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

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

data
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

HTTP Response

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

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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10' \
    -F 'file=@image.png;type=images/png'

Start Ekahau import

POST /locations/import/ekahau

HTTP Request

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

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

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

[{"floorName":"1st floor","parentBuildingId":1}]
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=outdoorSiteAssociations

[{"floorName":"2nd floor","parentSiteGroupId":2,"countryCode":124}]
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=importCustomApConfigurations

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

data
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

Request Parameters

Parameter Description

async

Whether running this request as async or not.

floorAssociations

Describes how Ekahau floors are imported into XIQ as floors in buildings.

outdoorSiteAssociations

Describes how Ekahau floors are Imported into XIQ as outdoor sites in site groups.

importCustomApConfigurations

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

Request Parts

Part Description

file

The Ekahau archive to import floors from.

HTTP Response

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

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

Response Fields

Path Type Description

results[].name

String

Name of the imported floor.

results[].status

String

Resulting status of the floor import.

results[].issues.floor.error_code

String

Error code identifying this issue.

results[].issues.floor.error_message

String

Error message describing this issue.

results[].issues.floor.error_parameters.*

String

Parameter name → Parameter value.

results[].issues.background.error_code

String

Error code identifying this issue.

results[].issues.background.error_message

String

Error message describing this issue.

results[].issues.background.error_parameters.*

String

Parameter name → Parameter value.

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

String

Error code identifying this issue.

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

String

Error message describing this issue.

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

String

Parameter name → Parameter value.

results[].issues.discarded_aps.*.error_code

String

Error code identifying this issue.

results[].issues.discarded_aps.*.error_message

String

Error message describing this issue.

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

String

Parameter name → Parameter value.

results[].issues.discarded_walls.*.error_code

String

Error code identifying this issue.

results[].issues.discarded_walls.*.error_message

String

Error message describing this issue.

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

String

Parameter name → Parameter value.

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/import/ekahau' -i -X POST \
    -H 'Content-Type: multipart/form-data' \
    -H 'Content-Type: multipart/form-data' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -F 'file=@ekahau.esx;type=application/octet-stream' \
    -F 'async=false' \
    -F 'floorAssociations=[{"floorName":"1st floor","parentBuildingId":1}]' \
    -F 'outdoorSiteAssociations=[{"floorName":"2nd floor","parentSiteGroupId":2,"countryCode":124}]' \
    -F 'importCustomApConfigurations=true'

Start Ekahau import

POST /locations/import/ekahau

HTTP Request

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

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

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

[{"floorName":"1st floor","parentBuildingId":1}]
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=outdoorSiteAssociations

[{"floorName":"2nd floor","parentSiteGroupId":2,"countryCode":124}]
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=importCustomApConfigurations

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

data
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

Request Parameters

Parameter Description

async

Whether running this request as async or not.

floorAssociations

Describes how Ekahau floors are imported into XIQ as floors in buildings.

outdoorSiteAssociations

Describes how Ekahau floors are Imported into XIQ as outdoor sites in site groups.

importCustomApConfigurations

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

Request Parts

Part Description

file

The Ekahau archive to import floors from.

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/import/ekahau' -i -X POST \
    -H 'Content-Type: multipart/form-data' \
    -H 'Content-Type: multipart/form-data' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -F 'file=@ekahau.esx;type=application/octet-stream' \
    -F 'async=true' \
    -F 'floorAssociations=[{"floorName":"1st floor","parentBuildingId":1}]' \
    -F 'outdoorSiteAssociations=[{"floorName":"2nd floor","parentSiteGroupId":2,"countryCode":124}]' \
    -F 'importCustomApConfigurations=true'

Get location tree

GET /locations/tree

Request Parameters

Parameter Description

parentId

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

expandChildren

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

HTTP Request

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

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
RateLimit: "default";r=7224
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 1045

[ {
  "id" : 438086664193,
  "create_time" : "2026-07-06T17:28:08.000+0000",
  "update_time" : "2026-07-06T17:28:08.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" : "2026-07-06T17:28:08.000+0000",
    "update_time" : "2026-07-06T17:28:08.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" : "2026-07-06T17:28:08.000+0000",
    "update_time" : "2026-07-06T17:28:08.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -H 'Content-Type: application/json'

List wall types

GET /wall/type

HTTP Request

GET /locations/wall/type HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

[].id

Number

The Wall type id

[].name

String

The Wall type name.

[].attenuation

Number

The Wall type attenuation

[].color

String

The Wall type color

[].owner_id

Number

The Owner ID

[].org_id

Number

The Org ID

[].predefined

Boolean

Is the Wall type is predefined

HTTP Response

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

[ {
  "id" : 4294967402408,
  "name" : "Brick Wall",
  "attenuation" : 10.0,
  "color" : "#E1390B",
  "owner_id" : 0,
  "org_id" : 0,
  "predefined" : true
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/wall/type' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -H 'Content-Type: application/json'

Create wall type

POST /locations/wall/type

Request Fields

Path Type Description

name

String

The Wall type name

attenuation

Number

The Wall type attenuation

color

String

The Wall type color

HTTP Request

POST /locations/wall/type HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Content-Length: 81
Host: api.extremecloudiq.com

{
  "name" : "Brick Wall-create",
  "attenuation" : 20.0,
  "color" : "#A10000"
}

Response Fields

Path Type Description

id

Number

The Wall type id

name

String

The Wall type name.

attenuation

Number

The Wall type attenuation

color

String

The Wall type color

owner_id

Number

The Owner ID

org_id

Number

The Org ID

predefined

Boolean

Is the Wall type is predefined

HTTP Response

HTTP/1.1 201 Created
RateLimit: "default";r=7222
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 155

{
  "id" : 4294967402408,
  "name" : "Brick Wall",
  "attenuation" : 10.0,
  "color" : "#E1390B",
  "owner_id" : 0,
  "org_id" : 0,
  "predefined" : true
}

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/wall/type' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Brick Wall-create",
  "attenuation" : 20.0,
  "color" : "#A10000"
}'

Update wall type

PUT /locations/wall/type/{id}

Path Parameters

Table 19. /locations/wall/type/{id}
Parameter Description

id

The Wall Type ID

Request Fields

Path Type Description

name

String

The Wall type name

attenuation

Number

The Wall type attenuation

color

String

The Wall type color

HTTP Request

PUT /locations/wall/type/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10
Content-Type: application/json
Content-Length: 81
Host: api.extremecloudiq.com

{
  "name" : "Brick Wall-update",
  "attenuation" : 25.0,
  "color" : "#A10000"
}

Response Fields

Path Type Description

id

Number

The Wall type id

name

String

The Wall type name.

attenuation

Number

The Wall type attenuation

color

String

The Wall type color

owner_id

Number

The Owner ID

org_id

Number

The Org ID

predefined

Boolean

Is the Wall type is predefined

HTTP Response

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

{
  "id" : 4294967402408,
  "name" : "Brick Wall",
  "attenuation" : 10.0,
  "color" : "#E1390B",
  "owner_id" : 0,
  "org_id" : 0,
  "predefined" : true
}

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/wall/type/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Brick Wall-update",
  "attenuation" : 25.0,
  "color" : "#A10000"
}'

Delete wall type

DELETE /locations/wall/type/{id}

Path Parameters

Table 20. /locations/wall/type/{id}
Parameter Description

id

The Wall Type ID

HTTP Request

DELETE /locations/wall/type/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

HTTP/1.1 204 No Content
RateLimit: "default";r=7238
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/wall/type/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10' \
    -H 'Content-Type: application/json'

Find Wall Type Reference

GET /wall/type/references/{id}

Path Parameters

Table 21. /locations/wall/type/references/{id}
Parameter Description

id

The Wall Type ID

HTTP Request

GET /locations/wall/type/references/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

[].folder_id

Number

The folder ID

[].path

String

The path

HTTP Response

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

[ {
  "folder_id" : 1000,
  "path" : "Toronto/Engineering HQ/2020-2-19 NHSCMC- Level 3"
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/wall/type/references/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -H 'Content-Type: application/json'

Get floor map labels

GET /floor/{floorId}/label

HTTP Request

GET /locations/floor/438086664193/label HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Accept: application/json
Host: api.extremecloudiq.com

HTTP Request Headers

Name Description

Accept

The Content-Type of the response, e.g. application/json

Authorization

API auth credentials

HTTP Path Parameters

Table 22. /locations/floor/{floorId}/label
Parameter Description

floorId

The Floor ID

HTTP Response

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

[ {
  "id" : 1,
  "floor_id" : 4000,
  "x" : 100.0,
  "y" : 60.0,
  "text" : "this is label 1",
  "visible" : true
}, {
  "id" : 2,
  "floor_id" : 4000,
  "x" : 600.0,
  "y" : 70.0,
  "text" : "this is label 2",
  "visible" : true
} ]

HTTP Response Body

[ {
  "id" : 1,
  "floor_id" : 4000,
  "x" : 100.0,
  "y" : 60.0,
  "text" : "this is label 1",
  "visible" : true
}, {
  "id" : 2,
  "floor_id" : 4000,
  "x" : 600.0,
  "y" : 70.0,
  "text" : "this is label 2",
  "visible" : true
} ]

HTTP Response Fields

Path Type Description

[].id

Number

The ID of the floor map label

[].floor_id

Number

The ID of the floor referenced by the floor map label

[].x

Number

The x coordinate of the floor map label

[].y

Number

The y coordinate of the floor map label

[].text

String

The text of the floor map label

[].visible

Boolean

Whether the floor map label is visible

cURL request

$ curl 'https://api.extremecloudiq.com/locations/floor/438086664193/label' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json'

HTTPie Request

$ http GET 'https://api.extremecloudiq.com/locations/floor/438086664193/label' \
    'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    'Content-Type:application/json' \
    'Accept:application/json'

Create floor map label

POST /floor/{floorId}/label

HTTP Request

POST /locations/floor/438086664193/label HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Accept: application/json
Content-Length: 115
Host: api.extremecloudiq.com

{
  "id" : 3,
  "floor_id" : 4000,
  "x" : 300.0,
  "y" : 100.0,
  "text" : "this is label 3",
  "visible" : true
}

HTTP Request Headers

Name Description

Content-Type

The Content-Type of the request body, e.g. application/json

Accept

The Content-Type of the response body, e.g. application/json

Authorization

API auth credentials

HTTP Path Parameters

Table 23. /locations/floor/{floorId}/label
Parameter Description

floorId

The Floor ID

HTTP Request Body

{
  "id" : 3,
  "floor_id" : 4000,
  "x" : 300.0,
  "y" : 100.0,
  "text" : "this is label 3",
  "visible" : true
}

HTTP Response

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

{
  "id" : 3,
  "floor_id" : 4000,
  "x" : 300.0,
  "y" : 100.0,
  "text" : "this is label 3",
  "visible" : true
}

HTTP Response Body

{
  "id" : 3,
  "floor_id" : 4000,
  "x" : 300.0,
  "y" : 100.0,
  "text" : "this is label 3",
  "visible" : true
}

HTTP Response Fields

Path Type Description

id

Number

The ID of the floor map label

floor_id

Number

The ID of the floor map label

x

Number

The x coordinate of the floor map label

y

Number

The y coordinate of the floor map label

text

String

The text of the floor map label

visible

Boolean

Whether the floor map label is visible

cURL request

$ curl 'https://api.extremecloudiq.com/locations/floor/438086664193/label' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -d '{
  "id" : 3,
  "floor_id" : 4000,
  "x" : 300.0,
  "y" : 100.0,
  "text" : "this is label 3",
  "visible" : true
}'

HTTPie Request

$ echo '{
  "id" : 3,
  "floor_id" : 4000,
  "x" : 300.0,
  "y" : 100.0,
  "text" : "this is label 3",
  "visible" : true
}' | http POST 'https://api.extremecloudiq.com/locations/floor/438086664193/label' \
    'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    'Content-Type:application/json' \
    'Accept:application/json'

Update floor map label

PUT /floor/{floorId}/label

HTTP Request

PUT /locations/floor/438086664193/label HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Accept: application/json
Content-Length: 115
Host: api.extremecloudiq.com

{
  "id" : 3,
  "floor_id" : 4000,
  "x" : 400.0,
  "y" : 200.0,
  "text" : "this is label 4",
  "visible" : true
}

HTTP Request Headers

Name Description

Accept

The Content-Type of the response body, e.g. application/json

Content-Type

The Content-Type of the request body, e.g. application/json

Authorization

API auth credentials

HTTP Path Parameters

Table 24. /locations/floor/{floorId}/label
Parameter Description

floorId

The Floor ID

HTTP Request Body

{
  "id" : 3,
  "floor_id" : 4000,
  "x" : 400.0,
  "y" : 200.0,
  "text" : "this is label 4",
  "visible" : true
}

HTTP Response

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

{
  "id" : 3,
  "floor_id" : 4000,
  "x" : 400.0,
  "y" : 200.0,
  "text" : "this is label 4",
  "visible" : true
}

HTTP Response Body

{
  "id" : 3,
  "floor_id" : 4000,
  "x" : 400.0,
  "y" : 200.0,
  "text" : "this is label 4",
  "visible" : true
}

HTTP Response Fields

Path Type Description

id

Number

The ID of the floor map label

floor_id

Number

The ID of the floor

x

Number

The x coordinate of the floor map label

y

Number

The y coordinate of the floor map label

text

String

The text of the floor map label

visible

Boolean

Whether the floor map label is visible

cURL request

$ curl 'https://api.extremecloudiq.com/locations/floor/438086664193/label' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -d '{
  "id" : 3,
  "floor_id" : 4000,
  "x" : 400.0,
  "y" : 200.0,
  "text" : "this is label 4",
  "visible" : true
}'

HTTPie Request

$ echo '{
  "id" : 3,
  "floor_id" : 4000,
  "x" : 400.0,
  "y" : 200.0,
  "text" : "this is label 4",
  "visible" : true
}' | http PUT 'https://api.extremecloudiq.com/locations/floor/438086664193/label' \
    'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    'Content-Type:application/json' \
    'Accept:application/json'

Bulk update floor map labels

PUT /floor/bulk/label

HTTP Request

PUT /locations/floor/bulk/label HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10
Content-Type: application/json
Accept: application/json
Content-Length: 236
Host: api.extremecloudiq.com

[ {
  "id" : 3,
  "floor_id" : 4000,
  "x" : 300.0,
  "y" : 100.0,
  "text" : "this is label 3",
  "visible" : true
}, {
  "id" : 4,
  "floor_id" : 4000,
  "x" : 301.0,
  "y" : 101.0,
  "text" : "this is label 4",
  "visible" : true
} ]

HTTP Request Headers

Name Description

Accept

The Content-Type of the response body, e.g. application/json

Content-Type

The Content-Type of the request body, e.g. application/json

Authorization

API auth credentials

HTTP Request Body

[ {
  "id" : 3,
  "floor_id" : 4000,
  "x" : 300.0,
  "y" : 100.0,
  "text" : "this is label 3",
  "visible" : true
}, {
  "id" : 4,
  "floor_id" : 4000,
  "x" : 301.0,
  "y" : 101.0,
  "text" : "this is label 4",
  "visible" : true
} ]

HTTP Request Fields

Path Type Description

[].id

Number

The ID of the floor map label

[].floor_id

Number

The ID of the floor

[].x

Number

The x coordinate of the floor map label

[].y

Number

The y coordinate of the floor map label

[].text

String

The text of the floor map label

[].visible

Boolean

Whether the floor map label is visible

HTTP Response

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

[ {
  "id" : 3,
  "floor_id" : 4000,
  "x" : 300.0,
  "y" : 100.0,
  "text" : "this is label 3",
  "visible" : true
}, {
  "id" : 4,
  "floor_id" : 4000,
  "x" : 301.0,
  "y" : 101.0,
  "text" : "this is label 4",
  "visible" : true
} ]

HTTP Response Body

[ {
  "id" : 3,
  "floor_id" : 4000,
  "x" : 300.0,
  "y" : 100.0,
  "text" : "this is label 3",
  "visible" : true
}, {
  "id" : 4,
  "floor_id" : 4000,
  "x" : 301.0,
  "y" : 101.0,
  "text" : "this is label 4",
  "visible" : true
} ]

HTTP Response Fields

Path Type Description

[].id

Number

The ID of the floor map label

[].floor_id

Number

The ID of the floor

[].x

Number

The x coordinate of the floor map label

[].y

Number

The y coordinate of the floor map label

[].text

String

The text of the floor map label

[].visible

Boolean

Whether the floor map label is visible

cURL request

$ curl 'https://api.extremecloudiq.com/locations/floor/bulk/label' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10' \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -d '[ {
  "id" : 3,
  "floor_id" : 4000,
  "x" : 300.0,
  "y" : 100.0,
  "text" : "this is label 3",
  "visible" : true
}, {
  "id" : 4,
  "floor_id" : 4000,
  "x" : 301.0,
  "y" : 101.0,
  "text" : "this is label 4",
  "visible" : true
} ]'

HTTPie Request

$ echo '[ {
  "id" : 3,
  "floor_id" : 4000,
  "x" : 300.0,
  "y" : 100.0,
  "text" : "this is label 3",
  "visible" : true
}, {
  "id" : 4,
  "floor_id" : 4000,
  "x" : 301.0,
  "y" : 101.0,
  "text" : "this is label 4",
  "visible" : true
} ]' | http PUT 'https://api.extremecloudiq.com/locations/floor/bulk/label' \
    'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10' \
    'Content-Type:application/json' \
    'Accept:application/json'

Delete floor map label

DELETE /floor/{floorId}/label

HTTP Request

DELETE /locations/floor/438086664193/label/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Request Headers

Name Description

Authorization

API auth credentials

HTTP Path Parameters

Table 25. /locations/floor/{floorId}/label/{labelId}
Parameter Description

floorId

The Floor ID

labelId

The Floor Map Label ID

HTTP Response

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

HTTP Response Body

cURL request

$ curl 'https://api.extremecloudiq.com/locations/floor/438086664193/label/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10' \
    -H 'Content-Type: application/json'

HTTPie Request

$ http DELETE 'https://api.extremecloudiq.com/locations/floor/438086664193/label/438086664193' \
    'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10' \
    'Content-Type:application/json'

Get zones in folder

GET /locations/folder/{folderId}/zones

Path Parameters

Table 26. /locations/folder/{folderId}/zones
Parameter Description

folderId

The Folder ID

Response Fields

Path Type Description

[].id

Number

The Zone ID

[].name

String

The Zone name

[].color

String

The Zone color

[].folder_id

Number

The Folder ID

[].zone_vertical_align

String

The Zone vertical alignment

[].visible

Boolean

The visibility of the zone

[].coordinates[].x

Number

The X coordinate of the zone point

[].coordinates[].y

Number

The Y coordinate of the zone point

[].owner_id

Number

The Owner ID

[].org_id

Number

The Org ID

HTTP Response

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

[ {
  "id" : 123456789,
  "name" : "Zone 1",
  "color" : "#FF5733",
  "folder_id" : 987654321,
  "zone_vertical_align" : "TOP",
  "visible" : true,
  "coordinates" : [ {
    "x" : 0.0,
    "y" : 0.0
  }, {
    "x" : 10.0,
    "y" : 0.0
  }, {
    "x" : 10.0,
    "y" : 10.0
  }, {
    "x" : 0.0,
    "y" : 0.0
  } ],
  "owner_id" : 111222333,
  "org_id" : 444555666
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/folder/438086664193/zones' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -H 'Content-Type: application/json'

Create zone

POST /locations/folder/zones

Request Fields

Path Type Description

name

String

The Zone name

color

String

The Zone color

folder_id

Number

The Folder ID

visible

Boolean

The visibility of the zone

zone_vertical_align

String

The Zone vertical alignment

coordinates[].x

Number

The X coordinate of the zone point

coordinates[].y

Number

The Y coordinate of the zone point

HTTP Request

POST /locations/folder/zones HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10
Content-Type: application/json
Content-Length: 295
Host: api.extremecloudiq.com

{
  "name" : "Zone 1",
  "color" : "#FF5733",
  "folder_id" : 987654321,
  "visible" : true,
  "zone_vertical_align" : "TOP",
  "coordinates" : [ {
    "x" : 0.0,
    "y" : 0.0
  }, {
    "x" : 10.0,
    "y" : 0.0
  }, {
    "x" : 10.0,
    "y" : 10.0
  }, {
    "x" : 0.0,
    "y" : 0.0
  } ]
}

Response Fields

Path Type Description

id

Number

The Zone id

name

String

The Zone name.

color

String

The Zone color

folder_id

Number

The Folder ID

zone_vertical_align

String

The Zone vertical alignment

visible

Boolean

The visibility of the zone

coordinates[].x

Number

The X coordinate of the zone point

coordinates[].y

Number

The Y coordinate of the zone point

owner_id

Number

The Owner ID

org_id

Number

The Org ID

HTTP Response

HTTP/1.1 201 Created
RateLimit: "default";r=7241
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 365

{
  "id" : 123456789,
  "name" : "Zone 1",
  "color" : "#FF5733",
  "folder_id" : 987654321,
  "zone_vertical_align" : "TOP",
  "visible" : true,
  "coordinates" : [ {
    "x" : 0.0,
    "y" : 0.0
  }, {
    "x" : 10.0,
    "y" : 0.0
  }, {
    "x" : 10.0,
    "y" : 10.0
  }, {
    "x" : 0.0,
    "y" : 0.0
  } ],
  "owner_id" : 111222333,
  "org_id" : 444555666
}

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/folder/zones' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Zone 1",
  "color" : "#FF5733",
  "folder_id" : 987654321,
  "visible" : true,
  "zone_vertical_align" : "TOP",
  "coordinates" : [ {
    "x" : 0.0,
    "y" : 0.0
  }, {
    "x" : 10.0,
    "y" : 0.0
  }, {
    "x" : 10.0,
    "y" : 10.0
  }, {
    "x" : 0.0,
    "y" : 0.0
  } ]
}'

Update zones

PUT /locations/folder/zones

Request Fields

Path Type Description

folder_id

Number

The Folder ID

zones[].id

Number

The Zone ID

zones[].name

String

The Zone name

zones[].color

String

The Zone color

zones[].zone_vertical_align

String

The Zone vertical alignment

zones[].visible

Boolean

The visibility of the zone

zones[].coordinates[].x

Number

The X coordinate of the zone point

zones[].coordinates[].y

Number

The Y coordinate of the zone point

HTTP Request

PUT /locations/folder/zones HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI
Content-Type: application/json
Content-Length: 379
Host: api.extremecloudiq.com

{
  "folder_id" : 123456789,
  "zones" : [ {
    "id" : 12345678910,
    "name" : "Zone 2",
    "color" : "#33FF57",
    "zone_vertical_align" : "BOTTOM",
    "visible" : false,
    "coordinates" : [ {
      "x" : 1.0,
      "y" : 1.0
    }, {
      "x" : 11.0,
      "y" : 1.0
    }, {
      "x" : 11.0,
      "y" : 11.0
    }, {
      "x" : 1.0,
      "y" : 1.0
    } ]
  } ]
}

Response Fields

Path Type Description

[].id

Number

The Zone ID

[].name

String

The Zone name

[].color

String

The Zone color

[].folder_id

Number

The Folder ID

[].zone_vertical_align

String

The Zone vertical alignment

[].visible

Boolean

The visibility of the zone

[].coordinates[].x

Number

The X coordinate of the zone point

[].coordinates[].y

Number

The Y coordinate of the zone point

[].owner_id

Number

The Owner ID

[].org_id

Number

The Org ID

HTTP Response

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

[ {
  "id" : 123456789,
  "name" : "Zone 1",
  "color" : "#FF5733",
  "folder_id" : 987654321,
  "zone_vertical_align" : "TOP",
  "visible" : true,
  "coordinates" : [ {
    "x" : 0.0,
    "y" : 0.0
  }, {
    "x" : 10.0,
    "y" : 0.0
  }, {
    "x" : 10.0,
    "y" : 10.0
  }, {
    "x" : 0.0,
    "y" : 0.0
  } ],
  "owner_id" : 111222333,
  "org_id" : 444555666
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/folder/zones' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg4LCJleHAiOjE3ODM5NjM2ODh9.biXZCb4otBFNSykvQYtemuqgZ8EFYpcOZNssBvO25AI' \
    -H 'Content-Type: application/json' \
    -d '{
  "folder_id" : 123456789,
  "zones" : [ {
    "id" : 12345678910,
    "name" : "Zone 2",
    "color" : "#33FF57",
    "zone_vertical_align" : "BOTTOM",
    "visible" : false,
    "coordinates" : [ {
      "x" : 1.0,
      "y" : 1.0
    }, {
      "x" : 11.0,
      "y" : 1.0
    }, {
      "x" : 11.0,
      "y" : 11.0
    }, {
      "x" : 1.0,
      "y" : 1.0
    } ]
  } ]
}'

Delete zone

DELETE /locations/folder/zone/{id}

Path Parameters

Table 27. /locations/folder/zone/{id}
Parameter Description

id

The Zone ID

HTTP Request

DELETE /locations/folder/zone/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

HTTP/1.1 204 No Content
RateLimit: "default";r=7245
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/folder/zone/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg3LCJleHAiOjE3ODM5NjM2ODd9.RmLEhnr2_DmJuT3n4CZH-yocOYOrHkpJUV73mN2VA10' \
    -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, subscription_license

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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc
Content-Type: application/json
Host: api.extremecloudiq.com

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

data[].mgt_vlan

Number

The Management Vlan

data[].images_names[]

Array

Images Names list assigned to this device

data[].visible

Boolean

The visible status of a device in a floor.

data[].subscription_license

String

The subscription license of the device.

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "create_time" : "2026-07-06T17:28:03.000+0000",
    "update_time" : "2026-07-06T17:28:03.000+0000",
    "org_id" : 10,
    "serial_number" : "35396272925062",
    "service_tag" : "",
    "mac_address" : "E6GvnPUeGMKB",
    "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" : "2026-07-06T17:28:03.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" : "",
    "mgt_vlan" : 0,
    "images_names" : [ ],
    "visible" : false,
    "subscription_license" : "Standard Tier A"
  }, {
    "id" : 2,
    "create_time" : "2026-07-06T17:28:03.000+0000",
    "update_time" : "2026-07-06T17:28:03.000+0000",
    "org_id" : 10,
    "serial_number" : "17302321366115",
    "service_tag" : "",
    "mac_address" : "ZjnSsmB6b1Pr",
    "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" : "2026-07-06T17:28:03.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" : "",
    "mgt_vlan" : 0,
    "images_names" : [ ],
    "visible" : false,
    "subscription_license" : "PILOT"
  } ]
}

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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7308
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA' \
    -H 'Content-Type: application/json'

Get device iBeacon

GET /devices/{id}/ibeacon

Path Parameters

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

id

Device ID

HTTP Request

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

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_ble_scan_ibeacon

Boolean

Whether to enable BLE Scan iBeacon monitoring.

enable_ble_scan_generic

Boolean

Whether to enable BLE Scan Generic monitoring.

enable_cloud_reporting

Boolean

Whether to enable cloud reporting

enable_batch_reporting

Boolean

Whether to enable batch reporting

HTTP Response

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

{
  "device_id" : 438086664193,
  "enabled" : true,
  "major" : 1,
  "minor" : 1,
  "power" : -59,
  "enable_ble_scan_ibeacon" : true,
  "enable_ble_scan_generic" : true,
  "enable_cloud_reporting" : true,
  "enable_batch_reporting" : true
}

cURL Request

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

Update device-level iBeacon settings

PUT /devices/ibeacon

HTTP Request

PUT /devices/ibeacon HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg0LCJleHAiOjE3ODM5NjM2ODR9.ibH-apqy8AXRBXaO7KiHhiRqkZLJTWKX1zwZXaPzebQ
Content-Type: application/json
Content-Length: 246
Host: api.extremecloudiq.com

{
  "device_ids" : [ 438086664193 ],
  "enabled" : true,
  "major" : 1,
  "minor" : 1,
  "power" : -59,
  "enable_ble_scan_ibeacon" : true,
  "enable_ble_scan_generic" : true,
  "enable_cloud_reporting" : true,
  "enable_batch_reporting" : 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_ble_scan_ibeacon

Boolean

Whether to enable BLE Scan iBeacon monitoring.

enable_ble_scan_generic

Boolean

Whether to enable BLE Scan Generic monitoring.

enable_cloud_reporting

Boolean

Whether to enable cloud reporting

enable_batch_reporting

Boolean

Whether to enable batch reporting

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/ibeacon' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg0LCJleHAiOjE3ODM5NjM2ODR9.ibH-apqy8AXRBXaO7KiHhiRqkZLJTWKX1zwZXaPzebQ' \
    -H 'Content-Type: application/json' \
    -d '{
  "device_ids" : [ 438086664193 ],
  "enabled" : true,
  "major" : 1,
  "minor" : 1,
  "power" : -59,
  "enable_ble_scan_ibeacon" : true,
  "enable_ble_scan_generic" : true,
  "enable_cloud_reporting" : true,
  "enable_batch_reporting" : true
}'

Get Single Thread Gateway IoT profile

GET /devices/{id}/iot

Path Parameters

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

id

Device ID

HTTP Request

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

Response Fields

Path Type Description

enabled

Boolean

Whether IoT Interface Settings is enabled on AP device.

iot_profile.id

Number

The iot profile ID.

iot_profile.name

String

The iot profile name.

iot_profile.create_time

String

The create time of the iot profile.

iot_profile.update_time

String

The update time of the iot profile.

iot_profile.app_id

String

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

iot_profile.app_supported

String

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

iot_profile.thread_gateway

Object

When app_id = THREAD_GATEWAY provides definition of thread gateway.

iot_profile.thread_gateway.short_pan_id

String

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

iot_profile.thread_gateway.ext_pan_id

String

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

iot_profile.thread_gateway.master_key

String

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

iot_profile.thread_gateway.network_name

String

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

iot_profile.thread_gateway.channel

Number

802.15.4 channel number, 11-26

iot_profile.thread_gateway.comm_credentials

String

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

iot_profile.thread_gateway.comm_timeout

Number

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

iot_profile.thread_gateway.enable_nat64

Boolean

Enable NAT64 functions including the translator and the prefix publishing.

iot_profile.thread_gateway.white_list

Array

The table of approved Thread end-devices.

iot_profile.thread_gateway.white_list[].long_eui

String

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

iot_profile.thread_gateway.white_list[].pskd

String

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

iot_profile.thread_gateway.default_user_profile_id

Number

The default user-profile ID.

iot_profile.thread_gateway.enable_dns_search_domain

Boolean

Enable adding DNS search domain to unqualified host lookups forwarded by upstream DNS (in the thread border router).

HTTP Response

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

{
  "enabled" : true,
  "iot_profile" : {
    "id" : 438086664193,
    "create_time" : "2026-07-06T17:28:02.000+0000",
    "update_time" : "2026-07-06T17:28:02.000+0000",
    "name" : "iot-profile-438086664193",
    "app_id" : "THREAD_GATEWAY",
    "thread_gateway" : {
      "short_pan_id" : "62d7",
      "ext_pan_id" : "a2ffab2138f974fa",
      "master_key" : "be8e305ec8bd197dcaa2245393fa9ee3",
      "network_name" : "thread-network-438086664193",
      "channel" : 15,
      "comm_credentials" : "540c257823975a41b15d0b1d17b9f7f",
      "comm_timeout" : 120,
      "enable_nat64" : true,
      "enable_dns_search_domain" : false,
      "white_list" : [ {
        "long_eui" : "6cd55fd32138b2c4",
        "pskd" : "69AXRYKSAWPBC"
      }, {
        "long_eui" : "dbb56600a4230093",
        "pskd" : "M0E6JDPK03YHP49AW1RRV67W6U"
      }, {
        "long_eui" : "86111a45efdf57c1",
        "pskd" : "PC742L6X3"
      } ],
      "default_user_profile_id" : 1
    },
    "app_supported" : "SINGLE"
  }
}

cURL Request

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

Get Multi-Application IoT profile

GET /devices/{id}/iot

Path Parameters

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

id

Device ID

HTTP Request

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

Response Fields

Path Type Description

enabled

Boolean

Whether IoT Interface Settings is enabled on AP device.

iot_profile.id

Number

The iot profile ID.

iot_profile.name

String

The iot profile name.

iot_profile.create_time

String

The create time of the iot profile.

iot_profile.update_time

String

The update time of the iot profile.

iot_profile.app_supported

String

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

iot_profile.ble_beacon

Object

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

iot_profile.ble_beacon.applications

Array

The BLE Beacon Applications.

iot_profile.ble_beacon.applications[].app_type

String

The BLE Beacon application type.

iot_profile.ble_beacon.applications[].measured_rss

Number

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

iot_profile.ble_beacon.applications[].advertise_interval

Number

The BLE Beacon application advertise interval value in ms.

iot_profile.ble_beacon.applications[].tx_power

Number

The BLE Beacon transmit power, in dBm.

iot_profile.ble_beacon.applications[].major

Number

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

iot_profile.ble_beacon.applications[].minor

Number

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

iot_profile.ble_beacon.applications[].uuid

String

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

iot_profile.ble_beacon.applications[].url

String

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

iot_profile.ble_scan

Object

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

iot_profile.ble_scan.destination.interval

Number

The BLE Scan XIQ report interval, in seconds.

iot_profile.ble_scan.destination.http_server.interval

Number

The BLE Scan destination HTTP server interval, in seconds.

iot_profile.ble_scan.destination.http_server.url

String

The BLE Scan destination HTTP server URL.

iot_profile.ble_scan.destination.http_server.enable_deduplication

Boolean

Enable to remove BLE scan duplicates entries within the specified time interval.

iot_profile.ble_scan.applications

Array

The BLE Scan Applications.

iot_profile.ble_scan.applications[].app_type

String

The BLE Scan application type.

iot_profile.ble_scan.applications[].min_rss

Number

The BLE Scan application minimum RSS value.

iot_profile.ble_scan.applications[].uuid

String

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

iot_profile.ble_scan.applications[].vendors

Array

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

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

String

The BLE Scan Vendor Type.

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

String

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

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

Number

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

HTTP Response

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

{
  "enabled" : true,
  "iot_profile" : {
    "id" : 438086664193,
    "create_time" : "2026-07-06T17:28:04.000+0000",
    "update_time" : "2026-07-06T17:28:04.000+0000",
    "name" : "iot-profile-438086664193",
    "app_supported" : "MULTI",
    "ble_beacon" : {
      "applications" : [ {
        "measured_rss" : 50,
        "advertise_interval" : 100,
        "tx_power" : 3,
        "major" : 1000,
        "minor" : 500,
        "uuid" : "d1e52db3-4a8d-44f6-8884-cb38b20e952c",
        "app_type" : "IBEACON"
      }, {
        "measured_rss" : 50,
        "advertise_interval" : 100,
        "tx_power" : 3,
        "url" : "http://www.extremenetworks.com",
        "app_type" : "EDDYSTONE_URL"
      } ]
    },
    "ble_scan" : {
      "destination" : {
        "interval" : 100,
        "http_server" : {
          "url" : "http://www.extremenetworks.com",
          "interval" : 100,
          "enable_deduplication" : false
        }
      },
      "applications" : [ {
        "min_rss" : -10,
        "uuid" : "4067357f-416f-4887-a000-07fdaf74a058",
        "app_type" : "IBEACON"
      }, {
        "min_rss" : -10,
        "vendors" : [ ],
        "app_type" : "GENERIC"
      }, {
        "min_rss" : -10,
        "vendors" : [ {
          "vendor_type" : "CUSTOM",
          "vendor_name" : "Company Name",
          "company_id" : 741
        } ],
        "app_type" : "GENERIC"
      } ]
    }
  }
}

cURL Request

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

Enable device IoT

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

Path Parameters

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

id

Device ID

HTTP Request

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

438086664193

HTTP Response

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

cURL Request

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

Disable device IoT

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

Path Parameters

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

id

Device ID

HTTP Request

POST /devices/438086664193/iot/:disable HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg0LCJleHAiOjE3ODM5NjM2ODR9.ibH-apqy8AXRBXaO7KiHhiRqkZLJTWKX1zwZXaPzebQ
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

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

Send CLI

Send CLI to devices.

POST /devices/:cli

Request Fields

Path Type Description

devices.ids

Array

The device ID list.

clis

Array

The CLI list.

HTTP Request

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

{
  "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
RateLimit: "default";r=7246
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 32

{
  "device_cli_outputs" : { }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:cli' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg0LCJleHAiOjE3ODM5NjM2ODR9.ibH-apqy8AXRBXaO7KiHhiRqkZLJTWKX1zwZXaPzebQ' \
    -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
Content-Type: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc
Content-Length: 58
Host: api.extremecloudiq.com

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

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:delete' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA
Content-Type: application/json
Content-Length: 58
Host: api.extremecloudiq.com

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

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:unmanage' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA' \
    -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
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc
Content-Length: 450
Host: api.extremecloudiq.com

{
  "extreme" : {
    "sns" : [ "zzzz-zzz-zzz" ]
  },
  "exos" : {
    "sns" : [ "zzzz-zzz-www" ]
  },
  "voss" : {
    "sns" : [ "zzzz-zzz-www" ]
  },
  "wing" : {
    "sn_to_mac" : {
      "serial_num" : "mac_address"
    }
  },
  "dell" : {
    "sn_to_st" : {
      "serial_num" : "service_tag"
    }
  },
  "dt" : {
    "dts" : [ {
      "make" : "FABRIC_ENGINE",
      "model" : "DT_5320_16P_4XE_DC",
      "os_version" : "8.8.1.0"
    } ]
  }
}

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:onboard' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc' \
    -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
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA
Content-Length: 2216
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7305
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
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 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA' \
    -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
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc
Content-Length: 2216
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7255
Location: http://localhost:8081/operations/operation-id
Retry-After: 2
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:advanced-onboard?async=true' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc
Content-Type: application/json
Content-Length: 58
Host: api.extremecloudiq.com

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

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:reboot' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/json
Content-Length: 58
Host: api.extremecloudiq.com

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

HTTP Response

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

cURL Request

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

Get one device detail

GET /devices/{id}

Path parameters

Table 33. /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, subscription_license

HTTP Request

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

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

mgt_vlan

Number

mgt Vlan

images_names

Array

images names

visible

Boolean

The visible status of a device in a floor.

subscription_license

String

The subscription license of the device.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:02.000+0000",
  "update_time" : "2026-07-06T17:28:02.000+0000",
  "org_id" : 10,
  "serial_number" : "78415678956401",
  "service_tag" : "",
  "mac_address" : "BWg9hVsbG8oP",
  "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" : "2026-07-06T17:28:02.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" : "",
  "mgt_vlan" : 0,
  "images_names" : [ ],
  "visible" : false,
  "subscription_license" : "PILOT"
}

cURL Request

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

Delete device

Delete one device.

DELETE /devices/{id}

Path parameters

Table 34. /devices/{id}
Parameter Description

id

Device ID

HTTP Request

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

HTTP Response

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

cURL Request

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

Send CLI to one device

Send CLI to one device.

POST /devices/{id}/:cli

Path parameters

Table 35. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc
Content-Type: application/json
Content-Length: 35
Host: api.extremecloudiq.com

[ "CLI_to_send_1", "CLI_to_send2" ]

HTTP Response

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

{
  "device_cli_outputs" : { }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/:cli' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc' \
    -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 36. /devices/{id}/:manage
Parameter Description

id

Device ID

HTTP Request

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

HTTP Response

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

[ ]

cURL Request

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

Reboot one device

POST /devices/{id}/:reboot

Path parameters

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

id

Device ID

HTTP Request

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

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/:reboot' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA' \
    -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 38. /devices/{id}/:unmanage
Parameter Description

id

Device ID

HTTP Request

POST /devices/438086664193/:unmanage HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

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

Get device alarms for one device

GET /devices/{id}/alarms

Path parameters

Table 39. /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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7316
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 715

{
  "page" : 2,
  "count" : 3,
  "total_pages" : 3,
  "total_count" : 8,
  "data" : [ {
    "entity_id" : 1,
    "timestamp" : 1783358881000,
    "severity" : "Major",
    "category" : "test-cat-1",
    "device_mac" : "TOIOPUHXWIGS",
    "client_mac" : "",
    "description" : "test-desc1"
  }, {
    "entity_id" : 2,
    "timestamp" : 1783358881000,
    "severity" : "Major",
    "category" : "test-cat-2",
    "device_mac" : "FVWCSHVZZYCT",
    "client_mac" : "",
    "description" : "test-desc2"
  }, {
    "entity_id" : 3,
    "timestamp" : 1783358881000,
    "severity" : "Major",
    "category" : "test-cat-3",
    "device_mac" : "SGEHCPLICIWI",
    "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA' \
    -H 'Content-Type: application/json'

Assign Client Monitor Profile to Device ID

POST /devices/client-monitor/:assign

Request Fields

Path Type Description

devices.ids

Array

The list of Device IDs to assign.

client_monitor.enable

Boolean

Enable or disable client monitoring on the device

client_monitor.client_monitor_profile_id

Number

The ID of a client monitor profile

HTTP Request

POST /devices/client-monitor/:assign HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/json
Content-Length: 136
Host: api.extremecloudiq.com

{
  "devices" : {
    "ids" : [ 1, 2 ]
  },
  "client_monitor" : {
    "client_monitor_profile_id" : 12341234,
    "enable" : true
  }
}

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/client-monitor/:assign' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI' \
    -H 'Content-Type: application/json' \
    -d '{
  "devices" : {
    "ids" : [ 1, 2 ]
  },
  "client_monitor" : {
    "client_monitor_profile_id" : 12341234,
    "enable" : true
  }
}'

Get Client Monitor Profile by device ID

POST /devices/client-monitor/:query

Request Fields

Path Type Description

ids

Array

The list of Device IDs to query.

HTTP Request

POST /devices/client-monitor/:query HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc
Content-Type: application/json
Content-Length: 22
Host: api.extremecloudiq.com

{
  "ids" : [ 1, 2 ]
}

Response Fields

Path Type Description

1

Object

the device Id being queried

1.enable

Boolean

Enable or disable client monitoring on the device

1.client_monitor_profile_id

Number

The ID of a client monitor profile

HTTP Response

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

{
  "1" : {
    "client_monitor_profile_id" : 2,
    "enable" : true
  }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/client-monitor/:query' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 1, 2 ]
}'

Delete Client Monitor Profile From Device ID

POST /devices/client-monitor:/revoke

Request Fields

Path Type Description

ids

Array

The list of Device IDs to revoke.

HTTP Request

POST /devices/client-monitor/:revoke HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA
Content-Type: application/json
Content-Length: 22
Host: api.extremecloudiq.com

{
  "ids" : [ 1, 2 ]
}

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/client-monitor/:revoke' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 1, 2 ]
}'

Get device CPU/memory usage for one device

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

Path parameters

Table 40. /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=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7301
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 162

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/history/cpu-mem?startTime=1&endTime=2&interval=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI' \
    -H 'Content-Type: application/json'

Change hostname for one device

PUT /devices/{id}/hostname

Path parameters

Table 41. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc
Content-Type: application/json
Host: api.extremecloudiq.com

hostname=hostname_001

HTTP Response

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

cURL Request

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

Update visible for one device

PUT /devices/{id}/visible

Path parameters

Table 42. /devices/{id}/visible
Parameter Description

id

Device ID

Request Parameters

Parameter Description

visible

The new visible status of a device in a floor

HTTP Request

PUT /devices/438086664193/visible HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg0LCJleHAiOjE3ODM5NjM2ODR9.ibH-apqy8AXRBXaO7KiHhiRqkZLJTWKX1zwZXaPzebQ
Content-Type: application/json
Host: api.extremecloudiq.com

visible=true

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/visible' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg0LCJleHAiOjE3ODM5NjM2ODR9.ibH-apqy8AXRBXaO7KiHhiRqkZLJTWKX1zwZXaPzebQ' \
    -H 'Content-Type: application/json' \
    -d 'visible=true'

Get location for one device

GET /devices/{id}/location

Path parameters

Table 43. /devices/{id}/location
Parameter Description

id

Device ID

HTTP Request

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

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
RateLimit: "default";r=7262
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 395

{
  "location_id" : 438086664193,
  "create_time" : "2026-07-06T17:28:03.000+0000",
  "update_time" : "2026-07-06T17:28:03.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc' \
    -H 'Content-Type: application/json'

Assign location to one device

PUT /devices/{id}/location

Path parameters

Table 44. /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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA
Content-Type: application/json
Content-Length: 90
Host: api.extremecloudiq.com

{
  "location_id" : 1,
  "x" : 0.0,
  "y" : 0.0,
  "latitude" : 0.0,
  "longitude" : 0.0
}

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/location' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA' \
    -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 45. /devices/{id}/location
Parameter Description

id

Device ID

HTTP Request

DELETE /devices/438086664193/location HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

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

Get network policy for one device

GET /devices/{id}/network-policy

Path parameters

Table 46. /devices/{id}/network-policy
Parameter Description

id

Device ID

HTTP Request

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

Response Fields

Path Type Description

id

Number

The unique identifier.

create_time

String

The create time in UTC (ISO 8601 format).

update_time

String

The last update time in UTC (ISO 8601 format).

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. Allowed values: NetworkAccessAndSwitching, BranchRouting, WirelessAccess, Switching, NetworkAccessAndSwitchingAndBR, NetworkAccessAndBranchRouting, SwitchingAndBranchRouting.

predefined

Boolean

Whether it is a predefined network policy.

HTTP Response

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

{
  "id" : 438086664193,
  "create_time" : "2026-07-06T17:28:01.000+0000",
  "update_time" : "2026-07-06T17:28:01.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA' \
    -H 'Content-Type: application/json'

Assign network policy to one device

PUT /devices/{id}/network-policy

Path parameters

Table 47. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/json
Host: api.extremecloudiq.com

networkPolicyId=438086664194

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/network-policy' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI' \
    -H 'Content-Type: application/json' \
    -d 'networkPolicyId=438086664194'

Revoke network policy for one device

DELETE /devices/{id}/network-policy

Path parameters

Table 48. /devices/{id}/network-policy
Parameter Description

id

Device ID

HTTP Request

DELETE /devices/438086664193/network-policy HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg0LCJleHAiOjE3ODM5NjM2ODR9.ibH-apqy8AXRBXaO7KiHhiRqkZLJTWKX1zwZXaPzebQ
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/network-policy' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg0LCJleHAiOjE3ODM5NjM2ODR9.ibH-apqy8AXRBXaO7KiHhiRqkZLJTWKX1zwZXaPzebQ' \
    -H 'Content-Type: application/json'

Device level SSID override

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

Path parameters

Table 49. /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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA
Content-Type: application/json
Content-Length: 70
Host: api.extremecloudiq.com

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

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/ssid/:override' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA' \
    -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 50. /devices/{id}/ssid/status
Parameter Description

id

The device ID

HTTP Request

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

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
RateLimit: "default";r=7248
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 72

{
  "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg0LCJleHAiOjE3ODM5NjM2ODR9.ibH-apqy8AXRBXaO7KiHhiRqkZLJTWKX1zwZXaPzebQ' \
    -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 51. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/json
Content-Length: 88
Host: api.extremecloudiq.com

{
  "ssid_ids" : [ 1, 2, 3 ],
  "if_names" : [ "WIFI0", "WIFI1" ],
  "enabled" : false
}

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/ssid/status/:change' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA
Content-Type: application/json
Content-Length: 206
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7311
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/location/:assign' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/json
Content-Length: 58
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7296
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 446

{
  "438086664193" : {
    "location_id" : 438086664193,
    "create_time" : "2026-07-06T17:28:02.000+0000",
    "update_time" : "2026-07-06T17:28:02.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/json
Content-Length: 58
Host: api.extremecloudiq.com

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

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/location/:revoke' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc
Content-Type: application/json
Content-Length: 107
Host: api.extremecloudiq.com

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

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/network-policy/:assign' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA
Content-Type: application/json
Content-Length: 58
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7296
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 446

{
  "438086664193" : {
    "location_id" : 438086664193,
    "create_time" : "2026-07-06T17:28:02.000+0000",
    "update_time" : "2026-07-06T17:28:02.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODg0LCJleHAiOjE3ODM5NjM2ODR9.ibH-apqy8AXRBXaO7KiHhiRqkZLJTWKX1zwZXaPzebQ
Content-Type: application/json
Content-Length: 58
Host: api.extremecloudiq.com

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

HTTP Response

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

cURL Request

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

List assigned devices for network policy

GET /devices/network-policy/{policyId}

Path parameters

Table 52. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc
Content-Type: application/json
Content-Length: 58
Host: api.extremecloudiq.com

{
  "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

data[].mgt_vlan

Number

mgt Vlan

data[].images_names[]

Array

images names

data[].visible

Boolean

The visible status of a device in a floor.

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "create_time" : "2026-07-06T17:28:03.000+0000",
    "update_time" : "2026-07-06T17:28:03.000+0000",
    "org_id" : 10,
    "serial_number" : "79805659522430",
    "service_tag" : "",
    "mac_address" : "RWS48wJ4Tq8G",
    "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" : "",
    "mgt_vlan" : 0,
    "images_names" : [ ],
    "visible" : false
  }, {
    "id" : 2,
    "create_time" : "2026-07-06T17:28:03.000+0000",
    "update_time" : "2026-07-06T17:28:03.000+0000",
    "org_id" : 10,
    "serial_number" : "75124291934771",
    "service_tag" : "",
    "mac_address" : "LVN3q1CMrHH2",
    "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" : "",
    "mgt_vlan" : 0,
    "images_names" : [ ],
    "visible" : false
  }, {
    "id" : 3,
    "create_time" : "2026-07-06T17:28:03.000+0000",
    "update_time" : "2026-07-06T17:28:03.000+0000",
    "org_id" : 10,
    "serial_number" : "50172959401590",
    "service_tag" : "",
    "mac_address" : "AQ4J6vrAGh1r",
    "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" : "",
    "mgt_vlan" : 0,
    "images_names" : [ ],
    "visible" : false
  }, {
    "id" : 4,
    "create_time" : "2026-07-06T17:28:03.000+0000",
    "update_time" : "2026-07-06T17:28:03.000+0000",
    "org_id" : 10,
    "serial_number" : "30192708074674",
    "service_tag" : "",
    "mac_address" : "q4Pw4TS8ODvs",
    "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" : "",
    "mgt_vlan" : 0,
    "images_names" : [ ],
    "visible" : false
  }, {
    "id" : 5,
    "create_time" : "2026-07-06T17:28:03.000+0000",
    "update_time" : "2026-07-06T17:28:03.000+0000",
    "org_id" : 10,
    "serial_number" : "17267078752879",
    "service_tag" : "",
    "mac_address" : "clvkAbMqdSqg",
    "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" : "",
    "mgt_vlan" : 0,
    "images_names" : [ ],
    "visible" : false
  }, {
    "id" : 6,
    "create_time" : "2026-07-06T17:28:03.000+0000",
    "update_time" : "2026-07-06T17:28:03.000+0000",
    "org_id" : 10,
    "serial_number" : "02580149092583",
    "service_tag" : "",
    "mac_address" : "U2UthTscrl6i",
    "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" : "",
    "mgt_vlan" : 0,
    "images_names" : [ ],
    "visible" : false
  }, {
    "id" : 7,
    "create_time" : "2026-07-06T17:28:03.000+0000",
    "update_time" : "2026-07-06T17:28:03.000+0000",
    "org_id" : 10,
    "serial_number" : "06462643639836",
    "service_tag" : "",
    "mac_address" : "uiCEahtJ8wjw",
    "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" : "",
    "mgt_vlan" : 0,
    "images_names" : [ ],
    "visible" : false
  }, {
    "id" : 8,
    "create_time" : "2026-07-06T17:28:03.000+0000",
    "update_time" : "2026-07-06T17:28:03.000+0000",
    "org_id" : 10,
    "serial_number" : "44710389033385",
    "service_tag" : "",
    "mac_address" : "Ut5SvIqDiekF",
    "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" : "",
    "mgt_vlan" : 0,
    "images_names" : [ ],
    "visible" : false
  }, {
    "id" : 9,
    "create_time" : "2026-07-06T17:28:03.000+0000",
    "update_time" : "2026-07-06T17:28:03.000+0000",
    "org_id" : 10,
    "serial_number" : "44198161587548",
    "service_tag" : "",
    "mac_address" : "pbbSpbn2rwYq",
    "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" : "",
    "mgt_vlan" : 0,
    "images_names" : [ ],
    "visible" : false
  }, {
    "id" : 10,
    "create_time" : "2026-07-06T17:28:03.000+0000",
    "update_time" : "2026-07-06T17:28:03.000+0000",
    "org_id" : 10,
    "serial_number" : "21554781630106",
    "service_tag" : "",
    "mac_address" : "tHInOhbUojog",
    "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" : "",
    "mgt_vlan" : 0,
    "images_names" : [ ],
    "visible" : false
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/network-policy/438086664193?page=1&limit=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/json
Content-Length: 56
Host: api.extremecloudiq.com

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

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/os/:change' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/json
Host: api.extremecloudiq.com

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

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/radius-proxy/:assign' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI' \
    -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?ids=438086664193&ids=438086664194&ids=438086664195 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/radius-proxy/:revoke?ids=438086664193&ids=438086664194&ids=438086664195' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/json
Host: api.extremecloudiq.com

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: "default";r=7292
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 97

{
  "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI' \
    -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

Number

The country code to assign

HTTP Request

POST /devices/country-code/:assign HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/json
Content-Length: 104
Host: api.extremecloudiq.com

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

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/country-code/:assign' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI' \
    -H 'Content-Type: application/json' \
    -d '{
  "devices" : {
    "ids" : [ 438086664193, 438086664194, 438086664195 ]
  },
  "country_code" : 840
}'

Change description for one device

PUT /devices/{id}/description

Path parameters

Table 53. /devices/{id}/description
Parameter Description

id

Device ID

Request Body

Description with length 1 - 64

HTTP Request

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

Description with length 1 - 64

HTTP Response

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

cURL Request

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

Get CLI Response from devices asynchronously

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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc
Content-Type: application/json
Content-Length: 124
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7267
Location: http://localhost:8081/operations/operation-id
Retry-After: 2
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:cli?async=true' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc' \
    -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 54. /devices/{id}/installation-report
Parameter Description

id

Device ID

HTTP Request

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

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.

installation_time

String

The timestamp of installation.

installed_by

String

Installed by

image_file_details[].file_name

String

The image file name.

image_file_details[].complete_url

String

The image complete Url.

HTTP Response

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

{
  "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" : [ ],
  "installation_time" : "2026-07-06T17:28:03.000+0000",
  "installed_by" : "User",
  "image_file_details" : [ {
    "file_name" : "346698350167800x.png",
    "complete_url" : "https://in.extremecloudiq.com/afs-webapp/devices/gallery/80700/346698350167780/346698350167800x.png"
  } ]
}

cURL Request

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

Download device gallery image

GET /devices/{id}/gallery-image

Path Parameters

Table 55. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/octet-stream
Accept: application/octet-stream
Content-Disposition: form-data; name="attachment"; filename="filename"
Host: api.extremecloudiq.com

HTTP Response

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

images.png

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/gallery-image?imageName=images.png' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI' \
    -H 'Content-Type: application/octet-stream' \
    -H 'Accept: 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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/json
Content-Length: 77
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7282
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI' \
    -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 56. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA
Content-Type: application/json
Content-Length: 74
Host: api.extremecloudiq.com

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

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/thread/commissioner/:start' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgxLCJleHAiOjE3ODM5NjM2ODF9.-v0Rf1L1mDa85Q1sxe3erbR2e3Z93xt8GTTfO9FYtYA' \
    -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 57. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/json
Content-Length: 50
Host: api.extremecloudiq.com

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

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/thread/commissioner/:stop' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI' \
    -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 58. /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=1783272483695&endTime=1783358883695 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

[].frequency

String

The WiFi frequency

[].ssid_count

Number

The latest SSIDs assigned on this wireless interface.

[].client_count

Number

The number of unique clients associated to this wireless interface.

[].neighbor_clients

Number

The number of clients associated to neighboring APs.

[].channel_util

Number

The average channel utilization.

[].channel

Number

The latest associated wireless channel

[].channel_width

Number

The latest associated channel width

[].tx_utilization

Number

The average Tx utilization.

[].rx_utilization

Number

The average Rx utilization.

[].tx_byte_count

Number

The total Tx byte count

[].rx_byte_count

Number

The total Rx byte count

[].noise_floor

Number

The average noise floor

[].crc_error_frame

Number

The total crc error frames

[].tx_retry_frame

Number

The total Tx retry frames

[].rx_retry_frame

Number

The total Rx retry frames

[].unicast_tx_packet_count

Number

The total unicast Tx packet count

[].unicast_rx_packet_count

Number

The total unicast Rx packet count

[].broadcast_tx_packet_count

Number

The total broadcast Tx packet count

[].broadcast_rx_packet_count

Number

The total 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 channel utilization

[].scan_avg_interference

Number

The average scanned interference utilization

[].mac_address

String

The BSSID

[].power

Number

The latest radio power

[].rx_errors

Number

The total Rx errors

[].tx_errors

Number

The total Tx errors

[].interface_name

String

The interface name

[].radio_profile_name

String

The latest ExtremecloudIQ radio profile name.

HTTP Response

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

[ {
  "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=1783272483695&endTime=1783358883695' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc' \
    -H 'Content-Type: application/json'

Get FTM settings by device ID

GET /devices/{id}/ftm-settings

Path Parameters

Table 59. /devices/{id}/ftm-settings
Parameter Description

id

The device ID.

HTTP Request

GET /devices/438086664193/ftm-settings HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7320
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 566

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:00.000+0000",
  "update_time" : "2026-07-06T17:28:00.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo' \
    -H 'Content-Type: application/json'

Configure FTM settings

PUT /devices/{id}/ftm-settings

Path Parameters

Table 60. /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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo
Content-Type: application/json
Content-Length: 454
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7319
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 566

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:00.000+0000",
  "update_time" : "2026-07-06T17:28:00.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo' \
    -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 61. /devices/{id}/ftm-settings
Parameter Description

id

The device ID.

HTTP Request

DELETE /devices/438086664193/ftm-settings HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/ftm-settings' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgwLCJleHAiOjE3ODM5NjM2ODB9.rsWuYz_GgspyA0f5t6kIiBehWW6i_mIaZ80S3gn1Iyo' \
    -H 'Content-Type: application/json'

Get Radio Operating Mode settings at device level.

GET /devices/{id}/radio-operating-modes

Path parameters

Table 62. /devices/{id}/radio-operating-mode
Parameter Description

id

Device ID

HTTP Request

GET /devices/438086664193/radio-operating-mode HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

radio_operating_mode

String

The radio operating mode, e.g. SERVICE_2_5_6, SERVICE_5L_5H_6 etc

wireless_interfaces[].name

String

The wireless interface name, e.g. WIFI0, WIFI1, WIFI2

wireless_interfaces[].radio_profile_id

Number

The radio profile ID assigned to wifi interface

HTTP Response

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

{
  "radio_operating_mode" : "SERVICE_2_5_6",
  "wireless_interfaces" : [ {
    "name" : "WIFI0",
    "radio_profile_id" : 30010
  }, {
    "name" : "WIFI1",
    "radio_profile_id" : 30011
  }, {
    "name" : "WIFI2",
    "radio_profile_id" : 30012
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/radio-operating-mode' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI' \
    -H 'Content-Type: application/json'

Configure Radio Operating Mode settings at device level.

PUT /devices/{id}/radio-operating-modes

Path parameters

Table 63. /devices/{id}/radio-operating-mode
Parameter Description

id

Device ID

HTTP Request

PUT /devices/438086664193/radio-operating-mode HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc
Content-Type: application/json
Content-Length: 256
Host: api.extremecloudiq.com

{
  "radio_operating_mode" : "SERVICE_2_5_6",
  "wireless_interfaces" : [ {
    "name" : "WIFI0",
    "radio_profile_id" : 30010
  }, {
    "name" : "WIFI2",
    "radio_profile_id" : 30011
  }, {
    "name" : "WIFI2",
    "radio_profile_id" : 30012
  } ]
}

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/radio-operating-mode' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgzLCJleHAiOjE3ODM5NjM2ODN9.cCJ1zgOhumpsHHu0Xc2e5zPV18jFmt6ArOVWaD8NqTc' \
    -H 'Content-Type: application/json' \
    -d '{
  "radio_operating_mode" : "SERVICE_2_5_6",
  "wireless_interfaces" : [ {
    "name" : "WIFI0",
    "radio_profile_id" : 30010
  }, {
    "name" : "WIFI2",
    "radio_profile_id" : 30011
  }, {
    "name" : "WIFI2",
    "radio_profile_id" : 30012
  } ]
}'

Get rm device list

POST /devices/rm-devices-page

Request Parameters

Parameter Description

page

Page number

limit

Page size

connected

The device connect status

adminStates

The device admin manage status

sortField

The device sort field

order

The device sort order

deviceTypes

The device types

keyword

The keyword to search

deviceCategory

The device category like WIRED, WIRELESS

configMismatch

Config audit status(MATCHED(false) or UNMATCHED(true))

async

Flag to enable LRO

copilotLicenseStatuses

The CoPilot license status of the device, e.g. ACTIVE, EXPIRED, UNLICENSED, NONE, NA, TRIAL

HTTP Request

POST /devices/rm-devices-page?page=1&limit=10&connected=false&adminStates=MANAGED%2CNEW&deviceCategory=WIRELESS&keyword=AP_230&sortField=MAC&order=DESC&deviceTypes=REAL%2CDIGITAL_TWIN&configMismatch=false&async=true&copilotLicenseStatuses=ACTIVE%2CEXPIRED%2CUNLICENSED HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI
Content-Type: application/json
Content-Length: 504
Host: api.extremecloudiq.com

{
  "site_ids" : [ 438086787227, 438086787229 ],
  "sns" : [ "03022407250459", "98505734561149" ],
  "mac_addresses" : [ "B027CFDA7F80", "FF5FB038E404" ],
  "hostnames" : [ "device-hostname", "device-hostname-1" ],
  "default_gateway_ips" : [ "10.234.177.254", "10.234.163.254" ],
  "product_types" : [ "AP_302W", "AP_120" ],
  "firmware_versions" : [ "10.7.2.0", "10.2.0.0" ],
  "country_codes" : [ 91, 840, 998 ],
  "managed_by" : [ "XIQ", "XMC" ],
  "network_policies" : [ "test-nwp", "test-nwp-1" ]
}

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 in UTC (ISO 8601 format).

data[].update_time

String

The last update time in UTC (ISO 8601 format).

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

String

The device MAC address in format XXXXXXXXXXXX.

data[].product_type

String

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

data[].hostname

String

The device hostname.

data[].device_ip

String

The device IPv4 address.

data[].software_version

String

The device OS software version.

data[].device_admin_state

String

The device admin state.

data[].sim_type

String

The device type - REAL or SIMULATED.

data[].connected

Boolean

The device connection status.

data[].default_gateway

String

The device default gateway.

data[].ipv6_address

String

The device IPv6 address.

data[].country_code

Number

The assigned country code on the device.

data[].system_up_time

Number

The device uptime in milliseconds.

data[].updated_on

Number

The last device updated time.

data[].managed_by

String

The managed application for the device.

data[].config_mismatch

Boolean

Config audit status(MATCHED(false) or UNMATCHED(true))

data[].device_category

String

The device category i.e WIRED, WIRELESS

data[].has_management_ip_issue

Boolean

Flag to indicate if the device has management IP issue.

data[].has_default_gateway_issue

Boolean

Flag to indicate if the device has default gateway issue.

data[].has_firmware_version_issue

Boolean

Flag to indicate if the device has firmware issue.

data[].locations.site

String

The site name

data[].locations.site_id

Number

The site ID

data[].locations.building

String

The building name

data[].locations.building_id

Number

The building ID

data[].locations.floor

String

The floor name

data[].locations.floor_id

Number

The floor ID

data[].device_license_tier

String

The license tier of the device

data[].device_license_type

String

The license type of the device

data[].network_policy_id

Number

The network policy ID assigned to the device

data[].network_policy_name

String

The network policy name assigned to the device

data[].device_template_name

String

The template name assigned to the device

data[].os

String

The OS name

data[].cloud_config_groups

Array

The cloud config groups assigned to the device

data[].eth0_uplink_speed

String

The uplink speed of eth0 interface in Mbps

data[].eth1_uplink_speed

String

The uplink speed of eth1 interface in Mbps

data[].copilot_license_status

String

The CoPilot license status of the device, e.g. ACTIVE, EXPIRED, UNLICENSED, NONE, NA, TRIAL

data[].device_family

String

Device family or category (e.g. "AP", "UCP", "SWITCH", "XIQ_SE", "TPME", "THIRDPARTY", "TUNNELCONCENTRATOR", "CONTROLLER")

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "create_time" : "2026-07-06T17:28:03.000+0000",
    "update_time" : "2026-07-06T17:28:03.000+0000",
    "org_id" : 10,
    "connected" : true,
    "hostname" : "PLAN-6216E1-1",
    "system_up_time" : 0,
    "updated_on" : 1736330058366,
    "mac_address" : "ZpyxiVfCigcT",
    "serial_number" : "51398325788189",
    "device_ip" : "192.168.56.1",
    "default_gateway" : "",
    "software_version" : "8.4.10.0",
    "product_type" : "AP230",
    "ipv6_address" : "",
    "device_admin_state" : "MANAGED",
    "sim_type" : "REAL",
    "country_code" : 840,
    "managed_by" : "XIQ",
    "config_mismatch" : true,
    "locations" : {
      "site" : "San Jose",
      "site_id" : 4294967398282,
      "building" : "building_01",
      "building_id" : 4294967398282,
      "floor" : "floor_01",
      "floor_id" : 4294967398282
    },
    "device_category" : "WIRELESS",
    "has_management_ip_issue" : false,
    "has_default_gateway_issue" : false,
    "has_firmware_version_issue" : false,
    "device_license_tier" : "TIER_A",
    "device_license_type" : "ADVANCED",
    "network_policy_id" : 4294967396040,
    "network_policy_name" : "test-nwp",
    "os" : "EXOS",
    "eth0_uplink_speed" : "",
    "eth1_uplink_speed" : "",
    "device_family" : ""
  }, {
    "id" : 2,
    "create_time" : "2026-07-06T17:28:03.000+0000",
    "update_time" : "2026-07-06T17:28:03.000+0000",
    "org_id" : 10,
    "connected" : true,
    "hostname" : "5-1-ESEV",
    "system_up_time" : 0,
    "updated_on" : 1736330058355,
    "mac_address" : "odrDBSWY021E",
    "serial_number" : "09652591192579",
    "device_ip" : "",
    "default_gateway" : "",
    "software_version" : "32.1.0.369",
    "product_type" : "XIQ5010",
    "ipv6_address" : "",
    "device_admin_state" : "NEW",
    "sim_type" : "REAL",
    "country_code" : 840,
    "managed_by" : "XIQ",
    "config_mismatch" : false,
    "locations" : {
      "site" : "Bengaluru",
      "site_id" : 4294967396041,
      "building" : "Ecospace",
      "building_id" : 4294967396044,
      "floor" : "Floor_01",
      "floor_id" : 4294967396045
    },
    "device_category" : "WIRELESS",
    "has_management_ip_issue" : true,
    "has_default_gateway_issue" : true,
    "has_firmware_version_issue" : true,
    "device_license_tier" : "TIER_B",
    "device_license_type" : "PILOT",
    "network_policy_id" : 4294967396041,
    "network_policy_name" : "test-nwp-1",
    "os" : "EXOS",
    "eth0_uplink_speed" : "",
    "eth1_uplink_speed" : "",
    "device_family" : ""
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/rm-devices-page?page=1&limit=10&connected=false&adminStates=MANAGED%2CNEW&deviceCategory=WIRELESS&keyword=AP_230&sortField=MAC&order=DESC&deviceTypes=REAL%2CDIGITAL_TWIN&configMismatch=false&async=true&copilotLicenseStatuses=ACTIVE%2CEXPIRED%2CUNLICENSED' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODgyLCJleHAiOjE3ODM5NjM2ODJ9.rQJ584se0413STFulTIDpWaSfB-e654I_iPzzUb0wpI' \
    -H 'Content-Type: application/json' \
    -d '{
  "site_ids" : [ 438086787227, 438086787229 ],
  "sns" : [ "03022407250459", "98505734561149" ],
  "mac_addresses" : [ "B027CFDA7F80", "FF5FB038E404" ],
  "hostnames" : [ "device-hostname", "device-hostname-1" ],
  "default_gateway_ips" : [ "10.234.177.254", "10.234.163.254" ],
  "product_types" : [ "AP_302W", "AP_120" ],
  "firmware_versions" : [ "10.7.2.0", "10.2.0.0" ],
  "country_codes" : [ 91, 840, 998 ],
  "managed_by" : [ "XIQ", "XMC" ],
  "network_policies" : [ "test-nwp", "test-nwp-1" ]
}'

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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7022
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 666

{
  "page" : 2,
  "count" : 2,
  "total_pages" : 1,
  "total_count" : 2,
  "data" : [ {
    "id" : 10,
    "create_time" : "2026-07-06T17:28:42.000+0000",
    "update_time" : "2026-07-06T17:28:42.000+0000",
    "org_id" : 0,
    "name" : "Policy_000",
    "description" : "Test network policy",
    "predefined" : false,
    "type" : "NETWORK_ACCESS_AND_BRANCH_ROUTING"
  }, {
    "id" : 11,
    "create_time" : "2026-07-06T17:28:42.000+0000",
    "update_time" : "2026-07-06T17:28:42.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js
Content-Type: application/json
Content-Length: 116
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7025
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 269

{
  "id" : 10,
  "create_time" : "2026-07-06T17:28:42.000+0000",
  "update_time" : "2026-07-06T17:28:42.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js' \
    -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 64. /network-policies/{id}
Parameter Description

id

The network policy ID

HTTP Request

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

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: "default";r=7020
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 269

{
  "id" : 10,
  "create_time" : "2026-07-06T17:28:42.000+0000",
  "update_time" : "2026-07-06T17:28:42.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js' \
    -H 'Content-Type: application/json'

Update network policy

PUT /network-policies/{id}

Path Parameters

Table 65. /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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js
Content-Type: application/json
Content-Length: 116
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7024
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 269

{
  "id" : 10,
  "create_time" : "2026-07-06T17:28:42.000+0000",
  "update_time" : "2026-07-06T17:28:42.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js' \
    -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 66. /network-policies/{id}
Parameter Description

id

The network policy ID

HTTP Request

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

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/network-policies/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js' \
    -H 'Content-Type: application/json'

List ssid list for the network policy

GET /network-policies/{id}/ssids

Path Parameters

Table 67. /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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7026
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 1774

{
  "page" : 1,
  "count" : 0,
  "total_pages" : 0,
  "total_count" : 0,
  "data" : [ {
    "id" : 10,
    "create_time" : "2026-07-06T17:28:42.000+0000",
    "update_time" : "2026-07-06T17:28:42.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" : "2026-07-06T17:28:42.000+0000",
    "update_time" : "2026-07-06T17:28:42.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js' \
    -H 'Content-Type: application/json'

Adding multiple ssids to the network policy

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

Path Parameters

Table 68. /network-policies/{id}/ssids/:add
Parameter Description

id

The network policy ID.

HTTP Request

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

[ 438086664193, 438086664194, 438086664195 ]

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/network-policies/438086664193/ssids/:add' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js' \
    -d '[ 438086664193, 438086664194, 438086664195 ]'

Removing multiple ssids from the network policy

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

Path Parameters

Table 69. /network-policies/{id}/ssids/:remove
Parameter Description

id

The network policy ID.

HTTP Request

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

[ 438086664193, 438086664194, 438086664195 ]

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/network-policies/438086664193/ssids/:remove' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js' \
    -d '[ 438086664193, 438086664194, 438086664195 ]'

Client

Get client details

GET /clients/{id}

Path parameters

Table 70. /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, mac_protocol.
[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, mac_protocol, make, os_version, connected_to, connection_duration, captive_web_portal

HTTP Request

GET /clients/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE5LCJleHAiOjE3ODM5NjM3MTl9.UDqG_aR_lZ5YVNQONTWOgPb2ocr92gjIIkJu9OwxMAs
Content-Type: application/json
Host: api.extremecloudiq.com

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

mac_protocol

String

The MAC protocol 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

make

String

The Manufacturer of the client associated device

os_version

String

The OS version of the client associated device

connected_to

String

The device name which client is connected to

connection_duration

Number

The client’s connection duration

captive_web_portal

String

Captive Web Portal

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:39.000+0000",
  "update_time" : "2026-07-06T17:28:39.000+0000",
  "org_id" : 0,
  "location_id" : 1,
  "device_id" : 1,
  "hostname" : "Hostname 2",
  "mac_address" : "TP82FGBCUU28",
  "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" : "2026-07-06T17:28:39.000+0000",
  "offline_time" : "2026-07-06T17:28:39.000+0000",
  "vlan" : 1,
  "connection_type" : 0,
  "ssid" : "SSID 2",
  "port" : "22",
  "org_name" : "",
  "device_function" : 0,
  "device_mac_address" : "WVGIQJFWBCVZ",
  "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,
  "mac_protocol" : "",
  "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",
  "make" : "Samsung",
  "os_version" : "iOS 18",
  "connected_to" : "test-wifi",
  "connection_duration" : 1000,
  "captive_web_portal" : "CWP"
}

cURL Request

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

Get client details by mac

GET /clients/byMac/{clientMac}

Path parameters

Table 71. /clients/byMac/{clientMac}
Parameter Description

clientMac

Mac address of the client.

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, mac_protocol.
[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, mac_protocol

HTTP Request

GET /clients/byMac/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE5LCJleHAiOjE3ODM5NjM3MTl9.UDqG_aR_lZ5YVNQONTWOgPb2ocr92gjIIkJu9OwxMAs
Content-Type: application/json
Host: api.extremecloudiq.com

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

mac_protocol

String

The MAC protocol 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

make

String

The Manufacturer of the client associated device

os_version

String

The OS version of the client associated device

connected_to

String

The device name which client is connected to

connection_duration

Number

The client’s connection duration

captive_web_portal

String

Captive Web Portal

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:39.000+0000",
  "update_time" : "2026-07-06T17:28:39.000+0000",
  "org_id" : 0,
  "location_id" : 1,
  "device_id" : 1,
  "hostname" : "Hostname 2",
  "mac_address" : "DFPIFMDIGSFG",
  "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" : "2026-07-06T17:28:39.000+0000",
  "offline_time" : "2026-07-06T17:28:39.000+0000",
  "vlan" : 1,
  "connection_type" : 0,
  "ssid" : "SSID 2",
  "port" : "22",
  "org_name" : "",
  "device_function" : 0,
  "device_mac_address" : "9KKYZROLEXGT",
  "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,
  "mac_protocol" : "",
  "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",
  "make" : "Samsung",
  "os_version" : "iOS 18",
  "connected_to" : "test-wifi",
  "connection_duration" : 1000,
  "captive_web_portal" : "CWP"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/clients/byMac/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE5LCJleHAiOjE3ODM5NjM3MTl9.UDqG_aR_lZ5YVNQONTWOgPb2ocr92gjIIkJu9OwxMAs' \
    -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

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, mac_protocol.
[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, mac_protocol

HTTP Request

GET /clients/active HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE5LCJleHAiOjE3ODM5NjM3MTl9.UDqG_aR_lZ5YVNQONTWOgPb2ocr92gjIIkJu9OwxMAs
Content-Type: application/json
Host: api.extremecloudiq.com

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. Represented by an integer code for each standard:
1 - 2.4G
2 - 5G
3 - WIRED
4 - 6G
5 - THREAD

data[].encryption_method

Number

The encryption method, represented by an integer code for each encryption type:
-1 - N/A (Not applicable)
0 - AES (Advanced Encryption Standard)
1 - TKIP (Temporal Key Integrity Protocol)
2 - WEP (Wired Equivalent Privacy)
3 - NON (No encryption)
4 - CCMP (Counter Mode with Cipher Block Chaining Message Authentication Code Protocol)
5 - KEYGUARD (Keyguard encryption)
6 - WEP128 (128-bit WEP encryption)
7 - WEP64 (64-bit WEP encryption)
8 - WAPI (WLAN Authentication and Privacy Infrastructure)
9 - GCMP256 (256-bit Galois/Counter Mode Protocol)
10 - NONE (No encryption)
11 - PAP (Password Authentication Protocol)
12 - MsCHAP (Microsoft Challenge Handshake Authentication Protocol)
13 - EAP-MD5 (Extensible Authentication Protocol - MD5)
14 - EAP-TLS (Extensible Authentication Protocol - Transport Layer Security)
15 - PEAP (Protected Extensible Authentication Protocol)
16 - TTLS (Tunneled Transport Layer Security)
17 - TTLS-INNER-TUNNEL (Inner tunnel for TTLS)
18 - PEAP-INNER-TUNNEL (Inner tunnel for PEAP)
19 - EAP-FAST (Extensible Authentication Protocol - Flexible Authentication via Secure Tunneling)
20 - EAP-LEAP (Lightweight Extensible Authentication Protocol)
21 - EAP-RSA (Extensible Authentication Protocol - RSA)
22 - EAP-SIM (Extensible Authentication Protocol - SIM)
23 - EAP-AKA (Extensible Authentication Protocol - AKA)
24 - EAP-TEAP (Extensible Authentication Protocol - Tunneled EAP)

data[].mac_protocol

String

The MAC protocol of the client:
'N/A'
'802.11a'
'802.11b'
'802.11g'
'802.11na'
'802.11ng'
'802.11ac'
'802.11ax-2.4g'
'802.11ax-5g'
'802.3'
'802.11ax-6g'
'802.15.4'
'802.11be-2g'
'802.11be-5g'
'802.11be-6g'

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

data[].make

String

The Manufacturer of the client associated device

data[].os_version

String

The OS version of the client associated device

data[].connected_to

String

The device name which client is connected to

data[].connection_duration

Number

The client’s connection duration

data[].captive_web_portal

String

Captive Web Portal

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 0,
    "create_time" : "2026-07-06T17:28:39.000+0000",
    "update_time" : "2026-07-06T17:28:39.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 1",
    "mac_address" : "E9RRE1FPCTNF",
    "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" : "2026-07-06T17:28:39.000+0000",
    "offline_time" : "2026-07-06T17:28:39.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 1",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "OOMIV6VX7NKE",
    "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,
    "mac_protocol" : "",
    "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",
    "make" : "Samsung",
    "os_version" : "iOS 18",
    "connected_to" : "test-wifi",
    "connection_duration" : 1000,
    "captive_web_portal" : "CWP"
  }, {
    "id" : 1,
    "create_time" : "2026-07-06T17:28:39.000+0000",
    "update_time" : "2026-07-06T17:28:39.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 2",
    "mac_address" : "2CU5FRKOMIGW",
    "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" : "2026-07-06T17:28:39.000+0000",
    "offline_time" : "2026-07-06T17:28:39.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 2",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "6ZBYBF6Y4EVC",
    "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,
    "mac_protocol" : "",
    "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",
    "make" : "Samsung",
    "os_version" : "iOS 18",
    "connected_to" : "test-wifi",
    "connection_duration" : 1000,
    "captive_web_portal" : "CWP"
  }, {
    "id" : 2,
    "create_time" : "2026-07-06T17:28:39.000+0000",
    "update_time" : "2026-07-06T17:28:39.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 3",
    "mac_address" : "X1JZ35KZ6WKV",
    "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" : "2026-07-06T17:28:39.000+0000",
    "offline_time" : "2026-07-06T17:28:39.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 3",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "OSOZDMUUM9RW",
    "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,
    "mac_protocol" : "",
    "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",
    "make" : "Samsung",
    "os_version" : "iOS 18",
    "connected_to" : "test-wifi",
    "connection_duration" : 1000,
    "captive_web_portal" : "CWP"
  }, {
    "id" : 3,
    "create_time" : "2026-07-06T17:28:39.000+0000",
    "update_time" : "2026-07-06T17:28:39.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 4",
    "mac_address" : "LQHZTFXJTMYM",
    "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" : "2026-07-06T17:28:39.000+0000",
    "offline_time" : "2026-07-06T17:28:39.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 4",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "XLIQWPNOCUBU",
    "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,
    "mac_protocol" : "",
    "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",
    "make" : "Samsung",
    "os_version" : "iOS 18",
    "connected_to" : "test-wifi",
    "connection_duration" : 1000,
    "captive_web_portal" : "CWP"
  }, {
    "id" : 4,
    "create_time" : "2026-07-06T17:28:39.000+0000",
    "update_time" : "2026-07-06T17:28:39.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 5",
    "mac_address" : "3N5G38ZCMXFG",
    "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" : "2026-07-06T17:28:39.000+0000",
    "offline_time" : "2026-07-06T17:28:39.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 5",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "Y4W7KQGSV1Z6",
    "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,
    "mac_protocol" : "",
    "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",
    "make" : "Samsung",
    "os_version" : "iOS 18",
    "connected_to" : "test-wifi",
    "connection_duration" : 1000,
    "captive_web_portal" : "CWP"
  }, {
    "id" : 5,
    "create_time" : "2026-07-06T17:28:39.000+0000",
    "update_time" : "2026-07-06T17:28:39.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 6",
    "mac_address" : "ZJSNKRXLOMAI",
    "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" : "2026-07-06T17:28:39.000+0000",
    "offline_time" : "2026-07-06T17:28:39.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 6",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "M6WCNJ7TKRZO",
    "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,
    "mac_protocol" : "",
    "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",
    "make" : "Samsung",
    "os_version" : "iOS 18",
    "connected_to" : "test-wifi",
    "connection_duration" : 1000,
    "captive_web_portal" : "CWP"
  }, {
    "id" : 6,
    "create_time" : "2026-07-06T17:28:39.000+0000",
    "update_time" : "2026-07-06T17:28:39.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 7",
    "mac_address" : "HXT7KEJXVVTU",
    "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" : "2026-07-06T17:28:39.000+0000",
    "offline_time" : "2026-07-06T17:28:39.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 7",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "GDFMLRFDXMBW",
    "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,
    "mac_protocol" : "",
    "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",
    "make" : "Samsung",
    "os_version" : "iOS 18",
    "connected_to" : "test-wifi",
    "connection_duration" : 1000,
    "captive_web_portal" : "CWP"
  }, {
    "id" : 7,
    "create_time" : "2026-07-06T17:28:39.000+0000",
    "update_time" : "2026-07-06T17:28:39.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 8",
    "mac_address" : "JU3JZOXETDGW",
    "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" : "2026-07-06T17:28:39.000+0000",
    "offline_time" : "2026-07-06T17:28:39.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 8",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "Q5I9M33AM1JH",
    "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,
    "mac_protocol" : "",
    "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",
    "make" : "Samsung",
    "os_version" : "iOS 18",
    "connected_to" : "test-wifi",
    "connection_duration" : 1000,
    "captive_web_portal" : "CWP"
  }, {
    "id" : 8,
    "create_time" : "2026-07-06T17:28:39.000+0000",
    "update_time" : "2026-07-06T17:28:39.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 9",
    "mac_address" : "UHLC8ZFHK4W2",
    "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" : "2026-07-06T17:28:39.000+0000",
    "offline_time" : "2026-07-06T17:28:39.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 9",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "K4FIBI1OATAM",
    "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,
    "mac_protocol" : "",
    "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",
    "make" : "Samsung",
    "os_version" : "iOS 18",
    "connected_to" : "test-wifi",
    "connection_duration" : 1000,
    "captive_web_portal" : "CWP"
  }, {
    "id" : 9,
    "create_time" : "2026-07-06T17:28:39.000+0000",
    "update_time" : "2026-07-06T17:28:39.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 10",
    "mac_address" : "BJHR3QBY4VFR",
    "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" : "2026-07-06T17:28:39.000+0000",
    "offline_time" : "2026-07-06T17:28:39.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 10",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "HMNPDRRQYWIJ",
    "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,
    "mac_protocol" : "",
    "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",
    "make" : "Samsung",
    "os_version" : "iOS 18",
    "connected_to" : "test-wifi",
    "connection_duration" : 1000,
    "captive_web_portal" : "CWP"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/clients/active' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE5LCJleHAiOjE3ODM5NjM3MTl9.UDqG_aR_lZ5YVNQONTWOgPb2ocr92gjIIkJu9OwxMAs' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE5LCJleHAiOjE3ODM5NjM3MTl9.UDqG_aR_lZ5YVNQONTWOgPb2ocr92gjIIkJu9OwxMAs
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7035
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 119

{
  "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE5LCJleHAiOjE3ODM5NjM3MTl9.UDqG_aR_lZ5YVNQONTWOgPb2ocr92gjIIkJu9OwxMAs' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE5LCJleHAiOjE3ODM5NjM3MTl9.UDqG_aR_lZ5YVNQONTWOgPb2ocr92gjIIkJu9OwxMAs
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7040
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 128

[ {
  "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE5LCJleHAiOjE3ODM5NjM3MTl9.UDqG_aR_lZ5YVNQONTWOgPb2ocr92gjIIkJu9OwxMAs' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE5LCJleHAiOjE3ODM5NjM3MTl9.UDqG_aR_lZ5YVNQONTWOgPb2ocr92gjIIkJu9OwxMAs
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

HTTP/1.1 200 OK
RateLimit: "default";r=7037
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE5LCJleHAiOjE3ODM5NjM3MTl9.UDqG_aR_lZ5YVNQONTWOgPb2ocr92gjIIkJu9OwxMAs' \
    -H 'Content-Type: application/json'

Delete Client by macAddress

DELETE /clients/byMac/{clientMac}

Path Parameters

Table 72. /clients/byMac/{clientMac}
Parameter Description

clientMac

Mac address of the client.

HTTP Request

DELETE /clients/byMac/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE5LCJleHAiOjE3ODM5NjM3MTl9.UDqG_aR_lZ5YVNQONTWOgPb2ocr92gjIIkJu9OwxMAs
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/clients/byMac/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE5LCJleHAiOjE3ODM5NjM3MTl9.UDqG_aR_lZ5YVNQONTWOgPb2ocr92gjIIkJu9OwxMAs' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE5LCJleHAiOjE3ODM5NjM3MTl9.UDqG_aR_lZ5YVNQONTWOgPb2ocr92gjIIkJu9OwxMAs
Content-Type: application/json
Content-Length: 59
Host: api.extremecloudiq.com

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

HTTP Response

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

cURL Request

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

Client

Get client details info

GET /client-details/overview/info/{clientId}

Request Parameters

Parameter Description

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

HTTP Request

GET /client-details/overview/info/1?startTime=1736952774&endTime=1736952774 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

device_connected

Boolean

The device connected value

device_id

Number

The device ID

os_type

String

The client Os Type

ip_address

String

The client Ip Address

mac_address

String

The client mac Address

device_location_names

String

The location hierarchical tree.

device_location_id

Number

The location ID.

alias

String

The client alias name

user

String

The user name

connection_to

String

The Device Hostname

connection_time

Number

The connection Time

vlan

Number

The vlan

cwp_used

Number

The Captive Web Portal used

user_profile

String

The user profile name

ssid

String

The SSID

radio

String

The Radio Info (2G,5G,6G)

wifi_protocol

String

The wifi Protocol

channel

Number

The channel value

client_hostname

String

The client Hostname

client_type

String

The client Type

rtts_supported

Boolean

Whether the client supports RTTS

HTTP Response

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

{
  "device_connected" : false,
  "device_id" : 0,
  "os_type" : "osTypeTest",
  "ip_address" : "ipAddressTest",
  "mac_address" : "macAddressTest",
  "device_location_names" : "deviceLocationNamesTest",
  "device_location_id" : 0,
  "alias" : "aliasTest",
  "user" : "userTest",
  "connection_to" : "connectionToTest",
  "connection_time" : 0,
  "vlan" : 0,
  "cwp_used" : 0,
  "user_profile" : "userProfileTest",
  "ssid" : "ssidTest",
  "radio" : "radioTest",
  "wifi_protocol" : "wifiProtocolTest",
  "channel" : 0,
  "client_hostname" : "clientHostnameTest",
  "client_type" : "Wireless",
  "rtts_supported" : false
}

cURL Request

$ curl 'https://api.extremecloudiq.com/client-details/overview/info/1?startTime=1736952774&endTime=1736952774' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js' \
    -H 'Content-Type: application/json'

Get client connectivity experience

GET /client-details/overview/chart-data/{clientId}

Request Parameters

Parameter Description

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

precision

The precision in milliseconds since 1/1/1970

HTTP Request

GET /client-details/overview/chart-data/1?startTime=1736952774&endTime=1736952774&precision=6000 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

data[].timestamp

Number

The timestamp detect in epoch format (milliseconds)

data[].rssi

Number

The RSSI

data[].snr

Number

The SNR

data[].noise_floor

Number

The Noise floor

data[].rssi_from_device

Number

The RSSI from device

data[].roam_details

Object

The Roaming Details

data[].roam_details.device_name_from

String

The from Device name

data[].roam_details.device_mac_from

String

The from Device Mac

data[].roam_details.device_name_to

String

The to device name

data[].roam_details.device_mac_to

String

The to device mac

data[].roam_details.roam_duration

Number

The duration of roam

data[].roam_details.status_action

String

The status of roam

HTTP Response

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

{
  "data" : [ {
    "timestamp" : 1737224999006,
    "rssi" : 0,
    "snr" : 0,
    "noise_floor" : 0,
    "rssi_from_device" : 0,
    "roam_details" : {
      "device_name_from" : "deviceNameFromTest",
      "device_name_to" : "deviceNameToTest",
      "device_mac_from" : "deviceMacFromTest",
      "device_mac_to" : "deviceMacToTest",
      "roam_duration" : 0,
      "status_action" : "ROAM_TRAIL_ACTION_STATUS_COMPLETED"
    }
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/client-details/overview/chart-data/1?startTime=1736952774&endTime=1736952774&precision=6000' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTIyLCJleHAiOjE3ODM5NjM3MjJ9.R0t25mhdIvFWeeBUre60OvJoNgNkfFoWUs6OaUmP0Js' \
    -H 'Content-Type: application/json'

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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTExLCJleHAiOjE3ODM5NjM3MTF9.VWbRoD5lxBDTrnG0XhtmZ-E7ExKbonUzmHZCb-qj1D4
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7159
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 1145

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 2,
  "data" : [ {
    "id" : 1,
    "create_time" : "2026-07-06T17:28:31.000+0000",
    "update_time" : "2026-07-06T17:28:31.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" : "2026-07-06T17:28:31.000+0000",
    "update_time" : "2026-07-06T17:28:31.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTExLCJleHAiOjE3ODM5NjM3MTF9.VWbRoD5lxBDTrnG0XhtmZ-E7ExKbonUzmHZCb-qj1D4' \
    -H 'Content-Type: application/json'

List Top N clients usage for one application

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

Path parameters

Table 73. /applications/{id}/clients/top{n}
Parameter Description

id

The Application ID

n

The TOP N number

HTTP Request

GET /applications/438086664193/clients/top10?startTime=1783272511663&endTime=1783358911663 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTExLCJleHAiOjE3ODM5NjM3MTF9.VWbRoD5lxBDTrnG0XhtmZ-E7ExKbonUzmHZCb-qj1D4
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7162
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 437

[ {
  "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=1783272511663&endTime=1783358911663' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTExLCJleHAiOjE3ODM5NjM3MTF9.VWbRoD5lxBDTrnG0XhtmZ-E7ExKbonUzmHZCb-qj1D4' \
    -H 'Content-Type: application/json'

List Top N applications usage

GET /applications/top{n}

Path parameters

Table 74. /applications/top{n}
Parameter Description

n

The TOP N number

HTTP Request

GET /applications/top10?startTime=1783272511822&endTime=1783358911822 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTExLCJleHAiOjE3ODM5NjM3MTF9.VWbRoD5lxBDTrnG0XhtmZ-E7ExKbonUzmHZCb-qj1D4
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7157
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 187

[ {
  "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=1783272511822&endTime=1783358911822' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTExLCJleHAiOjE3ODM5NjM3MTF9.VWbRoD5lxBDTrnG0XhtmZ-E7ExKbonUzmHZCb-qj1D4' \
    -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=1783272515873&endTime=1783358915873&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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Host: api.extremecloudiq.com

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

String

The alert metadata name

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

Number

Floor ID

data[].floor_name

String

Floor name

data[].building_id

Number

Building ID

data[].building_name

String

Building name

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
RateLimit: "default";r=7084
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 1380

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : "100abc",
    "owner_id" : 101,
    "timestamp" : "2026-07-06T17:28:35.000+0000",
    "org_id" : 100,
    "message_metadata_id" : 738783,
    "message_metadata_type" : "",
    "message_metadata_name" : "",
    "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" : "",
    "floor_id" : 0,
    "floor_name" : "",
    "building_id" : 0,
    "building_name" : ""
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alerts?page=1&limit=10&startTime=1783272515873&endTime=1783358915873&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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Content-Length: 46
Host: api.extremecloudiq.com

{
  "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

[].message_metadata_name

String

The alert metadata name

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

[].floor_id

Number

Floor ID

[].floor_name

String

Floor name

[].building_id

Number

Building ID

[].building_name

String

Building name

[].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
RateLimit: "default";r=7085
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 1190

[ {
  "id" : "100abc",
  "owner_id" : 101,
  "timestamp" : "2026-07-06T17:28:35.000+0000",
  "org_id" : 100,
  "message_metadata_id" : 738783,
  "message_metadata_type" : "",
  "message_metadata_name" : "",
  "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" : "",
  "floor_id" : 0,
  "floor_name" : "",
  "building_id" : 0,
  "building_name" : ""
} ]

cURL Request

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

Count the alerts by group

GET /alerts/count-by-{group}

Path parameters

Table 75. /alerts/count-by-{group}
Parameter Description

group

The group of the alert

HTTP Request

GET /alerts/count-by-SEVERITY?startTime=1783272515473&endTime=1783358915473&acknowledged=true&siteId=999 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7096
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 72

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

cURL Request

$ curl 'https://api.extremecloudiq.com/alerts/count-by-SEVERITY?startTime=1783272515473&endTime=1783358915473&acknowledged=true&siteId=999' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json'

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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8
Content-Type: application/json
Host: api.extremecloudiq.com

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: "default";r=7078
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 3852

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

Get an alert policy

GET /alert-policies/{id}

Path Parameters

Table 76. /alert-policies/{id}
Parameter Description

id

The ID of the alert policy

HTTP Request

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

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
RateLimit: "default";r=7073
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 1739

{
  "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8
Content-Type: application/json
Content-Length: 63
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7076
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 1739

{
  "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Policy Name",
  "site_ids" : [ 3232323, 43434 ]
}'

Update an alert policy

PUT /alert-policies/{id}

Path Parameters

Table 77. /alert-policies/{id}
Parameter Description

id

The ID of the alert policy

HTTP Request

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

{
  "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
RateLimit: "default";r=7080
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 1739

{
  "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "PolicyName",
  "site_ids" : [ 3232323, 43434 ]
}'

Delete an alert policy

DELETE /alert-policies/{id}

Path Parameters

Table 78. /alert-policies/{id}
Parameter Description

id

The ID of the alert policy

HTTP Request

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

Response Body

HTTP Response

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

cURL Request

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

Update an alert rule

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

Path Parameters

Table 79. /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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8
Content-Type: application/json
Content-Length: 147
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7074
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 347

{
  "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8' \
    -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 80. /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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7079
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 347

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

Enable an alert rule

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

Path Parameters

Table 81. /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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7082
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 347

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

Disable an alert rule

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

Path Parameters

Table 82. /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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8
Content-Type: application/json
Host: api.extremecloudiq.com

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: "default";r=7077
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 348

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

List the available sites

GET /alert-policies/available-sites

Path Parameters

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

HTTP Request

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

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
RateLimit: "default";r=7081
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 54

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

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-policies/available-sites' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE0LCJleHAiOjE3ODM5NjM3MTR9.fW2AkSH5nf8Vph07qIRZa4KGvpO8VTxOTwKCgqqP0n0
Content-Type: application/json
Host: api.extremecloudiq.com

startTime=1783272514876&endTime=1783358914876&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
RateLimit: "default";r=7103
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 20

{
  "id" : 8734838
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alerts/reports' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE0LCJleHAiOjE3ODM5NjM3MTR9.fW2AkSH5nf8Vph07qIRZa4KGvpO8VTxOTwKCgqqP0n0' \
    -H 'Content-Type: application/json' \
    -d 'startTime=1783272514876&endTime=1783358914876&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 /ng-reports/download/reports/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE4LCJleHAiOjE3ODM5NjM3MTh9.xmeUI2tg4tFtsY-SXQoxDKacSqots2_Eh2BUmhOrmE0
Host: api.extremecloudiq.com

HTTP Response

HTTP/1.1 200 OK
RateLimit: "default";r=7043
Content-Type: application/octet-stream
Content-Disposition: attachment; filename=438086664193
Content-Length: 29
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

report-id-123,csv-data-sample

cURL Request

$ curl 'https://api.extremecloudiq.com/ng-reports/download/reports/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE4LCJleHAiOjE3ODM5NjM3MTh9.xmeUI2tg4tFtsY-SXQoxDKacSqots2_Eh2BUmhOrmE0'

Path Parameter

Table 84. /ng-reports/download/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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Content-Length: 111
Host: api.extremecloudiq.com

{
  "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: "default";r=7101
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 256

{
  "id" : 100,
  "create_time" : "2026-07-06T17:28:35.000+0000",
  "update_time" : "2026-07-06T17:28:35.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json' \
    -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 85. /alert-subscriptions/emails/{id}
Parameter Description

id

The email ID

HTTP Request

DELETE /alert-subscriptions/emails/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/emails/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Content-Length: 31
Host: api.extremecloudiq.com

{
  "ids" : [ 232323, 43434 ]
}

HTTP Response

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

{
  "result" : "SUCCESS"
}

cURL Request

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

Get an alert email subscription

GET /alert-subscriptions/emails/{id}

Path parameters

Table 86. /alert-subscriptions/emails/{id}
Parameter Description

id

The email ID

HTTP Request

GET /alert-subscriptions/emails/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Host: api.extremecloudiq.com

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: "default";r=7091
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 256

{
  "id" : 100,
  "create_time" : "2026-07-06T17:28:35.000+0000",
  "update_time" : "2026-07-06T17:28:35.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json'

List alert email subscriptions

GET /alert-subscriptions/emails

Response Body

[ {
  "id" : 100,
  "create_time" : "2026-07-06T17:28:35.000+0000",
  "update_time" : "2026-07-06T17:28:35.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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Host: api.extremecloudiq.com

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: "default";r=7086
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 259

[ {
  "id" : 100,
  "create_time" : "2026-07-06T17:28:35.000+0000",
  "update_time" : "2026-07-06T17:28:35.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json'

Update an alert email subscription

PUT /alert-subscriptions/emails/{id}

Path Parameters

Table 87. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Content-Length: 111
Host: api.extremecloudiq.com

{
  "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: "default";r=7094
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 256

{
  "id" : 100,
  "create_time" : "2026-07-06T17:28:35.000+0000",
  "update_time" : "2026-07-06T17:28:35.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json' \
    -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 88. /alert-subscriptions/emails/{id}/:verify
Parameter Description

id

The email ID

HTTP Request

POST /alert-subscriptions/emails/438086664193/:verify HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/emails/438086664193/:verify' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json'

Create an alert servicenow subscription

POST /alert-subscriptions/servicenow

Request Fields

Path Type Description

servicenow_account_email

String

The ServiceNow account email

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/servicenow HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Content-Length: 140
Host: api.extremecloudiq.com

{
  "servicenow_account_email" : "a@service-now.com",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
}

Response Fields

Path Type Description

id

Number

The email ID

servicenow_account_email

String

The ServiceNow account email

is_enabled

Boolean

Enable/disable alert notifications for an email

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: "default";r=7092
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 255

{
  "id" : 100,
  "create_time" : "2026-07-06T17:28:35.000+0000",
  "update_time" : "2026-07-06T17:28:35.000+0000",
  "servicenow_account_email" : "a@service-now.com",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 83834 ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/servicenow' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json' \
    -d '{
  "servicenow_account_email" : "a@service-now.com",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
}'

Bulk delete alert servicenow subscriptions

POST /alert-subscriptions/servicenow/:delete

Request Fields

Path Type Description

ids

Array

The servicenow email IDs list.

HTTP Request

POST /alert-subscriptions/servicenow/:delete?async=false HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Content-Length: 31
Host: api.extremecloudiq.com

{
  "ids" : [ 232323, 43434 ]
}

HTTP Response

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

{
  "result" : "SUCCESS"
}

cURL Request

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

Get an alert servicenow subscription

GET /alert-subscriptions/servicenow/{id}

Path parameters

Table 89. /alert-subscriptions/servicenow/{id}
Parameter Description

id

The servicenow email ID

HTTP Request

GET /alert-subscriptions/servicenow/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

id

Number

The servicenow endpoint ID

servicenow_account_email

String

The servicenow email address is

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: "default";r=7090
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 255

{
  "id" : 100,
  "create_time" : "2026-07-06T17:28:35.000+0000",
  "update_time" : "2026-07-06T17:28:35.000+0000",
  "servicenow_account_email" : "a@service-now.com",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 83834 ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/servicenow/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json'

List alert servicenow subscriptions

GET /alert-subscriptions/servicenow

Response Body

[ {
  "id" : 100,
  "create_time" : "2026-07-06T17:28:35.000+0000",
  "update_time" : "2026-07-06T17:28:35.000+0000",
  "servicenow_account_email" : "a@service-now.com",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 83834 ]
} ]

HTTP Request

GET /alert-subscriptions/servicenow HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

[].id

Number

The email ID

[].servicenow_account_email

String

The ServiceNow account email

[].is_enabled

Boolean

Enable/disable alert notifications for an email

[].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: "default";r=7096
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 259

[ {
  "id" : 100,
  "create_time" : "2026-07-06T17:28:35.000+0000",
  "update_time" : "2026-07-06T17:28:35.000+0000",
  "servicenow_account_email" : "a@service-now.com",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 83834 ]
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/servicenow' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json'

Update an alert servicenow subscription

PUT /alert-subscriptions/servicenow/{id}

Path Parameters

Table 90. /alert-subscriptions/servicenow/{id}
Parameter Description

id

The servicenow email ID

Request Fields

Path Type Description

servicenow_account_email

String

The ServiceNow account email

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/servicenow/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Content-Length: 140
Host: api.extremecloudiq.com

{
  "servicenow_account_email" : "a@service-now.com",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
}

Response Fields

Path Type Description

id

Number

The email ID

servicenow_account_email

String

The ServiceNow account email

is_enabled

Boolean

Enable/disable alert notifications for an email

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: "default";r=7088
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 255

{
  "id" : 100,
  "create_time" : "2026-07-06T17:28:35.000+0000",
  "update_time" : "2026-07-06T17:28:35.000+0000",
  "servicenow_account_email" : "a@service-now.com",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 83834 ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/servicenow/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json' \
    -d '{
  "servicenow_account_email" : "a@service-now.com",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
}'

Patch an alert servicenow subscription

PATCH /alert-subscriptions/servicenow/{id}

Path Parameters

Table 91. /alert-subscriptions/servicenow/{id}
Parameter Description

id

The servicenow email ID

Request Fields

Path Type Description

servicenow_account_email

String

The ServiceNow account email

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

PATCH /alert-subscriptions/servicenow/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Content-Length: 140
Host: api.extremecloudiq.com

{
  "servicenow_account_email" : "a@service-now.com",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
}

Response Fields

Path Type Description

id

Number

The email ID

servicenow_account_email

String

The ServiceNow account email

is_enabled

Boolean

Enable/disable alert notifications for an email

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: "default";r=7089
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 255

{
  "id" : 100,
  "create_time" : "2026-07-06T17:28:35.000+0000",
  "update_time" : "2026-07-06T17:28:35.000+0000",
  "servicenow_account_email" : "a@service-now.com",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 83834 ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/servicenow/438086664193' -i -X PATCH \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json' \
    -d '{
  "servicenow_account_email" : "a@service-now.com",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
}'

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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Content-Length: 133
Host: api.extremecloudiq.com

{
  "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: "default";r=7097
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 248

{
  "id" : 100,
  "create_time" : "2026-07-06T17:28:35.000+0000",
  "update_time" : "2026-07-06T17:28:35.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json' \
    -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 92. /alert-subscriptions/webhooks/{id}
Parameter Description

id

The webhook endpoint ID

HTTP Request

DELETE /alert-subscriptions/webhooks/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/webhooks/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json'

Delete an alert webhook subscription

DELETE /alert-subscriptions/webhooks/{id}

Path Parameters

Table 93. /alert-subscriptions/webhooks/{id}
Parameter Description

id

The webhook endpoint ID

HTTP Request

DELETE /alert-subscriptions/webhooks/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/webhooks/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json'

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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Content-Length: 30
Host: api.extremecloudiq.com

{
  "ids" : [ 232323, 2223 ]
}

HTTP Response

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

{
  "result" : "SUCCESS"
}

cURL Request

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

Get an alert webhook subscription

GET /alert-subscriptions/webhooks/{id}

Path parameters

Table 94. /alert-subscriptions/webhooks/{id}
Parameter Description

id

The webhook endpoint ID

HTTP Request

GET /alert-subscriptions/webhooks/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Host: api.extremecloudiq.com

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: "default";r=7093
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 248

{
  "id" : 100,
  "create_time" : "2026-07-06T17:28:35.000+0000",
  "update_time" : "2026-07-06T17:28:35.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json'

List the alert webhook subscriptions

GET /alert-subscriptions/webhooks

Response Body

[ {
  "id" : 100,
  "create_time" : "2026-07-06T17:28:35.000+0000",
  "update_time" : "2026-07-06T17:28:35.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Host: api.extremecloudiq.com

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: "default";r=7082
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 251

[ {
  "id" : 100,
  "create_time" : "2026-07-06T17:28:35.000+0000",
  "update_time" : "2026-07-06T17:28:35.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json'

Update an alert webhook subscription

PUT /alert-subscriptions/webhooks/{id}

Path Parameters

Table 95. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68
Content-Type: application/json
Content-Length: 133
Host: api.extremecloudiq.com

{
  "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: "default";r=7095
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 248

{
  "id" : 100,
  "create_time" : "2026-07-06T17:28:35.000+0000",
  "update_time" : "2026-07-06T17:28:35.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE1LCJleHAiOjE3ODM5NjM3MTV9.7xQFtJPBj0pY8ud8JgEtLyGYmUCuJsLstT5xfHCDL68' \
    -H 'Content-Type: application/json' \
    -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= HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE3LCJleHAiOjE3ODM5NjM3MTd9.LR6gbpuV76Q_KK17ayEhmX4B1jhOo2H7e19XBfuvYcM
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7068
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 9051

{
  "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=' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE3LCJleHAiOjE3ODM5NjM3MTd9.LR6gbpuV76Q_KK17ayEhmX4B1jhOo2H7e19XBfuvYcM' \
    -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 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE3LCJleHAiOjE3ODM5NjM3MTd9.LR6gbpuV76Q_KK17ayEhmX4B1jhOo2H7e19XBfuvYcM
Content-Type: application/json
Host: api.extremecloudiq.com

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

data[].full_description_id

Number

The audit log full description ID.

HTTP Response

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

{
  "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",
    "full_description_id" : 438086764364
  }, {
    "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",
    "full_description_id" : 438086764364
  }, {
    "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",
    "full_description_id" : 438086764364
  }, {
    "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",
    "full_description_id" : 438086764364
  }, {
    "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",
    "full_description_id" : 438086764364
  }, {
    "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",
    "full_description_id" : 438086764364
  }, {
    "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",
    "full_description_id" : 438086764364
  }, {
    "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",
    "full_description_id" : 438086764364
  }, {
    "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",
    "full_description_id" : 438086764364
  }, {
    "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",
    "full_description_id" : 438086764364
  } ]
}

cURL Request

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

Get audit log full descriptions

GET /logs/audit/full-descriptions/{id}

Path parameters

Table 96. /logs/audit/full-descriptions/{id}
Parameter Description

id

The audit log full description ID

HTTP Request

GET /logs/audit/full-descriptions/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE3LCJleHAiOjE3ODM5NjM3MTd9.LR6gbpuV76Q_KK17ayEhmX4B1jhOo2H7e19XBfuvYcM
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

id

Number

The audit log full description ID.

timestamp

Number

The full description timestamp.

device_id

Number

The device ID.

description

String

The audit log full description.

HTTP Response

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

{
  "id" : 438086764364,
  "timestamp" : 1711673250000,
  "device_id" : 438086764241,
  "description" : "Logged in with privileges of admin group Administrator"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/logs/audit/full-descriptions/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE3LCJleHAiOjE3ODM5NjM3MTd9.LR6gbpuV76Q_KK17ayEhmX4B1jhOo2H7e19XBfuvYcM' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE3LCJleHAiOjE3ODM5NjM3MTd9.LR6gbpuV76Q_KK17ayEhmX4B1jhOo2H7e19XBfuvYcM
Content-Type: application/json
Host: api.extremecloudiq.com

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: "default";r=7070
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 23

{
  "id" : 1783358917
}

cURL Request

$ curl 'https://api.extremecloudiq.com/logs/audit/reports' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE3LCJleHAiOjE3ODM5NjM3MTd9.LR6gbpuV76Q_KK17ayEhmX4B1jhOo2H7e19XBfuvYcM' \
    -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= HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7071
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 5490

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : "ZGaEAlw8aK9Cgb0u0NRO",
    "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" : "LbBLcrLIYhZAqiGyFGNs",
    "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" : "hNLMhc1Dir4vWNc6ysbf",
    "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" : "ZGgx3H7fw9LaMXE9VrJ6",
    "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" : "ymljIKQbecumuxX1ewjZ",
    "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" : "4SocdyGxYtEHiswuUT1N",
    "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" : "eRNTY1Bkn74d4aogSK6C",
    "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" : "VbhhjONw08LfHCfbwCw3",
    "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" : "Rmn94jdULeK7Y5eoD3Zx",
    "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" : "cyyf7e1BT5VuWVmln9G2",
    "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=' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8' \
    -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= HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE3LCJleHAiOjE3ODM5NjM3MTd9.LR6gbpuV76Q_KK17ayEhmX4B1jhOo2H7e19XBfuvYcM
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7071
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 1331

{
  "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=' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE3LCJleHAiOjE3ODM5NjM3MTd9.LR6gbpuV76Q_KK17ayEhmX4B1jhOo2H7e19XBfuvYcM' \
    -H 'Content-Type: application/json'

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= HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8
Content-Type: application/json
Host: api.extremecloudiq.com

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: "default";r=7072
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 2141

{
  "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=' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8' \
    -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= HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7073
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 2901

{
  "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=' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTE2LCJleHAiOjE3ODM5NjM3MTZ9.v_fDxHCsKnXoCehEopr8PKeyBOgC9MmLLVF0QoE4BX8' \
    -H 'Content-Type: application/json'

Notification

List webhook subscriptions

GET /subscriptions/webhook

HTTP Request

GET /subscriptions/webhook?page=1&limit=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTA5LCJleHAiOjE3ODM5NjM3MDl9.0OClutrJpqgJlGg4zurgOLx91gig2J7JunDPXC046tI
Content-Type: application/json
Host: api.extremecloudiq.com

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

data[].create_time

String

The create time.

data[].update_time

String

The update time.

data[].application

String

The external application name.

data[].url

String

The webhook endpoint URL.

data[].secret

String

The basic auth secret for the webhook endpoint.

data[].data_type

String

The subscription data type.

data[].message_type

String

The subscription message type.

data[].status

String

The subscription status.

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 3,
  "data" : [ {
    "id" : 1,
    "create_time" : "2026-07-06T17:28:29.000+0000",
    "update_time" : "2026-07-06T17:28:29.000+0000",
    "application" : "foo_0",
    "url" : "https://foo.com/hrqPB",
    "secret" : "2wdiHBbaWL",
    "data_type" : "LOCATION",
    "message_type" : "AUDIT_LOG_ALL",
    "status" : "ENABLED"
  }, {
    "id" : 2,
    "create_time" : "2026-07-06T17:28:29.000+0000",
    "update_time" : "2026-07-06T17:28:29.000+0000",
    "application" : "foo_1",
    "url" : "https://foo.com/tojJH",
    "secret" : "xqBf3Bn78p",
    "data_type" : "LOCATION",
    "message_type" : "AUDIT_LOG_ALL",
    "status" : "ENABLED"
  }, {
    "id" : 3,
    "create_time" : "2026-07-06T17:28:29.000+0000",
    "update_time" : "2026-07-06T17:28:29.000+0000",
    "application" : "foo_2",
    "url" : "https://foo.com/uirFF",
    "secret" : "oivNpaN5L5",
    "data_type" : "LOCATION",
    "message_type" : "AUDIT_LOG_ALL",
    "status" : "ENABLED"
  }, {
    "id" : 4,
    "create_time" : "2026-07-06T17:28:29.000+0000",
    "update_time" : "2026-07-06T17:28:29.000+0000",
    "application" : "foo_3",
    "url" : "https://foo.com/ISWzy",
    "secret" : "wcQN7zvwjS",
    "data_type" : "LOCATION",
    "message_type" : "AUDIT_LOG_ALL",
    "status" : "ENABLED"
  }, {
    "id" : 5,
    "create_time" : "2026-07-06T17:28:29.000+0000",
    "update_time" : "2026-07-06T17:28:29.000+0000",
    "application" : "foo_4",
    "url" : "https://foo.com/oJimN",
    "secret" : "UCXwFZfhnv",
    "data_type" : "LOCATION",
    "message_type" : "AUDIT_LOG_ALL",
    "status" : "ENABLED"
  }, {
    "id" : 6,
    "create_time" : "2026-07-06T17:28:29.000+0000",
    "update_time" : "2026-07-06T17:28:29.000+0000",
    "application" : "foo_5",
    "url" : "https://foo.com/MOUqm",
    "secret" : "LF80xSrZD3",
    "data_type" : "LOCATION",
    "message_type" : "AUDIT_LOG_ALL",
    "status" : "ENABLED"
  }, {
    "id" : 7,
    "create_time" : "2026-07-06T17:28:29.000+0000",
    "update_time" : "2026-07-06T17:28:29.000+0000",
    "application" : "foo_6",
    "url" : "https://foo.com/zSmEJ",
    "secret" : "0ep1iRONpA",
    "data_type" : "LOCATION",
    "message_type" : "AUDIT_LOG_ALL",
    "status" : "ENABLED"
  }, {
    "id" : 8,
    "create_time" : "2026-07-06T17:28:29.000+0000",
    "update_time" : "2026-07-06T17:28:29.000+0000",
    "application" : "foo_7",
    "url" : "https://foo.com/LgdMq",
    "secret" : "iuHvjTuuXS",
    "data_type" : "LOCATION",
    "message_type" : "AUDIT_LOG_ALL",
    "status" : "ENABLED"
  }, {
    "id" : 9,
    "create_time" : "2026-07-06T17:28:29.000+0000",
    "update_time" : "2026-07-06T17:28:29.000+0000",
    "application" : "foo_8",
    "url" : "https://foo.com/oLJBI",
    "secret" : "0asvHwVE4y",
    "data_type" : "LOCATION",
    "message_type" : "AUDIT_LOG_ALL",
    "status" : "ENABLED"
  }, {
    "id" : 10,
    "create_time" : "2026-07-06T17:28:29.000+0000",
    "update_time" : "2026-07-06T17:28:29.000+0000",
    "application" : "foo_9",
    "url" : "https://foo.com/meuUj",
    "secret" : "2uiWn7Vid3",
    "data_type" : "LOCATION",
    "message_type" : "AUDIT_LOG_ALL",
    "status" : "ENABLED"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/subscriptions/webhook?page=1&limit=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTA5LCJleHAiOjE3ODM5NjM3MDl9.0OClutrJpqgJlGg4zurgOLx91gig2J7JunDPXC046tI' \
    -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.

[].status

String

The subscription status.

HTTP Request

POST /subscriptions/webhook HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTA5LCJleHAiOjE3ODM5NjM3MDl9.0OClutrJpqgJlGg4zurgOLx91gig2J7JunDPXC046tI
Content-Length: 174
Host: api.extremecloudiq.com

[ {
  "application" : "Mock subscriber",
  "url" : "http://localhost:8080/api/auditlog",
  "secret" : "xxxxxx",
  "message_type" : "AUDIT_LOG_ALL",
  "status" : "ENABLED"
} ]

HTTP Response

HTTP/1.1 202 Accepted
RateLimit: "default";r=7202
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTA5LCJleHAiOjE3ODM5NjM3MDl9.0OClutrJpqgJlGg4zurgOLx91gig2J7JunDPXC046tI' \
    -d '[ {
  "application" : "Mock subscriber",
  "url" : "http://localhost:8080/api/auditlog",
  "secret" : "xxxxxx",
  "message_type" : "AUDIT_LOG_ALL",
  "status" : "ENABLED"
} ]'

Update webhook subscription

PUT /subscriptions/webhook

Path Parameters

Table 97. /subscriptions/webhook/{id}
Parameter Description

id

The webhook subscription ID

Request Fields

Path Type Description

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.

status

String

The subscription status.

HTTP Request

PUT /subscriptions/webhook/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTA5LCJleHAiOjE3ODM5NjM3MDl9.0OClutrJpqgJlGg4zurgOLx91gig2J7JunDPXC046tI
Content-Type: application/json
Content-Length: 170
Host: api.extremecloudiq.com

{
  "application" : "Mock subscriber",
  "url" : "http://localhost:8080/api/auditlog",
  "secret" : "xxxxxx",
  "message_type" : "AUDIT_LOG_ALL",
  "status" : "ENABLED"
}

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:29.000+0000",
  "update_time" : "2026-07-06T17:28:29.000+0000",
  "application" : "application",
  "url" : "http://localhost:8080/api/auditlog",
  "secret" : "secret",
  "data_type" : "AUDIT_LOG",
  "message_type" : "AUDIT_LOG_ALL",
  "status" : "ENABLED"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/subscriptions/webhook/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTA5LCJleHAiOjE3ODM5NjM3MDl9.0OClutrJpqgJlGg4zurgOLx91gig2J7JunDPXC046tI' \
    -H 'Content-Type: application/json' \
    -d '{
  "application" : "Mock subscriber",
  "url" : "http://localhost:8080/api/auditlog",
  "secret" : "xxxxxx",
  "message_type" : "AUDIT_LOG_ALL",
  "status" : "ENABLED"
}'

Delete webhook subscriptions

DELETE /subscriptions/webhook/:delete

Request Parameters

Parameter Description

ids

The Webhook Subscription IDs list.

HTTP Request

DELETE /subscriptions/webhook/:delete?ids=12345&ids=98764 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTA5LCJleHAiOjE3ODM5NjM3MDl9.0OClutrJpqgJlGg4zurgOLx91gig2J7JunDPXC046tI
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

HTTP/1.1 202 Accepted
RateLimit: "default";r=7201
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

cURL Request

$ curl 'https://api.extremecloudiq.com/subscriptions/webhook/:delete?ids=12345&ids=98764' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTA5LCJleHAiOjE3ODM5NjM3MDl9.0OClutrJpqgJlGg4zurgOLx91gig2J7JunDPXC046tI' \
    -H 'Content-Type: application/json'

Export webhook subscriptions

GET /subscriptions/webhook/export

Request Parameters

Parameter Description

order

The sort order for the subscriptions

keyword

Keyword to filter subscriptions

HTTP Request

GET /subscriptions/webhook/export?order=DESC&keyword=example HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTA5LCJleHAiOjE3ODM5NjM3MDl9.0OClutrJpqgJlGg4zurgOLx91gig2J7JunDPXC046tI
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

HTTP/1.1 200 OK
RateLimit: "default";r=7203
Content-Type: text/plain
Content-Disposition: attachment; filename=webhook_subscriptions.csv
Content-Length: 681
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

Post URL,Access Token,Created On,Status
https://foo.com/aOfbg,oNdl1TqUAk,2026-07-06 17:28:29.0,ENABLED
https://foo.com/ZzSGe,epT1miJ2zZ,2026-07-06 17:28:29.0,ENABLED
https://foo.com/pNvGq,CypQ6R4mBd,2026-07-06 17:28:29.0,ENABLED
https://foo.com/AQjjs,tgYouLT5Hy,2026-07-06 17:28:29.0,ENABLED
https://foo.com/pzzao,pVz1fZxTJd,2026-07-06 17:28:29.0,ENABLED
https://foo.com/RQIRr,xggHBdBKHG,2026-07-06 17:28:29.0,ENABLED
https://foo.com/gbJxu,llNZnvlb2T,2026-07-06 17:28:29.0,ENABLED
https://foo.com/zowfW,r4xYSSNSe3,2026-07-06 17:28:29.0,ENABLED
https://foo.com/DdfXd,KGosCRnpL5,2026-07-06 17:28:29.0,ENABLED
https://foo.com/uZyhV,IjC7v79hVC,2026-07-06 17:28:29.0,ENABLED

cURL Request

$ curl 'https://api.extremecloudiq.com/subscriptions/webhook/export?order=DESC&keyword=example' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4OTA5LCJleHAiOjE3ODM5NjM3MDl9.0OClutrJpqgJlGg4zurgOLx91gig2J7JunDPXC046tI' \
    -H 'Content-Type: application/json'

Administration

List API Access Tokens

GET /acct-api-token

Request Parameters

Parameter Description

page

Page number

limit

Page size

order

The sort order, such as DESC

keyword

The application name to filter

HTTP Request

GET /acct-api-token HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk0LCJleHAiOjE3ODM5NjM2OTR9.8i04sGG-a1qTm_qrM0X2POVajiyyTe24HijXsxJHxo8
Content-Type: application/json
Host: api.extremecloudiq.com

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 API access token ID

data[].application

String

The application name

data[].access_token

String

The access token

data[].generated_on

String

The timestamp at which token was generated

data[].refresh_token

String

The refresh token

data[].expiration

Number

The expiration in milliseconds

data[].grantor

String

The grantor name

data[].client_id

String

The client ID

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 3,
  "data" : [ {
    "id" : 0,
    "application" : "application",
    "access_token" : "accessToken",
    "grantor" : "grantor",
    "generated_on" : "2026-07-06T17:28:14.000+0000",
    "expiration" : 0,
    "refresh_token" : "refreshToken",
    "client_id" : "clientId"
  }, {
    "id" : 1,
    "application" : "application",
    "access_token" : "accessToken",
    "grantor" : "grantor",
    "generated_on" : "2026-07-06T17:28:14.000+0000",
    "expiration" : 0,
    "refresh_token" : "refreshToken",
    "client_id" : "clientId"
  }, {
    "id" : 2,
    "application" : "application",
    "access_token" : "accessToken",
    "grantor" : "grantor",
    "generated_on" : "2026-07-06T17:28:14.000+0000",
    "expiration" : 0,
    "refresh_token" : "refreshToken",
    "client_id" : "clientId"
  }, {
    "id" : 3,
    "application" : "application",
    "access_token" : "accessToken",
    "grantor" : "grantor",
    "generated_on" : "2026-07-06T17:28:14.000+0000",
    "expiration" : 0,
    "refresh_token" : "refreshToken",
    "client_id" : "clientId"
  }, {
    "id" : 4,
    "application" : "application",
    "access_token" : "accessToken",
    "grantor" : "grantor",
    "generated_on" : "2026-07-06T17:28:14.000+0000",
    "expiration" : 0,
    "refresh_token" : "refreshToken",
    "client_id" : "clientId"
  }, {
    "id" : 5,
    "application" : "application",
    "access_token" : "accessToken",
    "grantor" : "grantor",
    "generated_on" : "2026-07-06T17:28:14.000+0000",
    "expiration" : 0,
    "refresh_token" : "refreshToken",
    "client_id" : "clientId"
  }, {
    "id" : 6,
    "application" : "application",
    "access_token" : "accessToken",
    "grantor" : "grantor",
    "generated_on" : "2026-07-06T17:28:14.000+0000",
    "expiration" : 0,
    "refresh_token" : "refreshToken",
    "client_id" : "clientId"
  }, {
    "id" : 7,
    "application" : "application",
    "access_token" : "accessToken",
    "grantor" : "grantor",
    "generated_on" : "2026-07-06T17:28:14.000+0000",
    "expiration" : 0,
    "refresh_token" : "refreshToken",
    "client_id" : "clientId"
  }, {
    "id" : 8,
    "application" : "application",
    "access_token" : "accessToken",
    "grantor" : "grantor",
    "generated_on" : "2026-07-06T17:28:14.000+0000",
    "expiration" : 0,
    "refresh_token" : "refreshToken",
    "client_id" : "clientId"
  }, {
    "id" : 9,
    "application" : "application",
    "access_token" : "accessToken",
    "grantor" : "grantor",
    "generated_on" : "2026-07-06T17:28:14.000+0000",
    "expiration" : 0,
    "refresh_token" : "refreshToken",
    "client_id" : "clientId"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/acct-api-token' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk0LCJleHAiOjE3ODM5NjM2OTR9.8i04sGG-a1qTm_qrM0X2POVajiyyTe24HijXsxJHxo8' \
    -H 'Content-Type: application/json'

Create API Access Tokens

POST /acct-api-token

Request Parameters

Parameter Description

clientId

The client ID

tokenExpireInDay

The number of days in which token will expire

HTTP Request

POST /acct-api-token HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk0LCJleHAiOjE3ODM5NjM2OTR9.8i04sGG-a1qTm_qrM0X2POVajiyyTe24HijXsxJHxo8
Content-Type: application/json
Host: api.extremecloudiq.com

clientId=d68daddc&tokenExpireInDay=10

HTTP Response Fields

Path Type Description

owner_id

Number

The owner ID

vhm_id

String

The VHM ID

vpc_url

String

The VPC URL

access_token

String

The access token

expiration

Number

The millisecond value at which token expires

refresh_token

String

The refresh Token

HTTP Response

HTTP/1.1 201 Created
RateLimit: "default";r=7204
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 158

{
  "owner_id" : 102,
  "vhm_id" : "vhmId",
  "vpc_url" : "string",
  "access_token" : "accessToken",
  "expiration" : 0,
  "refresh_token" : "refreshToken"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/acct-api-token' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk0LCJleHAiOjE3ODM5NjM2OTR9.8i04sGG-a1qTm_qrM0X2POVajiyyTe24HijXsxJHxo8' \
    -H 'Content-Type: application/json' \
    -d 'clientId=d68daddc&tokenExpireInDay=10'

Update API Access Tokens

PATCH /acct-api-token/{id}

Path Parameters

Table 98. /acct-api-token/{id}
Parameter Description

id

The API Access Token ID

Request Body

{
  "token_expire_in_day" : 1
}

HTTP Request

PATCH /acct-api-token/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk0LCJleHAiOjE3ODM5NjM2OTR9.8i04sGG-a1qTm_qrM0X2POVajiyyTe24HijXsxJHxo8
Content-Type: application/json
Content-Length: 31
Host: api.extremecloudiq.com

{
  "token_expire_in_day" : 1
}

Response Fields

Path Type Description

id

Number

The API access token ID

application

String

The application name

access_token

String

The access token

generated_on

String

The timestamp at which token was generated

refresh_token

String

The refresh token

expiration

Number

The expiration in milliseconds

grantor

String

The expiration in milliseconds

client_id

String

The client ID

HTTP Response

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

{
  "id" : 0,
  "application" : "application",
  "access_token" : "accessToken",
  "grantor" : "grantor",
  "generated_on" : "2026-07-06T17:28:14.000+0000",
  "expiration" : 0,
  "refresh_token" : "refreshToken",
  "client_id" : "clientId"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/acct-api-token/438086664193' -i -X PATCH \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk0LCJleHAiOjE3ODM5NjM2OTR9.8i04sGG-a1qTm_qrM0X2POVajiyyTe24HijXsxJHxo8' \
    -H 'Content-Type: application/json' \
    -d '{
  "token_expire_in_day" : 1
}'

Export all API Access Tokens

GET /acct-api-token

Request Parameters

Parameter Description

order

The sort order for the api access tokens

keyword

Keyword to filter api access tokens

sortField

Field to sort API access tokens

HTTP Request

GET /acct-api-token/export?order=DESC&keyword=example&sortField=GRANTOR HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk0LCJleHAiOjE3ODM5NjM2OTR9.8i04sGG-a1qTm_qrM0X2POVajiyyTe24HijXsxJHxo8
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Application,Access Token,Grantor,Generated On,Expiration,Refresh Token
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken

HTTP Response

HTTP/1.1 200 OK
RateLimit: "default";r=7202
Content-Type: text/plain
Content-Disposition: attachment; filename=access_tokens.csv
Content-Length: 932
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

Application,Access Token,Grantor,Generated On,Expiration,Refresh Token
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken
application,accessToken,grantor,2026-07-06 17:28:14,1970-01-01 00:00:00,refreshToken

cURL Request

$ curl 'https://api.extremecloudiq.com/acct-api-token/export?order=DESC&keyword=example&sortField=GRANTOR' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk0LCJleHAiOjE3ODM5NjM2OTR9.8i04sGG-a1qTm_qrM0X2POVajiyyTe24HijXsxJHxo8' \
    -H 'Content-Type: application/json'

Delete API Access Tokens

DELETE /acct-api-token/:delete

Request Parameters

Table 99. /acct-api-token/{id}
Parameter Description

id

The API access token ID

HTTP Request

DELETE /acct-api-token/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk0LCJleHAiOjE3ODM5NjM2OTR9.8i04sGG-a1qTm_qrM0X2POVajiyyTe24HijXsxJHxo8
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/acct-api-token/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk0LCJleHAiOjE3ODM5NjM2OTR9.8i04sGG-a1qTm_qrM0X2POVajiyyTe24HijXsxJHxo8' \
    -H 'Content-Type: application/json'

List Credential Distribution Groups

GET /credential-distribution-groups

Request Parameters

Parameter Description

page

Page number

limit

Page size

order

The sort order, such as DESC

keyword

The application name to filter

HTTP Request

GET /credential-distribution-groups HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODkxLCJleHAiOjE3ODM5NjM2OTF9.mzPj6at82468OUIWN0n2bMIqntOmAxifvRmMJqWm3MU
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The Credential Distribution Group ID. Assigned by the server.

data[].create_time

String

The timestamp when the Credential Distribution Group was created. Assigned by the server.

data[].update_time

String

The timestamp when the Credential Distribution Group was updated. Assigned by the server.

data[].org_id

Number

The Organization ID.

data[].owner_id

Number

The owner ID.

data[].group_type

String

The Group type.

data[].enable_email_approval

Boolean

Whether email approval is enabled.

data[].enable_user_limitation

Boolean

Whether user limitation is enabled.

data[].employee_group_type

String

The Employee group type.

data[].employee_groups[].name

String

The name of the Employee Group.

data[].employee_groups[].id

Number

The id of the Employee Group.

data[].name

String

The name of the Credential Distribution Group.

data[].restrict_number

String

Restriction on number of credentials per employee.

data[].user_groups[].id

Number

The User Group ID. Assigned by the server.

data[].user_groups[].create_time

String

The timestamp when the User Group was created. Assigned by the server.

data[].user_groups[].update_time

String

The timestamp when the User Group was updated. Assigned by the server.

data[].user_groups[].org_id

Number

The Organization ID.

data[].user_groups[].owner_id

Number

The owner ID of the User Group.

data[].user_groups[].name

String

The name of the User Group.

data[].user_groups[].json_type

String

The JSON type of the User Group.

data[].user_groups[].description

String

The description of the User Group.

data[].user_groups[].password_rule_settings_id

Number

The password rule settings ID.

data[].user_groups[].delivery_policy_settings_id

Number

The delivery policy settings ID.

data[].user_groups[].time_expiration_settings_id

Number

The time expiration settings ID.

data[].user_groups[].user_count

Number

The count of users in the group.

data[].user_groups[].ssids

Array

The list of SSIDs.

data[].user_groups[].group_type

String

The group type.

data[].user_groups[].pcg_use_only

Boolean

Whether PCG use only is enabled.

data[].user_groups[].ppsk_use_only

Boolean

Whether PPSK use only is enabled.

data[].user_groups[].enable_pcg_filter

Boolean

Whether PCG filter is enabled.

data[].user_groups[].enable_self_reg

Boolean

Whether self-registration is enabled.

data[].user_groups[].enable_renew

Boolean

Whether renew is enabled.

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 3,
  "data" : [ {
    "id" : 0,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.000+0000",
    "org_id" : 100,
    "owner_id" : 102,
    "group_type" : "groupType",
    "enable_email_approval" : true,
    "enable_user_limitation" : false,
    "employee_group_type" : "AD",
    "employee_groups" : [ {
      "name" : "EmployeeGroup0",
      "id" : 0
    } ],
    "name" : "CredentialDistributionGroup0",
    "restrict_number" : "10",
    "user_groups" : [ {
      "id" : 0,
      "create_time" : "2026-07-06T17:28:11.000+0000",
      "update_time" : "2026-07-06T17:28:11.000+0000",
      "org_id" : 100,
      "owner_id" : 102,
      "name" : "UserGroup0",
      "json_type" : "jsonType",
      "description" : "Description",
      "password_rule_settings_id" : 1,
      "delivery_policy_settings_id" : 1,
      "time_expiration_settings_id" : 1,
      "user_count" : 10,
      "ssids" : [ "SSID1", "SSID2" ],
      "group_type" : "groupType",
      "pcg_use_only" : false,
      "ppsk_use_only" : true,
      "enable_pcg_filter" : false,
      "enable_self_reg" : true,
      "enable_renew" : false
    } ]
  }, {
    "id" : 1,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.000+0000",
    "org_id" : 100,
    "owner_id" : 102,
    "group_type" : "groupType",
    "enable_email_approval" : true,
    "enable_user_limitation" : false,
    "employee_group_type" : "AD",
    "employee_groups" : [ {
      "name" : "EmployeeGroup1",
      "id" : 1
    } ],
    "name" : "CredentialDistributionGroup1",
    "restrict_number" : "10",
    "user_groups" : [ {
      "id" : 1,
      "create_time" : "2026-07-06T17:28:11.000+0000",
      "update_time" : "2026-07-06T17:28:11.000+0000",
      "org_id" : 100,
      "owner_id" : 102,
      "name" : "UserGroup1",
      "json_type" : "jsonType",
      "description" : "Description",
      "password_rule_settings_id" : 1,
      "delivery_policy_settings_id" : 1,
      "time_expiration_settings_id" : 1,
      "user_count" : 10,
      "ssids" : [ "SSID1", "SSID2" ],
      "group_type" : "groupType",
      "pcg_use_only" : false,
      "ppsk_use_only" : true,
      "enable_pcg_filter" : false,
      "enable_self_reg" : true,
      "enable_renew" : false
    } ]
  }, {
    "id" : 2,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.000+0000",
    "org_id" : 100,
    "owner_id" : 102,
    "group_type" : "groupType",
    "enable_email_approval" : true,
    "enable_user_limitation" : false,
    "employee_group_type" : "AD",
    "employee_groups" : [ {
      "name" : "EmployeeGroup2",
      "id" : 2
    } ],
    "name" : "CredentialDistributionGroup2",
    "restrict_number" : "10",
    "user_groups" : [ {
      "id" : 2,
      "create_time" : "2026-07-06T17:28:11.000+0000",
      "update_time" : "2026-07-06T17:28:11.000+0000",
      "org_id" : 100,
      "owner_id" : 102,
      "name" : "UserGroup2",
      "json_type" : "jsonType",
      "description" : "Description",
      "password_rule_settings_id" : 1,
      "delivery_policy_settings_id" : 1,
      "time_expiration_settings_id" : 1,
      "user_count" : 10,
      "ssids" : [ "SSID1", "SSID2" ],
      "group_type" : "groupType",
      "pcg_use_only" : false,
      "ppsk_use_only" : true,
      "enable_pcg_filter" : false,
      "enable_self_reg" : true,
      "enable_renew" : false
    } ]
  }, {
    "id" : 3,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.000+0000",
    "org_id" : 100,
    "owner_id" : 102,
    "group_type" : "groupType",
    "enable_email_approval" : true,
    "enable_user_limitation" : false,
    "employee_group_type" : "AD",
    "employee_groups" : [ {
      "name" : "EmployeeGroup3",
      "id" : 3
    } ],
    "name" : "CredentialDistributionGroup3",
    "restrict_number" : "10",
    "user_groups" : [ {
      "id" : 3,
      "create_time" : "2026-07-06T17:28:11.000+0000",
      "update_time" : "2026-07-06T17:28:11.000+0000",
      "org_id" : 100,
      "owner_id" : 102,
      "name" : "UserGroup3",
      "json_type" : "jsonType",
      "description" : "Description",
      "password_rule_settings_id" : 1,
      "delivery_policy_settings_id" : 1,
      "time_expiration_settings_id" : 1,
      "user_count" : 10,
      "ssids" : [ "SSID1", "SSID2" ],
      "group_type" : "groupType",
      "pcg_use_only" : false,
      "ppsk_use_only" : true,
      "enable_pcg_filter" : false,
      "enable_self_reg" : true,
      "enable_renew" : false
    } ]
  }, {
    "id" : 4,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.000+0000",
    "org_id" : 100,
    "owner_id" : 102,
    "group_type" : "groupType",
    "enable_email_approval" : true,
    "enable_user_limitation" : false,
    "employee_group_type" : "AD",
    "employee_groups" : [ {
      "name" : "EmployeeGroup4",
      "id" : 4
    } ],
    "name" : "CredentialDistributionGroup4",
    "restrict_number" : "10",
    "user_groups" : [ {
      "id" : 4,
      "create_time" : "2026-07-06T17:28:11.000+0000",
      "update_time" : "2026-07-06T17:28:11.000+0000",
      "org_id" : 100,
      "owner_id" : 102,
      "name" : "UserGroup4",
      "json_type" : "jsonType",
      "description" : "Description",
      "password_rule_settings_id" : 1,
      "delivery_policy_settings_id" : 1,
      "time_expiration_settings_id" : 1,
      "user_count" : 10,
      "ssids" : [ "SSID1", "SSID2" ],
      "group_type" : "groupType",
      "pcg_use_only" : false,
      "ppsk_use_only" : true,
      "enable_pcg_filter" : false,
      "enable_self_reg" : true,
      "enable_renew" : false
    } ]
  }, {
    "id" : 5,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.000+0000",
    "org_id" : 100,
    "owner_id" : 102,
    "group_type" : "groupType",
    "enable_email_approval" : true,
    "enable_user_limitation" : false,
    "employee_group_type" : "AD",
    "employee_groups" : [ {
      "name" : "EmployeeGroup5",
      "id" : 5
    } ],
    "name" : "CredentialDistributionGroup5",
    "restrict_number" : "10",
    "user_groups" : [ {
      "id" : 5,
      "create_time" : "2026-07-06T17:28:11.000+0000",
      "update_time" : "2026-07-06T17:28:11.000+0000",
      "org_id" : 100,
      "owner_id" : 102,
      "name" : "UserGroup5",
      "json_type" : "jsonType",
      "description" : "Description",
      "password_rule_settings_id" : 1,
      "delivery_policy_settings_id" : 1,
      "time_expiration_settings_id" : 1,
      "user_count" : 10,
      "ssids" : [ "SSID1", "SSID2" ],
      "group_type" : "groupType",
      "pcg_use_only" : false,
      "ppsk_use_only" : true,
      "enable_pcg_filter" : false,
      "enable_self_reg" : true,
      "enable_renew" : false
    } ]
  }, {
    "id" : 6,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.000+0000",
    "org_id" : 100,
    "owner_id" : 102,
    "group_type" : "groupType",
    "enable_email_approval" : true,
    "enable_user_limitation" : false,
    "employee_group_type" : "AD",
    "employee_groups" : [ {
      "name" : "EmployeeGroup6",
      "id" : 6
    } ],
    "name" : "CredentialDistributionGroup6",
    "restrict_number" : "10",
    "user_groups" : [ {
      "id" : 6,
      "create_time" : "2026-07-06T17:28:11.000+0000",
      "update_time" : "2026-07-06T17:28:11.000+0000",
      "org_id" : 100,
      "owner_id" : 102,
      "name" : "UserGroup6",
      "json_type" : "jsonType",
      "description" : "Description",
      "password_rule_settings_id" : 1,
      "delivery_policy_settings_id" : 1,
      "time_expiration_settings_id" : 1,
      "user_count" : 10,
      "ssids" : [ "SSID1", "SSID2" ],
      "group_type" : "groupType",
      "pcg_use_only" : false,
      "ppsk_use_only" : true,
      "enable_pcg_filter" : false,
      "enable_self_reg" : true,
      "enable_renew" : false
    } ]
  }, {
    "id" : 7,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.000+0000",
    "org_id" : 100,
    "owner_id" : 102,
    "group_type" : "groupType",
    "enable_email_approval" : true,
    "enable_user_limitation" : false,
    "employee_group_type" : "AD",
    "employee_groups" : [ {
      "name" : "EmployeeGroup7",
      "id" : 7
    } ],
    "name" : "CredentialDistributionGroup7",
    "restrict_number" : "10",
    "user_groups" : [ {
      "id" : 7,
      "create_time" : "2026-07-06T17:28:11.000+0000",
      "update_time" : "2026-07-06T17:28:11.000+0000",
      "org_id" : 100,
      "owner_id" : 102,
      "name" : "UserGroup7",
      "json_type" : "jsonType",
      "description" : "Description",
      "password_rule_settings_id" : 1,
      "delivery_policy_settings_id" : 1,
      "time_expiration_settings_id" : 1,
      "user_count" : 10,
      "ssids" : [ "SSID1", "SSID2" ],
      "group_type" : "groupType",
      "pcg_use_only" : false,
      "ppsk_use_only" : true,
      "enable_pcg_filter" : false,
      "enable_self_reg" : true,
      "enable_renew" : false
    } ]
  }, {
    "id" : 8,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.000+0000",
    "org_id" : 100,
    "owner_id" : 102,
    "group_type" : "groupType",
    "enable_email_approval" : true,
    "enable_user_limitation" : false,
    "employee_group_type" : "AD",
    "employee_groups" : [ {
      "name" : "EmployeeGroup8",
      "id" : 8
    } ],
    "name" : "CredentialDistributionGroup8",
    "restrict_number" : "10",
    "user_groups" : [ {
      "id" : 8,
      "create_time" : "2026-07-06T17:28:11.000+0000",
      "update_time" : "2026-07-06T17:28:11.000+0000",
      "org_id" : 100,
      "owner_id" : 102,
      "name" : "UserGroup8",
      "json_type" : "jsonType",
      "description" : "Description",
      "password_rule_settings_id" : 1,
      "delivery_policy_settings_id" : 1,
      "time_expiration_settings_id" : 1,
      "user_count" : 10,
      "ssids" : [ "SSID1", "SSID2" ],
      "group_type" : "groupType",
      "pcg_use_only" : false,
      "ppsk_use_only" : true,
      "enable_pcg_filter" : false,
      "enable_self_reg" : true,
      "enable_renew" : false
    } ]
  }, {
    "id" : 9,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.000+0000",
    "org_id" : 100,
    "owner_id" : 102,
    "group_type" : "groupType",
    "enable_email_approval" : true,
    "enable_user_limitation" : false,
    "employee_group_type" : "AD",
    "employee_groups" : [ {
      "name" : "EmployeeGroup9",
      "id" : 9
    } ],
    "name" : "CredentialDistributionGroup9",
    "restrict_number" : "10",
    "user_groups" : [ {
      "id" : 9,
      "create_time" : "2026-07-06T17:28:11.000+0000",
      "update_time" : "2026-07-06T17:28:11.000+0000",
      "org_id" : 100,
      "owner_id" : 102,
      "name" : "UserGroup9",
      "json_type" : "jsonType",
      "description" : "Description",
      "password_rule_settings_id" : 1,
      "delivery_policy_settings_id" : 1,
      "time_expiration_settings_id" : 1,
      "user_count" : 10,
      "ssids" : [ "SSID1", "SSID2" ],
      "group_type" : "groupType",
      "pcg_use_only" : false,
      "ppsk_use_only" : true,
      "enable_pcg_filter" : false,
      "enable_self_reg" : true,
      "enable_renew" : false
    } ]
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/credential-distribution-groups' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODkxLCJleHAiOjE3ODM5NjM2OTF9.mzPj6at82468OUIWN0n2bMIqntOmAxifvRmMJqWm3MU' \
    -H 'Content-Type: application/json'

Create Credential Distribution Groups

POST /credential-distribution-groups

Request Headers

Name Description

Content-Type

The Content-Type of the payload, e.g. application/json

Authorization

API auth credentials

HTTP Request

POST /credential-distribution-groups HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODkxLCJleHAiOjE3ODM5NjM2OTF9.mzPj6at82468OUIWN0n2bMIqntOmAxifvRmMJqWm3MU
Content-Type: application/json
Content-Length: 220
Host: api.extremecloudiq.com

{
  "name" : "Sample Credential Distribution Group name",
  "enable_email_approval" : true,
  "enable_user_limitation" : false,
  "employee_group_type" : "AD",
  "restrict_number" : 10,
  "user_group_ids" : [ 1, 2, 3 ]
}

HTTP Response Fields

Path Type Description

id

Number

The Credential Distribution Group ID. Assigned by the server.

create_time

String

The timestamp when the Credential Distribution Group was created. Assigned by the server.

update_time

String

The timestamp when the Credential Distribution Group was updated. Assigned by the server.

org_id

Number

The Organization ID.

owner_id

Number

The owner ID.

group_type

String

The Group type.

enable_email_approval

Boolean

Whether email approval is enabled.

enable_user_limitation

Boolean

Whether user limitation is enabled.

employee_group_type

String

The Employee group type.

employee_groups[].name

String

The name of the Employee Group.

name

String

The name of the Credential Distribution Group.

restrict_number

String

Restriction on number of credentials per employee.

user_groups[].id

Number

The User Group ID. Assigned by the server.

user_groups[].create_time

String

The timestamp when the User Group was created. Assigned by the server.

user_groups[].update_time

String

The timestamp when the User Group was updated. Assigned by the server.

user_groups[].org_id

Number

The Organization ID.

user_groups[].owner_id

Number

The owner ID of the User Group.

user_groups[].name

String

The name of the User Group.

user_groups[].json_type

String

The JSON type of the User Group.

user_groups[].description

String

The description of the User Group.

user_groups[].password_rule_settings_id

Number

The password rule settings ID.

user_groups[].delivery_policy_settings_id

Number

The delivery policy settings ID.

user_groups[].time_expiration_settings_id

Number

The time expiration settings ID.

user_groups[].user_count

Number

The count of users in the group.

user_groups[].ssids

Array

The list of SSIDs.

user_groups[].group_type

String

The group type.

user_groups[].pcg_use_only

Boolean

Whether PCG use only is enabled.

user_groups[].ppsk_use_only

Boolean

Whether PPSK use only is enabled.

user_groups[].enable_pcg_filter

Boolean

Whether PCG filter is enabled.

user_groups[].enable_self_reg

Boolean

Whether self-registration is enabled.

user_groups[].enable_renew

Boolean

Whether renew is enabled.

HTTP Response

HTTP/1.1 201 Created
RateLimit: "default";r=7205
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 1051

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:11.000+0000",
  "update_time" : "2026-07-06T17:28:11.000+0000",
  "org_id" : 100,
  "owner_id" : 102,
  "group_type" : "groupType",
  "enable_email_approval" : true,
  "enable_user_limitation" : false,
  "employee_group_type" : "AD",
  "employee_groups" : [ {
    "name" : "EmployeeGroup1"
  } ],
  "name" : "CredentialDistributionGroup1",
  "restrict_number" : "10",
  "user_groups" : [ {
    "id" : 1,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.000+0000",
    "org_id" : 100,
    "owner_id" : 102,
    "name" : "UserGroup1",
    "json_type" : "jsonType",
    "description" : "Description",
    "password_rule_settings_id" : 1,
    "delivery_policy_settings_id" : 1,
    "time_expiration_settings_id" : 1,
    "user_count" : 10,
    "ssids" : [ "SSID1", "SSID2" ],
    "group_type" : "groupType",
    "pcg_use_only" : false,
    "ppsk_use_only" : true,
    "enable_pcg_filter" : false,
    "enable_self_reg" : true,
    "enable_renew" : false
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/credential-distribution-groups' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODkxLCJleHAiOjE3ODM5NjM2OTF9.mzPj6at82468OUIWN0n2bMIqntOmAxifvRmMJqWm3MU' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Sample Credential Distribution Group name",
  "enable_email_approval" : true,
  "enable_user_limitation" : false,
  "employee_group_type" : "AD",
  "restrict_number" : 10,
  "user_group_ids" : [ 1, 2, 3 ]
}'

Update Credential Distribution Groups

PUT /credential-distribution-groups

Request Headers

Name Description

Content-Type

The Content-Type of the payload, e.g. application/json

Authorization

API auth credentials

HTTP Request

PUT /credential-distribution-groups/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODkxLCJleHAiOjE3ODM5NjM2OTF9.mzPj6at82468OUIWN0n2bMIqntOmAxifvRmMJqWm3MU
Content-Type: application/json
Content-Length: 215
Host: api.extremecloudiq.com

{
  "name" : "Sample Credential Distribution Group",
  "enable_email_approval" : true,
  "enable_user_limitation" : false,
  "employee_group_type" : "AD",
  "restrict_number" : 10,
  "user_group_ids" : [ 1, 2, 3 ]
}

HTTP Response Fields

Path Type Description

id

Number

The Credential Distribution Group ID. Assigned by the server.

create_time

String

The timestamp when the Credential Distribution Group was created. Assigned by the server.

update_time

String

The timestamp when the Credential Distribution Group was updated. Assigned by the server.

org_id

Number

The Organization ID.

owner_id

Number

The owner ID.

group_type

String

The Group type.

enable_email_approval

Boolean

Whether email approval is enabled.

enable_user_limitation

Boolean

Whether user limitation is enabled.

employee_group_type

String

The Employee group type.

employee_groups[].name

String

The name of the Employee Group.

employee_groups[].id

Number

The id of the Employee Group.

name

String

The name of the Credential Distribution Group.

restrict_number

String

Restriction on number of credentials per employee.

user_groups[].id

Number

The User Group ID. Assigned by the server.

user_groups[].create_time

String

The timestamp when the User Group was created. Assigned by the server.

user_groups[].update_time

String

The timestamp when the User Group was updated. Assigned by the server.

user_groups[].org_id

Number

The Organization ID.

user_groups[].owner_id

Number

The owner ID of the User Group.

user_groups[].name

String

The name of the User Group.

user_groups[].json_type

String

The JSON type of the User Group.

user_groups[].description

String

The description of the User Group.

user_groups[].password_rule_settings_id

Number

The password rule settings ID.

user_groups[].delivery_policy_settings_id

Number

The delivery policy settings ID.

user_groups[].time_expiration_settings_id

Number

The time expiration settings ID.

user_groups[].user_count

Number

The count of users in the group.

user_groups[].ssids

Array

The list of SSIDs.

user_groups[].group_type

String

The group type.

user_groups[].pcg_use_only

Boolean

Whether PCG use only is enabled.

user_groups[].ppsk_use_only

Boolean

Whether PPSK use only is enabled.

user_groups[].enable_pcg_filter

Boolean

Whether PCG filter is enabled.

user_groups[].enable_self_reg

Boolean

Whether self-registration is enabled.

user_groups[].enable_renew

Boolean

Whether renew is enabled.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:28:11.000+0000",
  "update_time" : "2026-07-06T17:28:11.000+0000",
  "org_id" : 100,
  "owner_id" : 102,
  "group_type" : "groupType",
  "enable_email_approval" : true,
  "enable_user_limitation" : false,
  "employee_group_type" : "AD",
  "employee_groups" : [ {
    "name" : "EmployeeGroup1",
    "id" : 1
  } ],
  "name" : "CredentialDistributionGroup1",
  "restrict_number" : "10",
  "user_groups" : [ {
    "id" : 1,
    "create_time" : "2026-07-06T17:28:11.000+0000",
    "update_time" : "2026-07-06T17:28:11.000+0000",
    "org_id" : 100,
    "owner_id" : 102,
    "name" : "UserGroup1",
    "json_type" : "jsonType",
    "description" : "Description",
    "password_rule_settings_id" : 1,
    "delivery_policy_settings_id" : 1,
    "time_expiration_settings_id" : 1,
    "user_count" : 10,
    "ssids" : [ "SSID1", "SSID2" ],
    "group_type" : "groupType",
    "pcg_use_only" : false,
    "ppsk_use_only" : true,
    "enable_pcg_filter" : false,
    "enable_self_reg" : true,
    "enable_renew" : false
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/credential-distribution-groups/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODkxLCJleHAiOjE3ODM5NjM2OTF9.mzPj6at82468OUIWN0n2bMIqntOmAxifvRmMJqWm3MU' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Sample Credential Distribution Group",
  "enable_email_approval" : true,
  "enable_user_limitation" : false,
  "employee_group_type" : "AD",
  "restrict_number" : 10,
  "user_group_ids" : [ 1, 2, 3 ]
}'

Delete Credential Distribution Groups

DELETE /credential-distribution-groups

Request Parameters

Parameter Description

ids

The Credential Distribution Group ids list.

HTTP Request

DELETE /credential-distribution-groups?ids=232323&ids=43434 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODkxLCJleHAiOjE3ODM5NjM2OTF9.mzPj6at82468OUIWN0n2bMIqntOmAxifvRmMJqWm3MU
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/credential-distribution-groups?ids=232323&ids=43434' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODkxLCJleHAiOjE3ODM5NjM2OTF9.mzPj6at82468OUIWN0n2bMIqntOmAxifvRmMJqWm3MU' \
    -H 'Content-Type: application/json'

List third party api connection

GET /third-party-api-connection

HTTP Request

GET /third-party-api-connection HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk2LCJleHAiOjE3ODM5NjM2OTZ9.c4EHmvUyLpYw7vLEUmgKwZCv26v1RngLakPkcLE6rxg
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

[].api_token

String

The third party api token.

[].created_at

Number

The third party api token created time.

HTTP Response

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

[ {
  "api_token" : "extreme",
  "created_at" : 1718769933
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/third-party-api-connection' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk2LCJleHAiOjE3ODM5NjM2OTZ9.c4EHmvUyLpYw7vLEUmgKwZCv26v1RngLakPkcLE6rxg' \
    -H 'Content-Type: application/json'

Update third party api connection

PUT /third-party-api-connection

HTTP Request

PUT /third-party-api-connection HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk2LCJleHAiOjE3ODM5NjM2OTZ9.c4EHmvUyLpYw7vLEUmgKwZCv26v1RngLakPkcLE6rxg
Content-Type: application/json
Content-Length: 29
Host: api.extremecloudiq.com

{
  "api_token" : "extreme"
}

Response Fields

Path Type Description

api_token

String

The third party api token

created_at

Number

The third party api token created time

HTTP Response

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

{
  "api_token" : "extreme",
  "created_at" : 1718769933
}

cURL Request

$ curl 'https://api.extremecloudiq.com/third-party-api-connection' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk2LCJleHAiOjE3ODM5NjM2OTZ9.c4EHmvUyLpYw7vLEUmgKwZCv26v1RngLakPkcLE6rxg' \
    -H 'Content-Type: application/json' \
    -d '{
  "api_token" : "extreme"
}'

Delete third party api connection

DELETE /third-party-api-connection

HTTP Request

DELETE /third-party-api-connection HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk2LCJleHAiOjE3ODM5NjM2OTZ9.c4EHmvUyLpYw7vLEUmgKwZCv26v1RngLakPkcLE6rxg
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/third-party-api-connection' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODk2LCJleHAiOjE3ODM5NjM2OTZ9.c4EHmvUyLpYw7vLEUmgKwZCv26v1RngLakPkcLE6rxg' \
    -H 'Content-Type: application/json'

Configuration - Deployment

Push configuration and upgrade firmware to devices

POST /deployments

Request Parameters

Parameter Description

async

Whether running this request as async or not. This parameter is not valid when schedule is provided.

Request Fields

Path Type Description

devices.ids[]

Array

The device ID list. With schedule, either deviceIds or siteIds are allowed, not both. Without schedule, only deviceIds should be provided

devices.site_ids[]

Array

The site ID list. With schedule, either device_ids or siteIds are allowed, not both. Without schedule, only deviceIds should be provided

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_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_upgrade_versions[]

Array

Upgrade to the specific firmware version.

policy.firmware_upgrade_versions[].firmware_id

Number

The device compatible firmware metadata ID. It is a required field. A combination of firmware_id + device_id / firmware_id + product_type is allowed.

policy.firmware_upgrade_versions[].device_id

Number

The device ID. A combination of firmware_id + device_id / firmware_id + product_type is allowed. All three together are not allowed.

policy.firmware_upgrade_versions[].product_type

String

The product type. Should be provided only for schedule. A combination of firmware_id + device_id / firmware_id + product_type is allowed. All three together are not allowed.

policy.firmware_activate_option

Object

Firmware activate option. Only one of enable_activate_at_next_reboot, activation_delay_seconds & activation_time could be selected.

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.

schedule

Object

Schedule details.

schedule.start_time

Number

The start time for the schedule, epoch time in milliseconds since 1/1/1970. It should be within 30 days from the current day. A start time of 0 indicates an immediate schedule.The start time is expressed as the number of seconds since 00:00:00 UTC on 1 January 1970 (the Unix epoch). For instance, a start time of 1622548800 represents 1 June 2021 at 00:00:00 UTC.

HTTP Request

POST /deployments?async=true HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8
Content-Type: application/json
Content-Length: 694
Host: api.extremecloudiq.com

{
  "schedule" : {
    "start_time" : 1720337642000
  },
  "devices" : {
    "ids" : [ 438086664193, 438086664194, 438086664195 ],
    "site_ids" : [ 438086664193, 438086664194, 438086664195 ]
  },
  "policy" : {
    "enable_complete_configuration_update" : true,
    "firmware_upgrade_policy" : {
      "enable_enforce_upgrade" : false,
      "enable_distributed_upgrade" : false
    },
    "firmware_upgrade_versions" : [ {
      "firmware_id" : 5678,
      "device_id" : 1234,
      "product_type" : "AP3200"
    } ],
    "firmware_activate_option" : {
      "activation_delay_seconds" : 30,
      "activation_time" : 1720337942000,
      "enable_activate_at_next_reboot" : false
    }
  }
}

Response Fields

Path Type Description

deployment_status.*.is_finished

Boolean

Indicates whether the last deployment is finished. It is present only if the corresponding deployment is not scheduled.

deployment_status.*.current_progress

Number

The current deploy progress if not finished, range from 0 to 100. It is present only if the corresponding deployment is not scheduled.

deployment_status.*.current_step_code

String

The code of the current deploy step if not finished. It is present only if the corresponding deployment is not scheduled.

deployment_status.*.current_step_message

String

The readable message of the current deploy step if not finished. It is present only if the corresponding deployment is not scheduled.

deployment_status.*.is_finished_successful

Boolean

Indicates whether the last deployment is successful if finished. It is present only if the corresponding deployment is not scheduled.

deployment_status.*.last_deploy_time

Number

The last deployed time (Only valid when in_progress = false). It is present only if the corresponding deployment is not scheduled.

deployment_status.*.status_message

String

The status message. It is present only if the corresponding deployment is not scheduled..

deployment_id

Number

It is present only if the deployment is scheduled using start_time in the request.

deployment_status.*.is_config_rolled_back

Boolean

Indicates whether the configuration is rolled back. It is present only if the corresponding deployment is not scheduled.

HTTP Response

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

{
  "deployment_status" : {
    "438086764234" : {
      "is_finished" : true,
      "is_finished_successful" : true,
      "last_deploy_time" : 1783358879339
    }
  }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/deployments?async=true' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8' \
    -H 'Content-Type: application/json' \
    -d '{
  "schedule" : {
    "start_time" : 1720337642000
  },
  "devices" : {
    "ids" : [ 438086664193, 438086664194, 438086664195 ],
    "site_ids" : [ 438086664193, 438086664194, 438086664195 ]
  },
  "policy" : {
    "enable_complete_configuration_update" : true,
    "firmware_upgrade_policy" : {
      "enable_enforce_upgrade" : false,
      "enable_distributed_upgrade" : false
    },
    "firmware_upgrade_versions" : [ {
      "firmware_id" : 5678,
      "device_id" : 1234,
      "product_type" : "AP3200"
    } ],
    "firmware_activate_option" : {
      "activation_delay_seconds" : 30,
      "activation_time" : 1720337942000,
      "enable_activate_at_next_reboot" : false
    }
  }
}'

Get configuration deployment overview

GET /deployments/overview

HTTP Request

GET /deployments/overview HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7338
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

*.is_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).

*.status_message

String

The status message.

*.is_config_rolled_back

Boolean

Indicates whether the configuration is rolled back.

HTTP Response

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

{
  "1" : {
    "is_finished" : true,
    "is_finished_successful" : true,
    "last_deploy_time" : 1783358879395
  }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/deployments/status?deviceIds=438086664193&deviceIds=438086664194' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8' \
    -H 'Content-Type: application/json'

Get device firmware metadatas

POST /deployments/firmware-metadatas

Request Fields

Path Type Description

device_ids[]

Array

The device IDs

product_types[]

Array

The product types

HTTP Request

POST /deployments/firmware-metadatas HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8
Content-Type: application/json
Content-Length: 63
Host: api.extremecloudiq.com

{
  "device_ids" : [ 1234 ],
  "product_types" : [ "AP_123" ]
}

Response Fields

Path Type Description

firmware_metadatas.*.[].firmware_id

Number

The firmware metadata ID.

firmware_metadatas.*.[].create_time

String

The create time.

firmware_metadatas.*.[].update_time

String

The last update time.

firmware_metadatas.*.[].firmware_name

String

The firmware name.

firmware_metadatas.*.[].firmware_type

String

The firmware type.

firmware_metadatas.*.[].scope

String

The firmware availability scope.

firmware_metadatas.*.[].version

String

The firmware version.

firmware_metadatas.*.[].date

String

The firmware release date.

firmware_metadatas.*.[].firmware_size

String

The firmware size.

firmware_metadatas.*.[].display_version

String

The firmware display version.

firmware_metadatas.*.[].supported_platforms

String

The platforms supported by the firmware.

firmware_metadatas.*.[].md5

String

The firmware md5 hash.

HTTP Response

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

{
  "firmware_metadatas" : {
    "AP_123" : [ {
      "firmware_id" : 5678,
      "create_time" : "2026-07-06T17:27:59.000+0000",
      "update_time" : "2026-07-06T17:27:59.000+0000",
      "firmware_name" : "AP123-4.5r6a.img.S",
      "firmware_type" : "AP123",
      "scope" : "GLOBAL",
      "version" : "4.5.6.0",
      "date" : "07/06/2026 17:27:59",
      "firmware_size" : "1024",
      "display_version" : "4.5r6a",
      "supported_platforms" : "AP123, AP789CX",
      "md5" : "89bfd52"
    } ],
    "1234" : [ {
      "firmware_id" : 5678,
      "create_time" : "2026-07-06T17:27:59.000+0000",
      "update_time" : "2026-07-06T17:27:59.000+0000",
      "firmware_name" : "AP123-4.5r6a.img.S",
      "firmware_type" : "AP123",
      "scope" : "GLOBAL",
      "version" : "4.5.6.0",
      "date" : "07/06/2026 17:27:59",
      "firmware_size" : "1024",
      "display_version" : "4.5r6a",
      "supported_platforms" : "AP123, AP789CX",
      "md5" : "89bfd52"
    } ]
  }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/deployments/firmware-metadatas' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8' \
    -H 'Content-Type: application/json' \
    -d '{
  "device_ids" : [ 1234 ],
  "product_types" : [ "AP_123" ]
}'

Get firmware deployment status by ID

GET deployments/{deploymentId}/status

Path Parameters

Table 100. /deployments/{deploymentId}/status
Parameter Description

deploymentId

The deployment ID

Request Parameters

Parameter Description

async

Whether running this request as async or not.

HTTP Request

GET /deployments/1232322126/status?async=false HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8
Host: api.extremecloudiq.com

Response Fields

Path Type Description

schedule_status

String

The status of the deployment

schedule_time

Number

The time of the deployment

created_time

Number

The schedule created time of the deployment

updated_time

Number

The last updated time of the deployment

site_info

Array

Upgrade to the specific firmware version.

site_info[].site_id

Number

The device compatible firmware metadata ID.

site_info[].device_ids

Array

The site ID list.

site_info[].overview.total_devices

Number

The count of total devices.

site_info[].overview.in_progress_devices

Number

The device count with in progress deployment.

site_info[].overview.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.

deployment_status.*.is_finished

Boolean

Indicates whether the last deployment is finished. It is present only without schedule.

deployment_status.*.current_progress

Number

The current deploy progress if not finished, range from 0 to 100. It is present only without schedule.

deployment_status.*.current_step_code

String

The code of the current deploy step if not finished. It is present only without schedule.

deployment_status.*.current_step_message

String

The readable message of the current deploy step if not finished. It is present only without schedule.

deployment_status.*.is_finished_successful

Boolean

Indicates whether the last deployment is successful if finished. It is present only without schedule.

deployment_status.*.last_deploy_time

Number

The last deployed time (Only valid when in_progress = false). It is present only without schedule.

deployment_status.*.status_message

String

The status message.

deployment_status.*.is_config_rolled_back

Boolean

Indicates whether the configuration is rolled back. It is present only if the corresponding deployment is not scheduled.

overview.total_devices

Number

The total device count.

overview.in_progress_devices

Number

The device count with in progress deployment.

overview.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
RateLimit: "default";r=7336
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 630

{
  "schedule_status" : "SCHEDULED",
  "schedule_time" : 24325227,
  "created_time" : 76546757,
  "updated_time" : 62873538,
  "site_info" : [ {
    "site_id" : 2124362,
    "device_ids" : [ 123, 456 ],
    "overview" : {
      "total_devices" : 2,
      "in_progress_devices" : 1,
      "total_progress" : 50
    }
  } ],
  "deployment_status" : {
    "1" : {
      "is_finished" : true,
      "is_finished_successful" : true,
      "last_deploy_time" : 1783358879555,
      "status_message" : "Status message"
    }
  },
  "overview" : {
    "total_devices" : 20,
    "in_progress_devices" : 10,
    "total_progress" : 500
  }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/deployments/1232322126/status?async=false' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8'

Update schedule with deployment ID

PUT /deployments/{deploymentId}

Path Parameters

Table 101. /deployments/{deploymentId}
Parameter Description

deploymentId

The deployment ID

Request Fields

Path Type Description

schedule

Object

The Schedule details

schedule.start_time

Number

The start time for the schedule. It should be within 30 days from the current day. A start time of 0 indicates an immediate schedule.The start time is expressed as the number of seconds since 00:00:00 UTC on 1 January 1970 (the Unix epoch). For instance, a start time of 1622548800 represents 1 June 2021 at 00:00:00 UTC.

devices.ids[]

Array

The device ID list.

devices.site_ids[]

Array

The site 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_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_upgrade_versions[]

Array

Upgrade to the specific firmware version.

policy.firmware_upgrade_versions[].firmware_id

Number

The device compatible firmware metadata ID.

policy.firmware_upgrade_versions[].device_id

Number

The device ID.

policy.firmware_upgrade_versions[].product_type

String

The product type.

policy.firmware_activate_option

Object

Firmware activate option. Only one of enable_activate_at_next_reboot, activation_delay_seconds & activation_time could be selected.

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

PUT /deployments/12345678 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8
Content-Type: application/json
Content-Length: 694
Host: api.extremecloudiq.com

{
  "schedule" : {
    "start_time" : 1720337642000
  },
  "devices" : {
    "ids" : [ 438086664193, 438086664194, 438086664195 ],
    "site_ids" : [ 438086664193, 438086664194, 438086664195 ]
  },
  "policy" : {
    "enable_complete_configuration_update" : true,
    "firmware_upgrade_policy" : {
      "enable_enforce_upgrade" : false,
      "enable_distributed_upgrade" : false
    },
    "firmware_upgrade_versions" : [ {
      "firmware_id" : 5678,
      "device_id" : 1234,
      "product_type" : "AP3200"
    } ],
    "firmware_activate_option" : {
      "activation_delay_seconds" : 30,
      "activation_time" : 1720337942000,
      "enable_activate_at_next_reboot" : false
    }
  }
}

Response Fields

Path Type Description

status

String

The status of the response

HTTP Response

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

{
  "status" : "Deployment Updated"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/deployments/12345678' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8' \
    -H 'Content-Type: application/json' \
    -d '{
  "schedule" : {
    "start_time" : 1720337642000
  },
  "devices" : {
    "ids" : [ 438086664193, 438086664194, 438086664195 ],
    "site_ids" : [ 438086664193, 438086664194, 438086664195 ]
  },
  "policy" : {
    "enable_complete_configuration_update" : true,
    "firmware_upgrade_policy" : {
      "enable_enforce_upgrade" : false,
      "enable_distributed_upgrade" : false
    },
    "firmware_upgrade_versions" : [ {
      "firmware_id" : 5678,
      "device_id" : 1234,
      "product_type" : "AP3200"
    } ],
    "firmware_activate_option" : {
      "activation_delay_seconds" : 30,
      "activation_time" : 1720337942000,
      "enable_activate_at_next_reboot" : false
    }
  }
}'

Get deployment details by Id

GET deployments/{deploymentId}

Path Parameters

Table 102. /deployments/{deploymentId}
Parameter Description

deploymentId

The deployment ID

HTTP Request

GET /deployments/1232322126 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8
Host: api.extremecloudiq.com

Response Fields

Path Type Description

deployment_id

Number

The deployment id. It is only present in case of schedule.

schedule.start_time

Number

This is the start time for the schedule, expressed as the number of seconds since 00:00:00 UTC on 1 January 1970 (the Unix epoch). For instance, a start time of 1622548800 represents 1 June 2021 at 00:00:00 UTC.

devices.site_ids

Array

The site ID list.

devices.ids

Array

The device ID list.

policy.enable_complete_configuration_update

Boolean

True if update complete configuration, otherwise update delta configuration.

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_upgrade_versions

Array

Upgrade to the specific firmware version.

policy.firmware_upgrade_versions[].firmware_id

Number

The device compatible firmware metadata ID.

policy.firmware_upgrade_versions[].device_id

Number

The device ID.

policy.firmware_upgrade_versions[].product_type

String

The product type.

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.

schedule_status

String

The status of the deployment

overview.total_devices

Number

The total device count.

overview.in_progress_devices

Number

The device count with in progress deployment.

overview.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
RateLimit: "default";r=7342
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 655

{
  "deployment_id" : 12345678,
  "schedule" : {
    "start_time" : 1720337642000
  },
  "devices" : {
    "ids" : [ 123, 456 ]
  },
  "policy" : {
    "enable_complete_configuration_update" : true,
    "firmware_upgrade_policy" : {
      "enable_enforce_upgrade" : false,
      "enable_distributed_upgrade" : false
    },
    "firmware_upgrade_versions" : [ {
      "firmware_id" : 5678,
      "device_id" : 1234
    } ],
    "firmware_activate_option" : {
      "enable_activate_at_next_reboot" : false
    }
  },
  "schedule_status" : "COMPLETED",
  "overview" : {
    "total_devices" : 2,
    "in_progress_devices" : 1,
    "total_progress" : 50
  }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/deployments/1232322126' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8'

Get list of deployments

GET /deployments

HTTP Request

GET /deployments HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The number of items per page.

total_pages

Number

The total number of pages.

total_count

Number

The total number of items.

data

Array

An array of deployments.

data[].deployment_id

Number

The deployment id. It is only present in case of schedule.

data[].schedule.start_time

Number

This is the start time for the schedule, expressed as the number of seconds since 00:00:00 UTC on 1 January 1970 (the Unix epoch). For instance, a start time of 1622548800 represents 1 June 2021 at 00:00:00 UTC.

data[].devices.site_ids

Array

The site ID list.

data[].devices.ids

Array

The device ID list.

data[].policy.enable_complete_configuration_update

Boolean

True if update complete configuration, otherwise update delta configuration.

data[].policy.firmware_upgrade_policy.enable_enforce_upgrade

Boolean

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

data[].policy.firmware_upgrade_policy.enable_distributed_upgrade

Boolean

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

data[].policy.firmware_upgrade_versions

Array

Upgrade to the specific firmware version.

data[].policy.firmware_upgrade_versions[].firmware_id

Number

The device compatible firmware metadata ID.

data[].policy.firmware_upgrade_versions[].device_id

Number

The device ID.

data[].policy.firmware_upgrade_versions[].product_type

String

The product type.

data[].policy.firmware_activate_option.enable_activate_at_next_reboot

Boolean

Activate at next reboot (requires rebooting manually).

data[].policy.firmware_activate_option.activation_delay_seconds

Number

Activate after the given seconds.

data[].policy.firmware_activate_option.activation_time

Number

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

data[].overview.total_devices

Number

The total device count.

data[].overview.in_progress_devices

Number

The device count with in progress deployment.

data[].overview.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
RateLimit: "default";r=7341
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 766

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "deployment_id" : 12345678,
    "schedule" : {
      "start_time" : 1720337642000
    },
    "devices" : {
      "ids" : [ 123, 456 ]
    },
    "policy" : {
      "enable_complete_configuration_update" : true,
      "firmware_upgrade_policy" : {
        "enable_enforce_upgrade" : false,
        "enable_distributed_upgrade" : false
      },
      "firmware_upgrade_versions" : [ {
        "firmware_id" : 5678,
        "device_id" : 1234
      } ],
      "firmware_activate_option" : {
        "enable_activate_at_next_reboot" : false
      }
    },
    "overview" : {
      "total_devices" : 2,
      "in_progress_devices" : 1,
      "total_progress" : 50
    }
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/deployments' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8' \
    -H 'Content-Type: application/json'

Delete the deployment schedule by ID

DELETE deployments/{deploymentId}

Path Parameters

Table 103. /deployments/{deploymentId}
Parameter Description

deploymentId

The deployment ID

HTTP Request

DELETE /deployments/1232322126 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8
Host: api.extremecloudiq.com

Response Fields

Path Type Description

status

String

The status of the response

HTTP Response

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

{
  "status" : "Deployment Deleted"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/deployments/1232322126' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8'

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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8
Content-Type: application/json
Host: api.extremecloudiq.com

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 unique identifier.

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].create_time

String

The create time in UTC (ISO 8601 format).

data[].update_time

String

The last update time in UTC (ISO 8601 format).

data[].name

String

The VLAN profile name.

data[].default_vlan_id

Number

The default VLAN ID.

data[].enable_classification

Boolean

If apply VLANs to devices using classification.

data[].classified_entries[].id

Number

The unique identifier.

data[].classified_entries[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].classified_entries[].create_time

String

The create time in UTC (ISO 8601 format).

data[].classified_entries[].update_time

String

The last update time in UTC (ISO 8601 format).

data[].classified_entries[].vlan_id

Number

The VLAN ID.

data[].classified_entries[].classification_rule.id

Number

The unique identifier.

data[].classified_entries[].classification_rule.org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].classified_entries[].classification_rule.create_time

String

The create time in UTC (ISO 8601 format).

data[].classified_entries[].classification_rule.update_time

String

The last update time in UTC (ISO 8601 format).

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

Array

The details of rule assignments.

data[].classified_entries[].classification_rule.classifications[].id

Number

The unique identifier.

data[].classified_entries[].classification_rule.classifications[].create_time

String

The create time in UTC (ISO 8601 format).

data[].classified_entries[].classification_rule.classifications[].update_time

String

The last update time in UTC (ISO 8601 format).

data[].classified_entries[].classification_rule.classifications[].classification_type

String

Classification type.

data[].classified_entries[].classification_rule.classifications[].match

Boolean

Contains or not contains.

data[].classified_entries[].classification_rule.classifications[].classification_id

Number

The ID of location, cloud config group, IP address, IP subnet or IP range.

data[].classified_entries[].classification_rule.classifications[].value

String

The MAC address in format 'AABBCCDDEEFF' without separators.

HTTP Response

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

{
  "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" : "2026-07-06T17:27:59.000+0000",
        "update_time" : "2026-07-06T17:27:59.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" : "2026-07-06T17:27:59.000+0000",
        "update_time" : "2026-07-06T17:27:59.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" : "2026-07-06T17:27:59.000+0000",
        "update_time" : "2026-07-06T17:27:59.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" : "2026-07-06T17:27:59.000+0000",
        "update_time" : "2026-07-06T17:27:59.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" : "2026-07-06T17:27:59.000+0000",
        "update_time" : "2026-07-06T17:27:59.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" : "2026-07-06T17:27:59.000+0000",
        "update_time" : "2026-07-06T17:27:59.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" : "2026-07-06T17:27:59.000+0000",
        "update_time" : "2026-07-06T17:27:59.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" : "2026-07-06T17:27:59.000+0000",
        "update_time" : "2026-07-06T17:27:59.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" : "2026-07-06T17:27:59.000+0000",
        "update_time" : "2026-07-06T17:27:59.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8' \
    -H 'Content-Type: application/json'

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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8
Content-Type: application/json
Content-Length: 297
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7335
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 4060

{
  "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" : "2026-07-06T17:27:59.000+0000",
      "update_time" : "2026-07-06T17:27:59.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" : "2026-07-06T17:27:59.000+0000",
      "update_time" : "2026-07-06T17:27:59.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" : "2026-07-06T17:27:59.000+0000",
      "update_time" : "2026-07-06T17:27:59.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8' \
    -H 'Content-Type: application/json' \
    -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 104. /vlan-profiles/{id}
Parameter Description

id

The vlan profile ID

HTTP Request

GET /vlan-profiles/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7333
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 4060

{
  "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" : "2026-07-06T17:27:59.000+0000",
      "update_time" : "2026-07-06T17:27:59.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" : "2026-07-06T17:27:59.000+0000",
      "update_time" : "2026-07-06T17:27:59.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" : "2026-07-06T17:27:59.000+0000",
      "update_time" : "2026-07-06T17:27:59.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8' \
    -H 'Content-Type: application/json'

Delete VLAN profile

DELETE /vlan-profiles/{id}

Path Parameters

Table 105. /vlan-profiles/{id}
Parameter Description

id

The vlan profile ID

HTTP Request

DELETE /vlan-profiles/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/vlan-profiles/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8' \
    -H 'Content-Type: application/json'

Update VLAN profile

PATCH /vlan-profiles/{id}

Path Parameters

Table 106. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8
Content-Type: application/json
Content-Length: 295
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7332
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 4060

{
  "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" : "2026-07-06T17:27:59.000+0000",
      "update_time" : "2026-07-06T17:27:59.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" : "2026-07-06T17:27:59.000+0000",
      "update_time" : "2026-07-06T17:27:59.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" : "2026-07-06T17:27:59.000+0000",
      "update_time" : "2026-07-06T17:27:59.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc5LCJleHAiOjE3ODM5NjM2Nzl9.07tCawm-G1i811o2EaD7r5TRwc5hzyQhxEhZzuYviL8' \
    -H 'Content-Type: application/json' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY0LCJleHAiOjE3ODM5NjM2NjR9.rb5_SdrODMB3wJbbLncwZrhkFqBcAZBbLZDKN_OoNuM
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7465
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 1139

[ {
  "id" : 1,
  "create_time" : "2026-07-06T17:27:44.000+0000",
  "update_time" : "2026-07-06T17:27:44.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" : "2026-07-06T17:27:44.000+0000",
  "update_time" : "2026-07-06T17:27:44.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" : "2026-07-06T17:27:44.000+0000",
  "update_time" : "2026-07-06T17:27:44.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY0LCJleHAiOjE3ODM5NjM2NjR9.rb5_SdrODMB3wJbbLncwZrhkFqBcAZBbLZDKN_OoNuM' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs
Content-Type: application/json
Host: api.extremecloudiq.com

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

data[].vlan_override

Number

The VLAN Override ID of user

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 2,
  "data" : [ {
    "id" : 1,
    "create_time" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.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,
    "vlan_override" : 0
  }, {
    "id" : 2,
    "create_time" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.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,
    "vlan_override" : 0
  } ]
}

cURL Request

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

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

vlan_override

Number

The VLAN Override ID of user

HTTP Request

POST /endusers HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY0LCJleHAiOjE3ODM5NjM2NjR9.rb5_SdrODMB3wJbbLncwZrhkFqBcAZBbLZDKN_OoNuM
Content-Type: application/json
Content-Length: 316
Host: api.extremecloudiq.com

{
  "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

vlan_override

Number

The VLAN Override ID of user

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:27:44.000+0000",
  "update_time" : "2026-07-06T17:27:44.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,
  "vlan_override" : 0
}

cURL Request

$ curl 'https://api.extremecloudiq.com/endusers' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY0LCJleHAiOjE3ODM5NjM2NjR9.rb5_SdrODMB3wJbbLncwZrhkFqBcAZBbLZDKN_OoNuM' \
    -H 'Content-Type: application/json' \
    -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 107. /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

vlan_override

Number

The VLAN Override ID of user

HTTP Request

PUT /endusers/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY0LCJleHAiOjE3ODM5NjM2NjR9.rb5_SdrODMB3wJbbLncwZrhkFqBcAZBbLZDKN_OoNuM
Content-Type: application/json
Content-Length: 262
Host: api.extremecloudiq.com

{
  "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

vlan_override

Number

The VLAN Override ID of user

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:27:44.000+0000",
  "update_time" : "2026-07-06T17:27:44.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,
  "vlan_override" : 0
}

cURL Request

$ curl 'https://api.extremecloudiq.com/endusers/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY0LCJleHAiOjE3ODM5NjM2NjR9.rb5_SdrODMB3wJbbLncwZrhkFqBcAZBbLZDKN_OoNuM' \
    -H 'Content-Type: application/json' \
    -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 108. /endusers/{id}
Parameter Description

id

The user ID

HTTP Request

DELETE /endusers/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY0LCJleHAiOjE3ODM5NjM2NjR9.rb5_SdrODMB3wJbbLncwZrhkFqBcAZBbLZDKN_OoNuM
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/endusers/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY0LCJleHAiOjE3ODM5NjM2NjR9.rb5_SdrODMB3wJbbLncwZrhkFqBcAZBbLZDKN_OoNuM' \
    -H 'Content-Type: application/json'

List Key-based PCGs

GET /pcgs/key-based

HTTP Request

GET /pcgs/key-based HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7481
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 5077

[ {
  "id" : 1,
  "create_time" : "2026-07-06T17:27:43.000+0000",
  "update_time" : "2026-07-06T17:27:43.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" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user2",
    "email" : "pcg_user_2@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 1,
    "create_time" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user3",
    "email" : "pcg_user_3@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 2,
    "create_time" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  } ]
}, {
  "id" : 2,
  "create_time" : "2026-07-06T17:27:43.000+0000",
  "update_time" : "2026-07-06T17:27:43.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" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user2",
    "email" : "pcg_user_2@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 1,
    "create_time" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user3",
    "email" : "pcg_user_3@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 2,
    "create_time" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  } ]
}, {
  "id" : 3,
  "create_time" : "2026-07-06T17:27:43.000+0000",
  "update_time" : "2026-07-06T17:27:43.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" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user2",
    "email" : "pcg_user_2@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 1,
    "create_time" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user3",
    "email" : "pcg_user_3@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 2,
    "create_time" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  } ]
}, {
  "id" : 4,
  "create_time" : "2026-07-06T17:27:43.000+0000",
  "update_time" : "2026-07-06T17:27:43.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" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user2",
    "email" : "pcg_user_2@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 1,
    "create_time" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user3",
    "email" : "pcg_user_3@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 2,
    "create_time" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  } ]
}, {
  "id" : 5,
  "create_time" : "2026-07-06T17:27:43.000+0000",
  "update_time" : "2026-07-06T17:27:43.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" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user2",
    "email" : "pcg_user_2@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 1,
    "create_time" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user3",
    "email" : "pcg_user_3@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 2,
    "create_time" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  } ]
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/pcgs/key-based' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs' \
    -H 'Content-Type: application/json'

Create Key-based PCG

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

POST /pcgs/key-based

Request Parameters

Parameter Description

async

Whether running this request as async or not

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
Content-Type: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs
Content-Length: 190
Host: api.extremecloudiq.com

{
  "policy_name" : "PCG_policy",
  "ssid_name" : "PCG_wifi",
  "users" : [ {
    "name" : "candy",
    "email" : "candy@extremecloudiq.com",
    "user_group_name" : "room-201-group"
  } ]
}

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
RateLimit: "default";r=7480
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 1000

[ {
  "id" : 1,
  "create_time" : "2026-07-06T17:27:43.000+0000",
  "update_time" : "2026-07-06T17:27:43.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" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  } ]
}, {
  "id" : 2,
  "create_time" : "2026-07-06T17:27:43.000+0000",
  "update_time" : "2026-07-06T17:27:43.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" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  } ]
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/pcgs/key-based' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs' \
    -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 109. /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?ids=438086664193&ids=438086664194&ids=438086664195 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

HTTP/1.1 202 Accepted
RateLimit: "default";r=7478
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

cURL Request

$ curl 'https://api.extremecloudiq.com/pcgs/key-based/network-policy-438086664193?ids=438086664193&ids=438086664194&ids=438086664195' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs' \
    -H 'Content-Type: application/json'

Onboard Key-based PCG

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

POST /pcgs/key-based/network-policy-{policyId}/:onboard

Path Parameters

Table 110. /pcgs/key-based/network-policy-{policyId}/:onboard
Parameter Description

policyId

The network policy ID

async

Whether running this request as async or not

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
Content-Type: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs
Content-Length: 72
Host: api.extremecloudiq.com

{
  "ssid_name" : "PCG_wifi",
  "enabled" : true,
  "user_ids" : [ 1 ]
}

Response Fields

Path Type Description

policy_id

Number

The network policy ID

ssid_name

String

The SSID name.

status

String

The onboard status.

HTTP Response

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

{
  "policy_id" : 43808676489,
  "ssid_name" : "test_ssid",
  "status" : "SUCCESS"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/pcgs/key-based/network-policy-438086664193/:onboard' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs' \
    -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 111. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs
Content-Type: application/json
Host: api.extremecloudiq.com

userIds=438086664193&userIds=438086664194&userIds=438086664195

HTTP Response

HTTP/1.1 202 Accepted
RateLimit: "default";r=7473
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

cURL Request

$ curl 'https://api.extremecloudiq.com/pcgs/key-based/network-policy-438086664193/keys/:email' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs' \
    -H 'Content-Type: application/json' \
    -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 112. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs
Content-Type: application/json
Host: api.extremecloudiq.com

userIds=438086664193&userIds=438086664194&userIds=438086664195

HTTP Response

HTTP/1.1 202 Accepted
RateLimit: "default";r=7475
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

cURL Request

$ curl 'https://api.extremecloudiq.com/pcgs/key-based/network-policy-438086664193/keys/:generate' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs' \
    -H 'Content-Type: application/json' \
    -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 113. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7475
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 1489

{
  "policy_id" : 1,
  "policy_name" : "PCG_policy",
  "pcg_port_assignment_entry_details" : [ {
    "id" : 1,
    "create_time" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 0,
    "device" : {
      "id" : 1,
      "create_time" : "2026-07-06T17:27:43.000+0000",
      "update_time" : "2026-07-06T17:27:43.000+0000",
      "org_id" : 0,
      "mac_address" : "xxxxxxxx",
      "serial_number" : "xxx-xxx-xxx",
      "product_type" : "AP"
    },
    "eth1" : {
      "id" : 1,
      "create_time" : "2026-07-06T17:27:43.000+0000",
      "update_time" : "2026-07-06T17:27:43.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" : "2026-07-06T17:27:43.000+0000",
      "update_time" : "2026-07-06T17:27:43.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" : "2026-07-06T17:27:43.000+0000",
      "update_time" : "2026-07-06T17:27:43.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs' \
    -H 'Content-Type: application/json'

Assign ports for AP150W and AP302W

POST /pcgs/key-based/network-policy-{policyId}/port-assignments

Path Parameters

Table 114. /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
Content-Type: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs
Content-Length: 326
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7479
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 326

{
  "policy_id" : 1,
  "policy_name" : "PCG_policy",
  "pcg_port_assignment_entries" : [ {
    "id" : 1,
    "create_time" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.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 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs' \
    -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 115. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYyLCJleHAiOjE3ODM5NjM2NjJ9.n1y442R2GHIbJYYSUD1w_QsU3a27_iRuhwRybTqvbxU
Content-Type: application/json
Host: api.extremecloudiq.com

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

String

The user’s name.

data[].email

String

The user’s email.

data[].create_time

String

The user’s create time.

data[].update_time

String

The user’s update time.

data[].org_id

Number

The user’s organization ID.

data[].user_group_name

String

The user group name.

HTTP Response

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

{
  "page" : 2,
  "count" : 3,
  "total_pages" : 1,
  "total_count" : 3,
  "data" : [ {
    "name" : "pcg_user1",
    "email" : "pcg_user_1@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 0,
    "create_time" : "2026-07-06T17:27:42.000+0000",
    "update_time" : "2026-07-06T17:27:42.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user2",
    "email" : "pcg_user_2@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 1,
    "create_time" : "2026-07-06T17:27:42.000+0000",
    "update_time" : "2026-07-06T17:27:42.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user3",
    "email" : "pcg_user_3@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 2,
    "create_time" : "2026-07-06T17:27:42.000+0000",
    "update_time" : "2026-07-06T17:27:42.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYyLCJleHAiOjE3ODM5NjM2NjJ9.n1y442R2GHIbJYYSUD1w_QsU3a27_iRuhwRybTqvbxU' \
    -H 'Content-Type: application/json'

Replace Key-based PCG users

PUT /pcgs/key-based/network-policy-{policyId}/users

Path Parameters

Table 116. /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-Type: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs
Content-Length: 130
Host: api.extremecloudiq.com

{
  "users" : [ {
    "name" : "candy",
    "email" : "candy@extremecloudiq.com",
    "user_group_name" : "room-201-group"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
RateLimit: "default";r=7476
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

cURL Request

$ curl 'https://api.extremecloudiq.com/pcgs/key-based/network-policy-438086664193/users' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs' \
    -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 117. /pcgs/key-based/network-policy-{policyId}/users
Parameter Description

policyId

The network policy ID

async

Whether running this request as async or not

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-Type: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs
Content-Length: 130
Host: api.extremecloudiq.com

{
  "users" : [ {
    "name" : "candy",
    "email" : "candy@extremecloudiq.com",
    "user_group_name" : "room-201-group"
  } ]
}

Response Fields

Path Type Description

policy_id

Number

The network policy ID.

status

String

The status of create pcg users process.

users

Array

The key based PCG users

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
RateLimit: "default";r=7474
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 329

{
  "policy_id" : 43808676489,
  "status" : "SUCCESS",
  "users" : [ {
    "name" : "pcg_user1",
    "email" : "pcg_user_1@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 0,
    "create_time" : "2026-07-06T17:27:43.000+0000",
    "update_time" : "2026-07-06T17:27:43.000+0000",
    "org_id" : 10
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/pcgs/key-based/network-policy-438086664193/users' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs' \
    -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 118. /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
Content-Type: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs
Content-Length: 27
Host: api.extremecloudiq.com

{
  "user_ids" : [ 1, 2 ]
}

HTTP Response

HTTP/1.1 202 Accepted
RateLimit: "default";r=7480
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains

cURL Request

$ curl 'https://api.extremecloudiq.com/pcgs/key-based/network-policy-438086664193/users' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYzLCJleHAiOjE3ODM5NjM2NjN9.sHTcnvf-tf9ZmFtJvStupiiI5WKlMoaoti_2QojrAAs' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY0LCJleHAiOjE3ODM5NjM2NjR9.rb5_SdrODMB3wJbbLncwZrhkFqBcAZBbLZDKN_OoNuM
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7466
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 564

[ {
  "id" : 1,
  "create_time" : "2026-07-06T17:27:44.000+0000",
  "update_time" : "2026-07-06T17:27:44.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" : "2026-07-06T17:27:44.000+0000",
  "update_time" : "2026-07-06T17:27:44.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY0LCJleHAiOjE3ODM5NjM2NjR9.rb5_SdrODMB3wJbbLncwZrhkFqBcAZBbLZDKN_OoNuM' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYyLCJleHAiOjE3ODM5NjM2NjJ9.n1y442R2GHIbJYYSUD1w_QsU3a27_iRuhwRybTqvbxU
Content-Type: application/json
Host: api.extremecloudiq.com

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: "default";r=7485
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 4611

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 2,
  "data" : [ {
    "id" : 1,
    "create_time" : "2026-07-06T17:27:42.000+0000",
    "update_time" : "2026-07-06T17:27:42.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" : "2026-07-06T17:27:42.000+0000",
    "update_time" : "2026-07-06T17:27:42.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYyLCJleHAiOjE3ODM5NjM2NjJ9.n1y442R2GHIbJYYSUD1w_QsU3a27_iRuhwRybTqvbxU' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYyLCJleHAiOjE3ODM5NjM2NjJ9.n1y442R2GHIbJYYSUD1w_QsU3a27_iRuhwRybTqvbxU
Content-Type: application/json
Content-Length: 1974
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7486
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 2109

{
  "id" : 1,
  "create_time" : "2026-07-06T17:27:42.000+0000",
  "update_time" : "2026-07-06T17:27:42.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYyLCJleHAiOjE3ODM5NjM2NjJ9.n1y442R2GHIbJYYSUD1w_QsU3a27_iRuhwRybTqvbxU' \
    -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 119. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYyLCJleHAiOjE3ODM5NjM2NjJ9.n1y442R2GHIbJYYSUD1w_QsU3a27_iRuhwRybTqvbxU
Content-Type: application/json
Content-Length: 1974
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7483
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 2109

{
  "id" : 1,
  "create_time" : "2026-07-06T17:27:42.000+0000",
  "update_time" : "2026-07-06T17:27:42.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYyLCJleHAiOjE3ODM5NjM2NjJ9.n1y442R2GHIbJYYSUD1w_QsU3a27_iRuhwRybTqvbxU' \
    -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 120. /usergroups/{id}
Parameter Description

id

The user group ID

HTTP Request

DELETE /usergroups/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYyLCJleHAiOjE3ODM5NjM2NjJ9.n1y442R2GHIbJYYSUD1w_QsU3a27_iRuhwRybTqvbxU
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/usergroups/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODYyLCJleHAiOjE3ODM5NjM2NjJ9.n1y442R2GHIbJYYSUD1w_QsU3a27_iRuhwRybTqvbxU' \
    -H 'Content-Type: application/json'

Configuration - Policy

List cloud config groups

GET /ccgs

Request Parameters

Parameter Description

page

Page number

limit

Page size

sortField

Sort field

order

Sort order

HTTP Request

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

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
RateLimit: "default";r=7419
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 819

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 2,
  "data" : [ {
    "id" : 1,
    "create_time" : "2026-07-06T17:27:49.000+0000",
    "update_time" : "2026-07-06T17:27:49.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" : "2026-07-06T17:27:49.000+0000",
    "update_time" : "2026-07-06T17:27:49.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY5LCJleHAiOjE3ODM5NjM2Njl9.-dFTyQux6IyYOzpIukaJKndIVz9VvwXnzI9IkHYUBZo' \
    -H 'Content-Type: application/json'

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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY5LCJleHAiOjE3ODM5NjM2Njl9.-dFTyQux6IyYOzpIukaJKndIVz9VvwXnzI9IkHYUBZo
Content-Type: application/json
Content-Length: 86
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7418
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 337

{
  "id" : 1,
  "create_time" : "2026-07-06T17:27:49.000+0000",
  "update_time" : "2026-07-06T17:27:49.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY5LCJleHAiOjE3ODM5NjM2Njl9.-dFTyQux6IyYOzpIukaJKndIVz9VvwXnzI9IkHYUBZo' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "test-ccg-1",
  "description" : "test-ccg-1",
  "device_ids" : [ 1, 2 ]
}'

Get cloud config group

GET /ccgs/{id}

Path parameters

Table 121. /ccgs/{id}
Parameter Description

id

The Cloud Config Group ID

HTTP Request

GET /ccgs/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODcwLCJleHAiOjE3ODM5NjM2NzB9.k9McwiCMD8rEFIARtOR1dSMM73OdJ32o2NU5I1LafRU
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7416
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 337

{
  "id" : 1,
  "create_time" : "2026-07-06T17:27:50.000+0000",
  "update_time" : "2026-07-06T17:27:50.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODcwLCJleHAiOjE3ODM5NjM2NzB9.k9McwiCMD8rEFIARtOR1dSMM73OdJ32o2NU5I1LafRU' \
    -H 'Content-Type: application/json'

Update cloud config group

PUT /ccgs/{id}

Path Parameters

Table 122. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODcwLCJleHAiOjE3ODM5NjM2NzB9.k9McwiCMD8rEFIARtOR1dSMM73OdJ32o2NU5I1LafRU
Content-Type: application/json
Content-Length: 86
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7417
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 337

{
  "id" : 1,
  "create_time" : "2026-07-06T17:27:50.000+0000",
  "update_time" : "2026-07-06T17:27:50.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODcwLCJleHAiOjE3ODM5NjM2NzB9.k9McwiCMD8rEFIARtOR1dSMM73OdJ32o2NU5I1LafRU' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "test-ccg-1",
  "description" : "test-ccg-1",
  "device_ids" : [ 1, 2 ]
}'

Delete cloud config group

DELETE /ccgs/{id}

Path Parameters

Table 123. /ccgs/{id}
Parameter Description

id

The Cloud Config Group ID

HTTP Request

DELETE /ccgs/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY5LCJleHAiOjE3ODM5NjM2Njl9.-dFTyQux6IyYOzpIukaJKndIVz9VvwXnzI9IkHYUBZo
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/ccgs/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY5LCJleHAiOjE3ODM5NjM2Njl9.-dFTyQux6IyYOzpIukaJKndIVz9VvwXnzI9IkHYUBZo' \
    -H 'Content-Type: application/json'

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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc0LCJleHAiOjE3ODM5NjM2NzR9.fUG4vhC2PkqMDt8ccQNiTbpjJbo-gsnYRG8jKW7AN1M
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7393
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 2905

{
  "page" : 1,
  "count" : 0,
  "total_pages" : 0,
  "total_count" : 0,
  "data" : [ {
    "id" : 1,
    "create_time" : "2026-07-06T17:27:54.000+0000",
    "update_time" : "2026-07-06T17:27:54.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc0LCJleHAiOjE3ODM5NjM2NzR9.fUG4vhC2PkqMDt8ccQNiTbpjJbo-gsnYRG8jKW7AN1M' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc0LCJleHAiOjE3ODM5NjM2NzR9.fUG4vhC2PkqMDt8ccQNiTbpjJbo-gsnYRG8jKW7AN1M
Content-Type: application/json
Content-Length: 334
Host: api.extremecloudiq.com

{
  "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
RateLimit: "default";r=7394
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 711

{
  "id" : 1,
  "create_time" : "2026-07-06T17:27:54.000+0000",
  "update_time" : "2026-07-06T17:27:54.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc0LCJleHAiOjE3ODM5NjM2NzR9.fUG4vhC2PkqMDt8ccQNiTbpjJbo-gsnYRG8jKW7AN1M' \
    -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 124. /classification-rules/{id}
Parameter Description

id

The classification assignment ID

HTTP Request

GET /classification-rules/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODczLCJleHAiOjE3ODM5NjM2NzN9.A5auHsTgOSo5uGccqZP5Jr2ORzp_wyaXjjnqzS3Bvws
Content-Type: application/json
Host: api.extremecloudiq.com

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
RateLimit: "default";r=7396
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 952

{
  "id" : 1,
  "create_time" : "2026-07-06T17:27:53.000+0000",
  "update_time" : "2026-07-06T17:27:53.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODczLCJleHAiOjE3ODM5NjM2NzN9.A5auHsTgOSo5uGccqZP5Jr2ORzp_wyaXjjnqzS3Bvws' \
    -H 'Content-Type: application/json'

Update classification rule

PUT /classification-rules/{id}

Path Parameters

Table 125. /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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc0LCJleHAiOjE3ODM5NjM2NzR9.fUG4vhC2PkqMDt8ccQNiTbpjJbo-gsnYRG8jKW7AN1M
Content-Type: application/json
Content-Length: 334
Host: api.extremecloudiq.com

{
  "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: "default";r=7393
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 711

{
  "id" : 1,
  "create_time" : "2026-07-06T17:27:54.000+0000",
  "update_time" : "2026-07-06T17:27:54.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc0LCJleHAiOjE3ODM5NjM2NzR9.fUG4vhC2PkqMDt8ccQNiTbpjJbo-gsnYRG8jKW7AN1M' \
    -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 126. /classification-rules/{id}
Parameter Description

id

The classification assignment ID

HTTP Request

DELETE /classification-rules/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODczLCJleHAiOjE3ODM5NjM2NzN9.A5auHsTgOSo5uGccqZP5Jr2ORzp_wyaXjjnqzS3Bvws
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/classification-rules/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODczLCJleHAiOjE3ODM5NjM2NzN9.A5auHsTgOSo5uGccqZP5Jr2ORzp_wyaXjjnqzS3Bvws' \
    -H 'Content-Type: application/json'

Create Client Monitor Profile

POST /client-monitor-profiles

Request Fields

Path Type Description

name

String

The name of Client Monitor Profile.

description

String

The Client Monitor Profile description.

association.trigger_times

Number

How many times the problem type is detected to trigger reporting for association problems

association.report_interval

Number

Interval (in seconds) to report the problem and related logs for association problems

authentication.trigger_times

Number

How many times the problem type is detected to trigger reporting for authentication problems

authentication.report_interval

Number

Interval (in seconds) to report the problem and related logs for authentication problems

networking.trigger_times

Number

How many times the problem type is detected to trigger reporting for networking problems

networking.report_interval

Number

Interval (in seconds) to report the problem and related logs for networking problems

HTTP Request

POST /client-monitor-profiles HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc1LCJleHAiOjE3ODM5NjM2NzV9.Levwv4bnw_n2ZydXTZbJYweOtFZiPd5qIT4LvGIw0os
Content-Type: application/json
Content-Length: 287
Host: api.extremecloudiq.com

{
  "name" : "name",
  "description" : "description",
  "association" : {
    "trigger_times" : 30,
    "report_interval" : 1
  },
  "authentication" : {
    "trigger_times" : 30,
    "report_interval" : 1
  },
  "networking" : {
    "trigger_times" : 30,
    "report_interval" : 1
  }
}

Response Fields

Path Type Description

id

Number

The Client Monitor Profile ID.

org_id

Number

The org ID.

create_time

String

The create time.

update_time

String

The last update time.

name

String

The name of Client Monitor Profile.

predefined

Boolean

Flag to describe whether the Client Monitor Profile is predefined

description

String

The Client Monitor Profile description.

association.trigger_times

Number

How many times the problem type is detected to trigger reporting for association problems

association.report_interval

Number

Interval (in seconds) to report the problem and related logs for association problems

authentication.trigger_times

Number

How many times the problem type is detected to trigger reporting for authentication problems

authentication.report_interval

Number

Interval (in seconds) to report the problem and related logs for authentication problems

networking.trigger_times

Number

How many times the problem type is detected to trigger reporting for networking problems

networking.report_interval

Number

Interval (in seconds) to report the problem and related logs for networking problems

HTTP Response

HTTP/1.1 201 Created
RateLimit: "default";r=7386
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 443

{
  "id" : 1,
  "create_time" : "2026-07-06T17:27:55.000+0000",
  "update_time" : "2026-07-06T17:27:55.000+0000",
  "org_id" : 0,
  "name" : "Profile1",
  "description" : "description",
  "predefined" : false,
  "association" : {
    "trigger_times" : 30,
    "report_interval" : 1
  },
  "authentication" : {
    "trigger_times" : 30,
    "report_interval" : 1
  },
  "networking" : {
    "trigger_times" : 30,
    "report_interval" : 1
  }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/client-monitor-profiles' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc1LCJleHAiOjE3ODM5NjM2NzV9.Levwv4bnw_n2ZydXTZbJYweOtFZiPd5qIT4LvGIw0os' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "name",
  "description" : "description",
  "association" : {
    "trigger_times" : 30,
    "report_interval" : 1
  },
  "authentication" : {
    "trigger_times" : 30,
    "report_interval" : 1
  },
  "networking" : {
    "trigger_times" : 30,
    "report_interval" : 1
  }
}'

Delete Client Monitor Profile

DELETE /client-monitor-profiles/{id}

Path Parameters

Table 127. /client-monitor-profiles/{id}
Parameter Description

id

The Client Monitor Profile ID

HTTP Request

DELETE /client-monitor-profiles/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc1LCJleHAiOjE3ODM5NjM2NzV9.Levwv4bnw_n2ZydXTZbJYweOtFZiPd5qIT4LvGIw0os
Content-Type: application/json
Host: api.extremecloudiq.com

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/client-monitor-profiles/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc1LCJleHAiOjE3ODM5NjM2NzV9.Levwv4bnw_n2ZydXTZbJYweOtFZiPd5qIT4LvGIw0os' \
    -H 'Content-Type: application/json'

Get Client Monitor Profile

GET /client-monitor-profiles/{id}

Path Parameters

Table 128. /client-monitor-profiles/{id}
Parameter Description

id

The Client Monitor Profile ID

HTTP Request

GET /client-monitor-profiles/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc1LCJleHAiOjE3ODM5NjM2NzV9.Levwv4bnw_n2ZydXTZbJYweOtFZiPd5qIT4LvGIw0os
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

id

Number

The Client Monitor Profile ID.

org_id

Number

The org ID.

create_time

String

The create time.

update_time

String

The last update time.

name

String

The name of Client Monitor Profile.

predefined

Boolean

Flag to describe whether the Client Monitor Profile is predefined

description

String

The Client Monitor Profile description.

association.trigger_times

Number

How many times the problem type is detected to trigger reporting for association problems

association.report_interval

Number

Interval (in seconds) to report the problem and related logs for association problems

authentication.trigger_times

Number

How many times the problem type is detected to trigger reporting for authentication problems

authentication.report_interval

Number

Interval (in seconds) to report the problem and related logs for authentication problems

networking.trigger_times

Number

How many times the problem type is detected to trigger reporting for networking problems

networking.report_interval

Number

Interval (in seconds) to report the problem and related logs for networking problems

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:27:55.000+0000",
  "update_time" : "2026-07-06T17:27:55.000+0000",
  "org_id" : 0,
  "name" : "Profile1",
  "description" : "description",
  "predefined" : false,
  "association" : {
    "trigger_times" : 30,
    "report_interval" : 1
  },
  "authentication" : {
    "trigger_times" : 30,
    "report_interval" : 1
  },
  "networking" : {
    "trigger_times" : 30,
    "report_interval" : 1
  }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/client-monitor-profiles/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc1LCJleHAiOjE3ODM5NjM2NzV9.Levwv4bnw_n2ZydXTZbJYweOtFZiPd5qIT4LvGIw0os' \
    -H 'Content-Type: application/json'

List Client Monitor Profile

PUT /client-monitor-profiles

HTTP Request

GET /client-monitor-profiles?page=1&limit=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc1LCJleHAiOjE3ODM5NjM2NzV9.Levwv4bnw_n2ZydXTZbJYweOtFZiPd5qIT4LvGIw0os
Content-Type: application/json
Host: api.extremecloudiq.com

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 Monitor Profile ID.

data[].org_id

Number

The org ID.

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].name

String

The name of Client Monitor Profile.

data[].predefined

Boolean

Flag to describe whether the Client Monitor Profile is predefined

data[].description

String

The Client Monitor Profile description.

data[].association.trigger_times

Number

How many times the problem type is detected to trigger reporting for association problems

data[].association.report_interval

Number

Interval (in seconds) to report the problem and related logs for association problems

data[].authentication.trigger_times

Number

How many times the problem type is detected to trigger reporting for authentication problems

data[].authentication.report_interval

Number

Interval (in seconds) to report the problem and related logs for authentication problems

data[].networking.trigger_times

Number

How many times the problem type is detected to trigger reporting for networking problems

data[].networking.report_interval

Number

Interval (in seconds) to report the problem and related logs for networking problems

HTTP Response

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

{
  "page" : 1,
  "count" : 0,
  "total_pages" : 0,
  "total_count" : 0,
  "data" : [ {
    "id" : 0,
    "create_time" : "2026-07-06T17:27:55.000+0000",
    "update_time" : "2026-07-06T17:27:55.000+0000",
    "org_id" : 0,
    "name" : "Profile0",
    "description" : "description",
    "predefined" : false,
    "association" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "authentication" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "networking" : {
      "trigger_times" : 30,
      "report_interval" : 1
    }
  }, {
    "id" : 1,
    "create_time" : "2026-07-06T17:27:55.000+0000",
    "update_time" : "2026-07-06T17:27:55.000+0000",
    "org_id" : 0,
    "name" : "Profile1",
    "description" : "description",
    "predefined" : false,
    "association" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "authentication" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "networking" : {
      "trigger_times" : 30,
      "report_interval" : 1
    }
  }, {
    "id" : 2,
    "create_time" : "2026-07-06T17:27:55.000+0000",
    "update_time" : "2026-07-06T17:27:55.000+0000",
    "org_id" : 0,
    "name" : "Profile2",
    "description" : "description",
    "predefined" : false,
    "association" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "authentication" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "networking" : {
      "trigger_times" : 30,
      "report_interval" : 1
    }
  }, {
    "id" : 3,
    "create_time" : "2026-07-06T17:27:55.000+0000",
    "update_time" : "2026-07-06T17:27:55.000+0000",
    "org_id" : 0,
    "name" : "Profile3",
    "description" : "description",
    "predefined" : false,
    "association" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "authentication" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "networking" : {
      "trigger_times" : 30,
      "report_interval" : 1
    }
  }, {
    "id" : 4,
    "create_time" : "2026-07-06T17:27:55.000+0000",
    "update_time" : "2026-07-06T17:27:55.000+0000",
    "org_id" : 0,
    "name" : "Profile4",
    "description" : "description",
    "predefined" : false,
    "association" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "authentication" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "networking" : {
      "trigger_times" : 30,
      "report_interval" : 1
    }
  }, {
    "id" : 5,
    "create_time" : "2026-07-06T17:27:55.000+0000",
    "update_time" : "2026-07-06T17:27:55.000+0000",
    "org_id" : 0,
    "name" : "Profile5",
    "description" : "description",
    "predefined" : false,
    "association" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "authentication" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "networking" : {
      "trigger_times" : 30,
      "report_interval" : 1
    }
  }, {
    "id" : 6,
    "create_time" : "2026-07-06T17:27:55.000+0000",
    "update_time" : "2026-07-06T17:27:55.000+0000",
    "org_id" : 0,
    "name" : "Profile6",
    "description" : "description",
    "predefined" : false,
    "association" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "authentication" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "networking" : {
      "trigger_times" : 30,
      "report_interval" : 1
    }
  }, {
    "id" : 7,
    "create_time" : "2026-07-06T17:27:55.000+0000",
    "update_time" : "2026-07-06T17:27:55.000+0000",
    "org_id" : 0,
    "name" : "Profile7",
    "description" : "description",
    "predefined" : false,
    "association" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "authentication" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "networking" : {
      "trigger_times" : 30,
      "report_interval" : 1
    }
  }, {
    "id" : 8,
    "create_time" : "2026-07-06T17:27:55.000+0000",
    "update_time" : "2026-07-06T17:27:55.000+0000",
    "org_id" : 0,
    "name" : "Profile8",
    "description" : "description",
    "predefined" : false,
    "association" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "authentication" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "networking" : {
      "trigger_times" : 30,
      "report_interval" : 1
    }
  }, {
    "id" : 9,
    "create_time" : "2026-07-06T17:27:55.000+0000",
    "update_time" : "2026-07-06T17:27:55.000+0000",
    "org_id" : 0,
    "name" : "Profile9",
    "description" : "description",
    "predefined" : false,
    "association" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "authentication" : {
      "trigger_times" : 30,
      "report_interval" : 1
    },
    "networking" : {
      "trigger_times" : 30,
      "report_interval" : 1
    }
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/client-monitor-profiles?page=1&limit=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc1LCJleHAiOjE3ODM5NjM2NzV9.Levwv4bnw_n2ZydXTZbJYweOtFZiPd5qIT4LvGIw0os' \
    -H 'Content-Type: application/json'

Update Client Monitor Profile

PUT /client-monitor-profiles/{id}

Path Parameters

Table 129. /client-monitor-profiles/{id}
Parameter Description

id

The Client Monitor Profile ID

Request Fields

Path Type Description

name

String

The name of Client Monitor Profile.

description

String

The Client Monitor Profile description.

association.trigger_times

Number

How many times the problem type is detected to trigger reporting for association problems

association.report_interval

Number

Interval (in seconds) to report the problem and related logs for association problems

authentication.trigger_times

Number

How many times the problem type is detected to trigger reporting for authentication problems

authentication.report_interval

Number

Interval (in seconds) to report the problem and related logs for authentication problems

networking.trigger_times

Number

How many times the problem type is detected to trigger reporting for networking problems

networking.report_interval

Number

Interval (in seconds) to report the problem and related logs for networking problems

HTTP Request

PUT /client-monitor-profiles/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc2LCJleHAiOjE3ODM5NjM2NzZ9.EofaR1xDdo1x00qycE-ZrGaulhfo_aQuAGGN5GdkMIo
Content-Type: application/json
Content-Length: 287
Host: api.extremecloudiq.com

{
  "name" : "name",
  "description" : "description",
  "association" : {
    "trigger_times" : 30,
    "report_interval" : 1
  },
  "authentication" : {
    "trigger_times" : 30,
    "report_interval" : 1
  },
  "networking" : {
    "trigger_times" : 30,
    "report_interval" : 1
  }
}

Response Fields

Path Type Description

id

Number

The Client Monitor Profile ID.

org_id

Number

The org ID.

create_time

String

The create time.

update_time

String

The last update time.

name

String

The name of Client Monitor Profile.

predefined

Boolean

Flag to describe whether the Client Monitor Profile is predefined

description

String

The Client Monitor Profile description.

association.trigger_times

Number

How many times the problem type is detected to trigger reporting for association problems

association.report_interval

Number

Interval (in seconds) to report the problem and related logs for association problems

authentication.trigger_times

Number

How many times the problem type is detected to trigger reporting for authentication problems

authentication.report_interval

Number

Interval (in seconds) to report the problem and related logs for authentication problems

networking.trigger_times

Number

How many times the problem type is detected to trigger reporting for networking problems

networking.report_interval

Number

Interval (in seconds) to report the problem and related logs for networking problems

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2026-07-06T17:27:56.000+0000",
  "update_time" : "2026-07-06T17:27:56.000+0000",
  "org_id" : 0,
  "name" : "Profile1",
  "description" : "description",
  "predefined" : false,
  "association" : {
    "trigger_times" : 30,
    "report_interval" : 1
  },
  "authentication" : {
    "trigger_times" : 30,
    "report_interval" : 1
  },
  "networking" : {
    "trigger_times" : 30,
    "report_interval" : 1
  }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/client-monitor-profiles/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODc2LCJleHAiOjE3ODM5NjM2NzZ9.EofaR1xDdo1x00qycE-ZrGaulhfo_aQuAGGN5GdkMIo' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "name",
  "description" : "description",
  "association" : {
    "trigger_times" : 30,
    "report_interval" : 1
  },
  "authentication" : {
    "trigger_times" : 30,
    "report_interval" : 1
  },
  "networking" : {
    "trigger_times" : 30,
    "report_interval" : 1
  }
}'

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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY0LCJleHAiOjE3ODM5NjM2NjR9.rb5_SdrODMB3wJbbLncwZrhkFqBcAZBbLZDKN_OoNuM
Content-Type: application/json
Host: api.extremecloudiq.com

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: "default";r=7462
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 317

[ {
  "id" : 1,
  "create_time" : "2026-07-06T17:27:44.000+0000",
  "update_time" : "2026-07-06T17:27:44.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODY0LCJleHAiOjE3ODM5NjM2NjR9.rb5_SdrODMB3wJbbLncwZrhkFqBcAZBbLZDKN_OoNuM' \
    -H 'Content-Type: application/json'

List mac objects

GET /mac-object-profiles

Request Parameters

Parameter Description

macType

Mac Type of mac object profile

HTTP Request

GET /mac-object-profiles?macType=MAC_OUI HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODcwLCJleHAiOjE3ODM5NjM2NzB9.k9McwiCMD8rEFIARtOR1dSMM73OdJ32o2NU5I1LafRU
Content-Type: application/json
Host: api.extremecloudiq.com

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 Mac Object Profile ID.

data[].name

String

The Mac Object Profile name

data[].create_time

String

The create time of the Mac Object Profile.

data[].update_time

String

The update time of the Mac Object Profile.

data[].org_id

Number

The Org Id

data[].description

String

The MAC object description.

data[].predefined

Boolean

Whether the MAC Oui is predefined

data[].value

String

The MAC octets.

data[].mac_type

String

The MAC object type e.g, "MAC_OUI", "MAC_RANGE" or "MAC_ADDRESS"

data[].defender_defined

Boolean

Whether defender is defined

data[].mac_address_end

String

The MAC address end, only available for "MAC_RANGE"

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 3,
  "data" : [ {
    "id" : 0,
    "create_time" : "2026-07-06T17:27:50.000+0000",
    "update_time" : "2026-07-06T17:27:50.000+0000",
    "org_id" : 0,
    "name" : "MAC-Obj-1",
    "description" : "The Mac Object Profile description",
    "predefined" : true,
    "value" : "string",
    "mac_type" : "MAC_OUI",
    "defender_defined" : true,
    "mac_address_end" : "string"
  }, {
    "id" : 1,
    "create_time" : "2026-07-06T17:27:50.000+0000",
    "update_time" : "2026-07-06T17:27:50.000+0000",
    "org_id" : 0,
    "name" : "MAC-Obj-1",
    "description" : "The Mac Object Profile description",
    "predefined" : true,
    "value" : "string",
    "mac_type" : "MAC_OUI",
    "defender_defined" : true,
    "mac_address_end" : "string"
  }, {
    "id" : 2,
    "create_time" : "2026-07-06T17:27:50.000+0000",
    "update_time" : "2026-07-06T17:27:50.000+0000",
    "org_id" : 0,
    "name" : "MAC-Obj-1",
    "description" : "The Mac Object Profile description",
    "predefined" : true,
    "value" : "string",
    "mac_type" : "MAC_OUI",
    "defender_defined" : true,
    "mac_address_end" : "string"
  }, {
    "id" : 3,
    "create_time" : "2026-07-06T17:27:50.000+0000",
    "update_time" : "2026-07-06T17:27:50.000+0000",
    "org_id" : 0,
    "name" : "MAC-Obj-1",
    "description" : "The Mac Object Profile description",
    "predefined" : true,
    "value" : "string",
    "mac_type" : "MAC_OUI",
    "defender_defined" : true,
    "mac_address_end" : "string"
  }, {
    "id" : 4,
    "create_time" : "2026-07-06T17:27:50.000+0000",
    "update_time" : "2026-07-06T17:27:50.000+0000",
    "org_id" : 0,
    "name" : "MAC-Obj-1",
    "description" : "The Mac Object Profile description",
    "predefined" : true,
    "value" : "string",
    "mac_type" : "MAC_OUI",
    "defender_defined" : true,
    "mac_address_end" : "string"
  }, {
    "id" : 5,
    "create_time" : "2026-07-06T17:27:50.000+0000",
    "update_time" : "2026-07-06T17:27:50.000+0000",
    "org_id" : 0,
    "name" : "MAC-Obj-1",
    "description" : "The Mac Object Profile description",
    "predefined" : true,
    "value" : "string",
    "mac_type" : "MAC_OUI",
    "defender_defined" : true,
    "mac_address_end" : "string"
  }, {
    "id" : 6,
    "create_time" : "2026-07-06T17:27:50.000+0000",
    "update_time" : "2026-07-06T17:27:50.000+0000",
    "org_id" : 0,
    "name" : "MAC-Obj-1",
    "description" : "The Mac Object Profile description",
    "predefined" : true,
    "value" : "string",
    "mac_type" : "MAC_OUI",
    "defender_defined" : true,
    "mac_address_end" : "string"
  }, {
    "id" : 7,
    "create_time" : "2026-07-06T17:27:50.000+0000",
    "update_time" : "2026-07-06T17:27:50.000+0000",
    "org_id" : 0,
    "name" : "MAC-Obj-1",
    "description" : "The Mac Object Profile description",
    "predefined" : true,
    "value" : "string",
    "mac_type" : "MAC_OUI",
    "defender_defined" : true,
    "mac_address_end" : "string"
  }, {
    "id" : 8,
    "create_time" : "2026-07-06T17:27:50.000+0000",
    "update_time" : "2026-07-06T17:27:50.000+0000",
    "org_id" : 0,
    "name" : "MAC-Obj-1",
    "description" : "The Mac Object Profile description",
    "predefined" : true,
    "value" : "string",
    "mac_type" : "MAC_OUI",
    "defender_defined" : true,
    "mac_address_end" : "string"
  }, {
    "id" : 9,
    "create_time" : "2026-07-06T17:27:50.000+0000",
    "update_time" : "2026-07-06T17:27:50.000+0000",
    "org_id" : 0,
    "name" : "MAC-Obj-1",
    "description" : "The Mac Object Profile description",
    "predefined" : true,
    "value" : "string",
    "mac_type" : "MAC_OUI",
    "defender_defined" : true,
    "mac_address_end" : "string"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/mac-object-profiles?macType=MAC_OUI' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODcwLCJleHAiOjE3ODM5NjM2NzB9.k9McwiCMD8rEFIARtOR1dSMM73OdJ32o2NU5I1LafRU' \
    -H 'Content-Type: application/json'

Create mac object

POST /mac-object-profiles

Request Fields

Path Type Description

name

String

The Mac Object Profile name

description

String

The MAC object description.

value

String

The MAC octets.

mac_type

String

The MAC object type e.g, "MAC_OUI", "MAC_RANGE" or "MAC_ADDRESS"

mac_address_end

String

The MAC address end, only available for "MAC_RANGE"

HTTP Request

POST /mac-object-profiles HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODcwLCJleHAiOjE3ODM5NjM2NzB9.k9McwiCMD8rEFIARtOR1dSMM73OdJ32o2NU5I1LafRU
Content-Type: application/json
Content-Length: 147
Host: api.extremecloudiq.com

{
  "name" : "Mac-Object-Test1",
  "description" : "mac obj desc",
  "value" : "123456",
  "mac_type" : "MAC_OUI",
  "mac_address_end" : "123456"
}

Response Fields

Path Type Description

id

Number

create_time

String

The create time of the Mac Object Profile.

update_time

String

The update time of the Mac Object Profile.

name

String

The Mac Object Profile name

org_id

Number

The Org Id

description

String

The Mac Object Profile description

predefined

Boolean

Whether the MAC Oui is predefined

value

String

The MAC octets.

mac_type

String

The MAC object type e.g, "MAC_OUI", "MAC_RANGE" or "MAC_ADDRESS"

mac_address_end

String

The MAC address end, only available for "MAC_RANGE"

defender_defined

Boolean

Whether defender is defined

HTTP Response

HTTP/1.1 201 Created
RateLimit: "default";r=7416
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 318

{
  "id" : 0,
  "create_time" : "2026-07-06T17:27:50.000+0000",
  "update_time" : "2026-07-06T17:27:50.000+0000",
  "org_id" : 0,
  "name" : "Mac-obj",
  "description" : "description",
  "predefined" : false,
  "value" : "123456",
  "mac_type" : "MAC_OUI",
  "defender_defined" : true,
  "mac_address_end" : "string"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/mac-object-profiles' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODcwLCJleHAiOjE3ODM5NjM2NzB9.k9McwiCMD8rEFIARtOR1dSMM73OdJ32o2NU5I1LafRU' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Mac-Object-Test1",
  "description" : "mac obj desc",
  "value" : "123456",
  "mac_type" : "MAC_OUI",
  "mac_address_end" : "123456"
}'

Get mac object by ID

GET /mac-object-profiles/{id}

Path Parameters

Table 130. /mac-object-profiles/{id}
Parameter Description

id

The Mac Object Profile ID

HTTP Request

GET /mac-object-profiles/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODcwLCJleHAiOjE3ODM5NjM2NzB9.k9McwiCMD8rEFIARtOR1dSMM73OdJ32o2NU5I1LafRU
Content-Type: application/json
Host: api.extremecloudiq.com

Response Fields

Path Type Description

id

Number

The Mac Profile ID

org_id

Number

The org ID

name

String

The Mac Object Profile name

description

String

The Mac Object Profile description

create_time

String

The create time

update_time

String

The update time

predefined

Boolean

Whether the MAC Oui is predefined

value

String

The MAC octets.

mac_type

String

The MAC object type e.g, "MAC_OUI", "MAC_RANGE" or "MAC_ADDRESS"

defender_defined

Boolean

Whether defender is defined

mac_address_end

String

The MAC address end, only available for "MAC_RANGE"

HTTP Response

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

{
  "id" : 0,
  "create_time" : "2026-07-06T17:27:50.000+0000",
  "update_time" : "2026-07-06T17:27:50.000+0000",
  "org_id" : 0,
  "name" : "Mac-obj",
  "description" : "description",
  "predefined" : false,
  "value" : "123456",
  "mac_type" : "MAC_OUI",
  "defender_defined" : true,
  "mac_address_end" : "string"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/mac-object-profiles/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsIm1hYy1vYmplY3QtcHJvZmlsZXMiLCJtYWMtb2JqZWN0LXByb2ZpbGVzOnIiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXMiLCJtYWMtZmlyZXdhbGwtcG9saWNpZXM6ciIsImlwLWZpcmV3YWxsLXBvbGljaWVzIiwiaXAtZmlyZXdhbGwtcG9saWNpZXM6ciIsInR1bm5lbC1jb25jZW50cmF0b3IiLCJ0dW5uZWwtY29uY2VudHJhdG9yOnIiLCJuZXR3b3JrLXNlcnZpY2VzIiwibmV0d29yay1zZXJ2aWNlczpyIiwicmFkaXVzLXByb3h5IiwicmFkaXVzLXByb3h5OnIiLCJyYWRpdXMtc2VydmVyIiwicmFkaXVzLXNlcnZlcjpyIiwicmFkc2VjLXByb3hpZXMiLCJyYWRzZWMtcHJveGllczpyIiwidXNlcmdyb3VwIiwidXNlcmdyb3VwOnIiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHMiLCJjcmVkZW50aWFsLWRpc3RyaWJ1dGlvbi1ncm91cHM6ciIsInRoaXJkLXBhcnR5LWFwaS1jb25uZWN0aW9uIiwidGhpcmQtcGFydHktYXBpLWNvbm5lY3Rpb246ciIsImRlcGxveW1lbnQiLCJkZXBsb3ltZW50OnIiLCJhZC1zZXJ2ZXIiLCJhZC1zZXJ2ZXI6ciIsImFsZXJ0IiwiYWxlcnQ6ciIsImFsZXJ0LXBvbGljaWVzIiwiYWxlcnQtcG9saWNpZXM6ciIsImFsZXJ0LXN1YnNjcmlwdGlvbnMiLCJhbGVydC1zdWJzY3JpcHRpb25zOnIiLCJhcHAiLCJhcHBsaWNhdGlvbjpyIiwibDMtYWRkcmVzcy1wcm9maWxlIiwibDMtYWRkcmVzcy1wcm9maWxlOnIiLCJ2bGFuLXByb2ZpbGUiLCJ2bGFuLXByb2ZpbGU6ciIsImVuZHVzZXIiLCJlbmR1c2VyOnIiLCJyYWRpdXMtY2xpZW50LW9iamVjdCIsInJhZGl1cy1jbGllbnQtb2JqZWN0OnIiLCJsZGFwLXNlcnZlciIsImxkYXAtc2VydmVyOnIiLCJlbWFpbC10ZW1wbGF0ZSIsImVtYWlsLXRlbXBsYXRlOnIiLCJjZXJ0aWZpY2F0ZSIsImNlcnRpZmljYXRlOnIiLCJjZXJ0aWZpY2F0ZS1idW5kbGVzIiwiY2VydGlmaWNhdGUtYnVuZGxlczpyIiwicmFkaW8tcHJvZmlsZSIsInJhZGlvLXByb2ZpbGU6ciIsImlvdC1wcm9maWxlIiwiaW90LXByb2ZpbGU6ciIsImNsaWVudC1tb25pdG9yLXByb2ZpbGUiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlOnIiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHMiLCJ1c2VyLXByb2ZpbGUtYXNzaWdubWVudHM6ciIsInN3aXRjaC1pbnNwZWN0b3IiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzIiwiY29waWxvdC1hbm9tYWxpZXM6ciIsImxpY2Vuc2VzIiwibGljZW5zZXM6ciIsImNvcGlsb3QtYXNzdXJhbmNlLXNjYW5zOnIiLCJwYWNrZXQtY2FwdHVyZSIsInBhY2tldC1jYXB0dXJlOnIiLCJjb3VudHJ5IiwiY291bnRyeTpyIiwiY2FzIiwiY2FzOnIiLCJjYXMtcG9saWNpZXMiLCJjYXMtcG9saWNpZXM6ciIsImNhcy1tZXRhZGF0YTpyIiwiY25zLXN1YnNjcmlwdGlvbnMiLCJjbnMtc3Vic2NyaXB0aW9uczpyIiwiaG90c3BvdC1wcm9maWxlIiwiaG90c3BvdC1wcm9maWxlOnIiLCJob3RzcG90LXNlcnZpY2UtcHJvdmlkZXItcHJvZmlsZSIsImhvdHNwb3Qtc2VydmljZS1wcm92aWRlci1wcm9maWxlOnIiLCJhZmM6cmVsYXhlZF9yZWFkIiwiYWZjLWZpbHRlci1tZXRhZGF0YTpyZWxheGVkX3JlYWQiLCJhZmMtZXhwb3J0OnJlbGF4ZWRfcmVhZCIsImFmYy1yZXBvcnRzOnJlbGF4ZWRfcmVhZCIsImZsb29yLWFmYy1kZXRhaWxzIiwiZmxvb3ItYWZjLWRldGFpbHM6ciIsInJ0dHMiLCJydHRzOnIiLCJuZy1yZXBvcnRzIiwibmctcmVwb3J0czpyIiwiYWNjdC1hcGktdG9rZW4iLCJhY2N0LWFwaS10b2tlbjpyIiwic2l0ZS1hZmMtc2NoZWR1bGUiLCJzaXRlLWFmYy1zY2hlZHVsZTpyIiwiYXAtc3BlY3RydW0iLCJhcC1zcGVjdHJ1bTpyIiwiYWZjLWNhbmRpZGF0ZXMiLCJuZy1zY2hlZHVsZWQtcmVwb3J0czp3Iiwibmctc2NoZWR1bGVkLWdldC1yZXBvcnRzOnIiLCJhY2NvdW50LXVzZXItZXh0ZXJuYWwiLCJhY2NvdW50LXVzZXItbWUiLCJjbGllbnQtdXNlci1yZXBvcnRzIiwiYWNjb3VudC11c2VyLWlkIiwiYWNjb3VudC11c2VyLWxpc3QiLCJhY2NvdW50LXVzZXItY3JlYXRlIiwiY2xpZW50LXVzZXItZGF0YS11c2FnZSIsImNsaWVudC11c2VyLWZpbHRlci1tZXRhZGF0YSIsImNsaWVudC11c2VyLWdyaWQiLCJjbGllbnQtdXNlci1ncmlkLWV4cG9ydCIsImNsaWVudC11c2VyLXR5cGUtZGlzdHJpYnV0aW9uIiwiYWNjb3VudC11c2VyLW1vZGlmeSIsImNsaWVudC1sb2NhdGlvbiJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzgzMzU4ODcwLCJleHAiOjE3ODM5NjM2NzB9.k9McwiCMD8rEFIARtOR1dSMM73OdJ32o2NU5I1LafRU' \
    -H 'Content-Type: application/json'

Update mac object by ID

PUT /mac-object-profiles/{id}

Path Parameters

Table 131. /mac-object-profiles/{id}
Parameter Description

id

The Mac Object Profile ID

Request Fields

Path Type Description

name

String

The Mac Object Profile name

description

String

The Mac Object Profile description

value

String

The MAC octets.

mac_address_end

String

The MAC address end, only available for "MAC_RANGE"

HTTP Request

PUT /mac-object-profiles/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OmhvbWUiLCJhY2NvdW50OmV4dGVybmFsIiwiYWNjb3VudDp0aGlyZC1wYXJ0eS1hcHBsaWNhdGlvbnMiLCJ2aG06Z2V0LXNldHRpbmciLCJ2aG06dXBkYXRlLXNldHRpbmciLCJ2aG06Z2V0LXN0YXR1cyIsInZpcTpnZXQtYWNjb3VudC1pbmZvIiwidmlxOmJhY2t1cCIsInZpcTpyZXNldCIsInZpcTpnZXQtZGVmYXVsdC1kZXZpY2UtcGFzc3dvcmQiLCJ2aXE6dXBkYXRlLWRlZmF1bHQtZGV2aWNlLXBhc3N3b3JkIiwidmlxOnVwZGF0ZS1kZWZhdWx0LWRldmljZS1wYXNzd29yZC12MSIsInZpcTpkb3dubG9hZCIsInZpcTpleHBvcnQiLCJ2aXE6aW1wb3J0IiwidmlxOmdldC1leHBvcnQtaW1wb3J0LXN0YXR1cyIsInZpcTpnZXQtYmFja3VwLXN0YXR1cyIsImJhY2t1cDpyZXN0b3JlIiwiYmFja3VwOmRlbGV0ZSIsImJhY2t1cDpnZXQtaGlzdG9yeS1ncmlkIiwiaGlxIiwiaGlxOnIiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOnJlbGF4ZWRfcmVhZCIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiZDM2MDpyZWxheGVkX3JlYWQiLCJkYXNoYm9hcmQ6cmVsYXhlZF9yZWFkIiwiY2xpZW50IiwiY2xpZW50OnIiLCJhcHBsaWNhdGlvbnMtcmVwb3J0cyIsImFwcGxpY2F0aW9ucy11c2FnZSIsInJtdXNlci1leHRlcm5hbC1saXN0Iiwicm11c2VyLWV4dGVybmFsLWluZm8iLCJybXVzZXItbWUiLCJybXVzZXItcmVwb3J0cyIsInJtdXNlci1pZCIsInJtdXNlci1saXN0Iiwicm11c2VyIiwibG9jYXRpb25zIiwibG9jYXRpb25zOnIiLCJsb2NhdGlvbnM6Zmxvb3ItbWFwLWxhYmVscyIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1y