The client must present Bearer token to access the protected API endpoints.The Bearer token should be present in the \"Authorization\" request header field and use the \"Bearer\" HTTP authentication scheme to transmit the access token.
User can also provide an optional rate limits parameter to control the rate limiting for the current session." }, { "info": { "name": "User logout (Revoke the current access token)", "type": "http" }, "http": { "method": "POST", "url": "https://api.extremecloudiq.com/logout", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "User logout, the current access token will be revoked and the following access with the same token will be immediately denied." } ] }, { "info": { "name": "Authorization", "type": "folder" }, "items": [ { "info": { "name": "Generate new API token", "type": "http" }, "http": { "method": "POST", "url": "https://api.extremecloudiq.com/auth/apitoken", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Generate a new API token with given permissions and expiration time.
The available permission list can be found via 'GET /auth/permissions' endpoint.
User can also provide an optional rate limits parameter to control the rate limiting for the API token."
},
{
"info": {
"name": "Get current API token details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/auth/apitoken/info",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Introspect current API token and get detail information."
},
{
"info": {
"name": "Validate API token",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/auth/apitoken/:validate"
},
"docs": "Validate JWT format API token."
},
{
"info": {
"name": "Get permissions for current login user",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/auth/permissions",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get permissions for current login user, which are allowed for generating new API tokens."
},
{
"info": {
"name": "Check permissions",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/auth/permissions/:check",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get required permissions for given HTTP request."
}
]
},
{
"info": {
"name": "Operation",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Long-Running Operation (LRO) status and result",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/operations/:operationId",
"params": [
{
"name": "operationId",
"value": "",
"type": "path",
"description": "The operation ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the Long-Running Operation (LRO) status and result.\nThe response will include either result or error if the operation is done."
},
{
"info": {
"name": "Delete Long-Running Operation (LRO)",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/operations/:operationId",
"params": [
{
"name": "operationId",
"value": "",
"type": "path",
"description": "The operation ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "The Long-Running Operation (LRO) can be deleted when the operation is done or in PENDING status."
},
{
"info": {
"name": "Cancel Long-Running Operation (LRO)",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/operations/:operationId/:cancel",
"params": [
{
"name": "operationId",
"value": "",
"type": "path",
"description": "The operation ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "When the cancelable is true in operation metadata the clients are allowed to send a cancel request to ask the backend to cancel the operation.\nThe server makes its best effort to cancel the operation, but success is not guaranteed."
}
]
},
{
"info": {
"name": "Account",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get home ExtremeCloud IQ account info",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/account/home",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get home ExtremeCloud IQ account info."
},
{
"info": {
"name": "List accessible external guest accounts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/account/external",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List accessible external ExtremeCloud IQ accounts."
},
{
"info": {
"name": "Switch to another ExtremeCloud IQ account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/account/:switch",
"params": [
{
"name": "id",
"value": "",
"type": "query",
"description": "The account ID to switch, switch back to home ExtremeCloud IQ account if not provide"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Switch to external ExtremeCloud IQ account or switch back to home ExtremeCloud IQ account."
},
{
"info": {
"name": "Get VIQ Info",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/account/viq",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get account VIQ and license info."
},
{
"info": {
"name": "Backup VIQ",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/account/viq/:backup",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Backup VIQ in ExtremeCloud IQ."
},
{
"info": {
"name": "Get the default device password in the account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/account/viq/default-device-password",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the default device password in the account."
},
{
"info": {
"name": "Update the default device password in the account",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/account/viq/default-device-password",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the default device password in the global setting for accessing the console/shell of the devices."
},
{
"info": {
"name": "Update the default device password with validation",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/v1/account/viq/default-device-password",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the default device password in the global setting for accessing the console/shell of the devices."
},
{
"info": {
"name": "Create VIQ export data",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/account/export",
"params": [
{
"name": "timeoutInSeconds",
"value": "",
"type": "query",
"description": "The maximum export duration"
},
{
"name": "excludeDeviceFirmware",
"value": "",
"type": "query",
"description": "Whether exclude device firmwares from VIQ export file or not"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Export VIQ reports."
},
{
"info": {
"name": "Import VIQ details from a file",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/account/import",
"params": [
{
"name": "timeoutInSeconds",
"value": "",
"type": "query",
"description": "The maximum import duration"
},
{
"name": "resendUserNotifications",
"value": "",
"type": "query",
"description": "Resend Cloud PPSK/RADIUS password through email/SMS."
}
],
"body": {
"type": "multipart-form",
"data": [
{
"name": "file",
"type": "text",
"value": ""
}
]
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Import Viq details."
},
{
"info": {
"name": "Download VIQ reports or logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/account/download",
"params": [
{
"name": "reportName",
"value": "",
"type": "query",
"description": "The name of the report"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Download VIQ exports reports and export or import logs."
},
{
"info": {
"name": "Status of VIQ export/import operation",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/account/export-import-status",
"params": [
{
"name": "reportName",
"value": "",
"type": "query",
"description": "The name of the report"
},
{
"name": "statusType",
"value": "",
"type": "query",
"description": "The operation type- export or import"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Check the current VIQ export or import status."
},
{
"info": {
"name": "Resetting VIQ",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/account/viq/:reset",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Reset VIQ in ExtremeCloud IQ."
},
{
"info": {
"name": "Get Account VHM Setting",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/account/vhm/setting",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Flag status of CoPilot, SSH Aavailibility, Supplemental CLI, AP Out-of-the-box Wireless Onboarding."
},
{
"info": {
"name": "Update Account VHM Setting",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/account/vhm/setting/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Enable/Disable CoPilot, SSH Aavailibility, Supplemental CLI, AP Out-of-the-box Wireless Onboarding."
},
{
"info": {
"name": "Get Account VHM Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/account/vhm/status",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Check VHM Account status like vhm name, current run status."
},
{
"info": {
"name": "Get Backup History Grid",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/backup/history/grid",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Backup History Grid to track and restore backed up database."
},
{
"info": {
"name": "Backup History Restore",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/backup/history/:restore",
"params": [
{
"name": "backup_file",
"value": "",
"type": "query",
"description": "The backup file that needs to be restored."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Restore Backup History in ExtremeCloud IQ."
},
{
"info": {
"name": "Backup History Delete",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/backup/history/delete",
"params": [
{
"name": "backup_files",
"value": "",
"type": "query",
"description": "The list of backup files (comma-separated) that need to be deleted."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete Backup History by backup files."
},
{
"info": {
"name": "Get third party applications",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/third/party/applications",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get third party applications."
}
]
},
{
"info": {
"name": "User",
"type": "folder"
},
"items": [
{
"info": {
"name": "List all users",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/users",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List users with pagination."
},
{
"info": {
"name": "Create new user",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/users",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new user to access."
},
{
"info": {
"name": "Get current user info",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/users/me",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get currently login user info."
},
{
"info": {
"name": "Get user info by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/users/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get user info for a specific user."
},
{
"info": {
"name": "Update user info",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.extremecloudiq.com/users/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Updates user info for a specific user."
},
{
"info": {
"name": "Delete user by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/users/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a specific user."
},
{
"info": {
"name": "List external access users",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/users/external",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of external access users."
},
{
"info": {
"name": "Grant external access",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/users/external",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Grant external access to a specific user."
},
{
"info": {
"name": "Get external access info",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/users/external/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get external access info for a specific external user."
},
{
"info": {
"name": "Update external access info",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.extremecloudiq.com/users/external/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Updates external access info for a specific user."
},
{
"info": {
"name": "Revoke external access",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/users/external/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Revoke external acccess for a specific user."
},
{
"info": {
"name": "List users",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/users/grid",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "search",
"value": "",
"type": "query",
"description": "Search term for user name, email or group"
},
{
"name": "sort_field",
"value": "",
"type": "query",
"description": "Field to sort by"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns a paginated list of users with support for search, filter, and sort."
},
{
"info": {
"name": "List user grid filter metadata",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/users/filter_metadata",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns lists of available values for user_name, group, and source fields used in the user grid."
},
{
"info": {
"name": "Get user type distribution",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/users/type_distribution",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the percentage distribution of connected users by type (PPSK, RADIUS, Others) and the total number of connected users."
},
{
"info": {
"name": "Get user data usage",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/users/data_usage",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns data usage in bytes for each user."
},
{
"info": {
"name": "Export user grid",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/users/grid_export",
"params": [
{
"name": "search",
"value": "",
"type": "query",
"description": "Search term for user name, email or group"
},
{
"name": "sort_field",
"value": "",
"type": "query",
"description": "Field to sort by"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Export the user grid data as a CSV file."
}
]
},
{
"info": {
"name": "HIQ",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get HIQ status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/hiq/status",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Hierarchical ExtremeCloud IQ (HIQ) status."
},
{
"info": {
"name": "Get HIQ context",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/hiq/context",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the current effective HIQ context for reading or creating data in organizations.\nAppliable when HIQ is enabled."
},
{
"info": {
"name": "Set HIQ context",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/hiq/context",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Set the current effective HIQ context for reading or creating data in organizations.\nOnly HIQ Admin can performance this operation when HIQ is enabled."
},
{
"info": {
"name": "Get organizations for reading data",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/hiq/context/reading",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get organizations for reading data (Empty list means reading data from all organizations in the HIQ).\nAppliable when HIQ is enabled."
},
{
"info": {
"name": "Set organizations for reading data",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/hiq/context/reading",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Set organization for reading data (Empty list means reading data from all organizations in the HIQ).\nOnly HIQ Admin can performance this operation."
},
{
"info": {
"name": "Get organization for creating new data",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/hiq/context/creating",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get organization for creating new data (Only one organization is active for creating new data).\nAppliable when HIQ is enabled."
},
{
"info": {
"name": "Set organization for creating new data",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/hiq/context/creating",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Set organization for creating new data (Only one organization is active for creating new data).\nOnly HIQ Admin can performance this operation when HIQ is enabled."
},
{
"info": {
"name": "List all organizations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/hiq/organizations",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List all organizations in current HIQ (Available when HIQ is enabled)."
},
{
"info": {
"name": "Create a new organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/hiq/organizations",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new organization in current HIQ (Available when HIQ is enabled)."
},
{
"info": {
"name": "Delete an existing organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/hiq/organizations/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing organization (Available when HIQ is enabled)."
},
{
"info": {
"name": "Rename an existing organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/hiq/organizations/:id/:rename",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Rename an existing organization (Available when HIQ is enabled)."
}
]
},
{
"info": {
"name": "Location",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create location",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/locations",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new location under the parent location."
},
{
"info": {
"name": "Get location tree",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/locations/tree",
"params": [
{
"name": "parentId",
"value": "",
"type": "query",
"description": "The parent location ID, return root locations if parent is null"
},
{
"name": "expandChildren",
"value": "",
"type": "query",
"description": "Whether to return the child locations recursively, default is true.\nSet it to false to improve performance when there are a lot of child locations."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get location hierarchical tree."
},
{
"info": {
"name": "Get devices on the location hierarchy",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/locations/tree/devices",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "locationId",
"value": "",
"type": "query",
"description": "The location ID, or null for all locations."
},
{
"name": "expandChildren",
"value": "",
"type": "query",
"description": "Whether to return the child locations recursively, default is true.\nSet it to false to improve performance when there are a lot of child locations."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get devices on the location hierarchy with pagination."
},
{
"info": {
"name": "Get maps on the location hierarchy",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/locations/tree/maps",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "locationId",
"value": "",
"type": "query",
"description": "The location ID, or null for all locations."
},
{
"name": "expandChildren",
"value": "",
"type": "query",
"description": "Whether to return the child locations recursively, default is true.\nSet it to false to improve performance when there are a lot of child locations."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get maps on the location hierarchy with pagination."
},
{
"info": {
"name": "Upload floorplan",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/locations/floorplan",
"body": {
"type": "multipart-form",
"data": [
{
"name": "file",
"type": "text",
"value": ""
}
]
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Upload the floorplan map for the VIQ."
},
{
"info": {
"name": "Update location",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/locations/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the location information with the specified location ID."
},
{
"info": {
"name": "Delete location by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/locations/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "force_delete",
"value": "",
"type": "query",
"description": "Force deletion of this location and its descendants recursively"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the location for the specified ID."
},
{
"info": {
"name": "List floors",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/locations/floor",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "name",
"value": "",
"type": "query",
"description": "List floors by name (case insensitive)"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "List floors by IDs"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List pages of floors by filter."
},
{
"info": {
"name": "Create floor",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/locations/floor",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new floor under the parent building."
},
{
"info": {
"name": "Get a floor by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/locations/floor/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the floor for the specified ID."
},
{
"info": {
"name": "Update floor",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/locations/floor/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update floor information with the floor ID."
},
{
"info": {
"name": "Delete floor by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/locations/floor/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the floor for the specified ID."
},
{
"info": {
"name": "List buildings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/locations/building",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "name",
"value": "",
"type": "query",
"description": "List buildings by name (case insensitive)"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "List buildings by IDs"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List pages of buildings by filter."
},
{
"info": {
"name": "Create building",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/locations/building",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new building under the parent location."
},
{
"info": {
"name": "Get a building by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/locations/building/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the building for the specified ID."
},
{
"info": {
"name": "Update building",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/locations/building/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the building information with the building ID."
},
{
"info": {
"name": "Delete building by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/locations/building/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "force_delete",
"value": "",
"type": "query",
"description": "Force deletion of this building and its descendants recursively"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the building for the specified ID."
},
{
"info": {
"name": "List sites",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/locations/site",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "name",
"value": "",
"type": "query",
"description": "List sites by name (case insensitive)"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "List sites by IDs"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List pages of sites by filter."
},
{
"info": {
"name": "Create site",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/locations/site",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new site under the GENERIC folder."
},
{
"info": {
"name": "Get site by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/locations/site/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the site for the specified ID."
},
{
"info": {
"name": "Update site by ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/locations/site/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the site information with the site ID."
},
{
"info": {
"name": "Delete site by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/locations/site/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "force_delete",
"value": "",
"type": "query",
"description": "Force deletion of this site and its descendants recursively"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the site for the specified ID."
},
{
"info": {
"name": "Get a wall types",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/locations/wall/type",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve the list of wall types, including both predefined and custom ones."
},
{
"info": {
"name": "Create a wall type",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/locations/wall/type",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a custom wall type."
},
{
"info": {
"name": "Update a wall type",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/locations/wall/type/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the custom wall type with the specified ID."
},
{
"info": {
"name": "Delete a wall type",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/locations/wall/type/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the custom wall type for the specified ID."
},
{
"info": {
"name": "Find references of a wall type",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/locations/wall/type/references/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Find all floors a/o sites referencing a wall type by its ID."
}
]
},
{
"info": {
"name": "Device",
"type": "folder"
},
"items": [
{
"info": {
"name": "[LRO] List devices",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "locationIds",
"value": "",
"type": "query",
"description": "The location IDs"
},
{
"name": "locationId",
"value": "",
"type": "query",
"description": "Location Id"
},
{
"name": "connected",
"value": "",
"type": "query",
"description": "The device connect status"
},
{
"name": "adminStates",
"value": "",
"type": "query",
"description": "The device admin states"
},
{
"name": "macAddresses",
"value": "",
"type": "query",
"description": "The device mac addresses"
},
{
"name": "sns",
"value": "",
"type": "query",
"description": "The device serial numbers"
},
{
"name": "hostnames",
"value": "",
"type": "query",
"description": "The device host names"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
},
{
"name": "views",
"value": "",
"type": "query",
"description": "The views to return device fields (Check fields for each view at XiqDeviceView schema)"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "The device fields to return"
},
{
"name": "nullField",
"value": "",
"type": "query",
"description": "The device empty field, only returns the selected field that is null"
},
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
},
{
"name": "configMismatch",
"value": "",
"type": "query",
"description": "Config audit status(MATCHED(false) or UNMATCHED(true))"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List devices with filters and pagination."
},
{
"info": {
"name": "Onboard Devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:onboard",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Onboard devices for all devices, such as Extreme/Aerohive, EXOS, VOSS, WiNG, Dell, and Digital Twin.\nThis is asynchronized operation to support massive device onboarding."
},
{
"info": {
"name": "[LRO] Advanced Onboard Devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:advanced-onboard",
"params": [
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Advanced onboard devices for all devices, such as Extreme/Aerohive, EXOS, VOSS, WiNG, and Dell. Advanced onboard devices will allow the user to set the device hostname, attach the device location, associate network policy, etc. in a single API request. To avoid API timeout when onboarding a large number of devices, please make sure to enable async mode (set async=true in query parameter) and use long-running operation API to query the result."
},
{
"info": {
"name": "Change status to Managed",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:manage",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Change device management status to Managed for the target devices."
},
{
"info": {
"name": "Change status to Unmanaged",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:unmanage",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Change device management status to Unmanaged for the target devices."
},
{
"info": {
"name": "[LRO] Send CLI to devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:cli",
"params": [
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Send CLI commands to the target devices. This API can be run at async mode, please follow the Long-Running Operation (LRO) guide to track the progress and the result."
},
{
"info": {
"name": "Reboot devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:reboot",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Reboot the target devices."
},
{
"info": {
"name": "Delete devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:delete",
"params": [
{
"name": "force_delete",
"value": "",
"type": "query",
"description": "Force deletion of devices"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Bulk delete the devices matching the filter criteria."
},
{
"info": {
"name": "[LRO] Reset devices to factory default",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:reset",
"params": [
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Reset multiple devices to factory default settings."
},
{
"info": {
"name": "Query location for multiple devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/location/:query",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Query the location for the target devices."
},
{
"info": {
"name": "Assign location to multiple devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/location/:assign",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Assign the location to the target devices."
},
{
"info": {
"name": "Revoke location for multiple devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/location/:revoke",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Revoke the location from the target devices."
},
{
"info": {
"name": "Query network policy for multiple devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/network-policy/:query",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Query the network policy for the target devices."
},
{
"info": {
"name": "Assign RADIUS proxy to devices",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/devices/radius-proxy/:assign",
"params": [
{
"name": "ids",
"value": "",
"type": "query",
"description": "The device IDs"
},
{
"name": "radiusProxyId",
"value": "",
"type": "query",
"description": "The RADIUS proxy ID to assign"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Assign a RADIUS proxy to multiple devices."
},
{
"info": {
"name": "Assign network policy to multiple devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/network-policy/:assign",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Assign the network policy to the target devices."
},
{
"info": {
"name": "Revoke network policy for multiple devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/network-policy/:revoke",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Revoke the network policy from the target devices."
},
{
"info": {
"name": "List assigned devices for network policy",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/network-policy/:policyId",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The network policy ID"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List assigned devices for the network policy with pagination."
},
{
"info": {
"name": "Assign a country code to devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/country-code/:assign",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Assign the country code to one or more devices."
},
{
"info": {
"name": "Change device OS mode",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/os/:change",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Change OS mode for AP or Switch."
},
{
"info": {
"name": "Change iBeacon settings for devices",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/devices/ibeacon",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the existing or create new iBeacon settings for multiple devices."
},
{
"info": {
"name": "Get device stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/stats",
"params": [
{
"name": "locationId",
"value": "",
"type": "query",
"description": "The location ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get device stats, such as total device count, managed device count, connected device count, etc."
},
{
"info": {
"name": "Get device info for a specific device",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "views",
"value": "",
"type": "query",
"description": "The views to return device fields (Check details at XiqDeviceView schema)"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "The device fields to return"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get device info for a specific device."
},
{
"info": {
"name": "Delete a device",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/devices/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "force_delete",
"value": "",
"type": "query",
"description": "Force deletion of device"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a specific device."
},
{
"info": {
"name": "Change admin state to 'Managed' for a device",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:id/:manage",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Change device management status to Managed for a specific device."
},
{
"info": {
"name": "Change admin state to 'Unmanaged' for a device",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:id/:unmanage",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Change device admin state to 'Unmanaged' for a specific device."
},
{
"info": {
"name": "Send CLI to a device",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:id/:cli",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Send CLI commands to a specific device."
},
{
"info": {
"name": "Reboot a device",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:id/:reboot",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Reboot a specific device."
},
{
"info": {
"name": "[LRO] Reset a device to factory default",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:id/:reset",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Reset a device to factory default settings."
},
{
"info": {
"name": "Change hostname for a device",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/devices/:id/hostname",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "hostname",
"value": "",
"type": "query",
"description": "The new hostname"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Change hostname for a specific device."
},
{
"info": {
"name": "Change description for a device",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/devices/:id/description",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Change description for a specific device."
},
{
"info": {
"name": "Get location for a device",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/:id/location",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the location info for a specific device."
},
{
"info": {
"name": "Assign location to a device",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/devices/:id/location",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Assign a location to a specific device with extra map and geographical properties."
},
{
"info": {
"name": "Revoke location for a device",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/devices/:id/location",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Revoke the assigned location for a specific device."
},
{
"info": {
"name": "Get network policy for a device",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/:id/network-policy",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the network policy for a specific device."
},
{
"info": {
"name": "Assign network policy to a device",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/devices/:id/network-policy",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "networkPolicyId",
"value": "",
"type": "query",
"description": "The network policy ID to assign"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Assign a network policy to a specific device."
},
{
"info": {
"name": "Revoke network policy for a device",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/devices/:id/network-policy",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Revoke the assigned network policy for a specific device."
},
{
"info": {
"name": "Override SSID for a device",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:id/ssid/:override",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Override SSID broadcast name/passphrase for a specific device."
},
{
"info": {
"name": "Get SSID status for a device",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/:id/ssid/status",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the SSIDs status on each wifi interface for a specific device."
},
{
"info": {
"name": "Enable or disable SSID for a device",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:id/ssid/status/:change",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Enable or disable SSIDs on the given wifi interfaces for a specific device."
},
{
"info": {
"name": "List alarms for a device",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/:id/alarms",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List alarms for a specific device."
},
{
"info": {
"name": "Get device CPU/memory usage history",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/:id/history/cpu-mem",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "interval",
"value": "",
"type": "query",
"description": "The aggregate interval in milliseconds"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get average device CPU and memory usage history."
},
{
"info": {
"name": "Get the device iBeacon setting",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/:id/ibeacon",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the device iBeacon setting by device ID."
},
{
"info": {
"name": "Get the device IoT Wireless Interface settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/:id/iot",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the device IoT profile Wireless Interface settings by device ID."
},
{
"info": {
"name": "Enable IoT Wireless Interface settings on device",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:id/iot/:enable",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Enable and attach IoT profile Wireless Interface settings by device ID and IoT profile ID."
},
{
"info": {
"name": "Disable IoT Wireless Interface settings on device",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:id/iot/:disable",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Disable and detach IoT profile Wireless Interface settings by device ID and IoT profile ID."
},
{
"info": {
"name": "List Digital Twin product information",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/digital-twin",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "makes",
"value": "",
"type": "query",
"description": "List by makes or any with null/empty makes."
},
{
"name": "models",
"value": "",
"type": "query",
"description": "List by makes or any with null/empty models."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List of Digital Twin product information with pagination."
},
{
"info": {
"name": "Bounce port of a device",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:id/bounce-port",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Bounce port for the given device id."
},
{
"info": {
"name": "Monitor refresh device information",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:id/monitor/:refresh",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "function",
"value": "",
"type": "query",
"description": "The function to refresh. ROUTE, MAC"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "The request monitor refresh the device information."
},
{
"info": {
"name": "Monitor refresh device information status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/:id/monitor/refresh/status",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "taskKey",
"value": "",
"type": "query",
"description": "Key for the device refresh"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "The request monitor refresh the device information status."
},
{
"info": {
"name": "Get Installation devices",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/installation-report",
"params": [
{
"name": "id",
"value": "",
"type": "query",
"description": "Unique id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List the device installation report."
},
{
"info": {
"name": "Start the Thread Commissioner",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:id/thread/commissioner/:start",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Start the Thread Commissioner."
},
{
"info": {
"name": "Stop the Thread Commissioner",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:id/thread/commissioner/:stop",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Stop the Thread Commissioner."
},
{
"info": {
"name": "List radio information",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/radio-information",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "deviceIds",
"value": "",
"type": "query",
"description": "The device IDs"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List radio and BSS information associated to a device."
},
{
"info": {
"name": "Download device gallery image",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/:id/gallery-image",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "imageName",
"value": "",
"type": "query",
"description": "The image name"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Download the image file from the device media gallery."
},
{
"info": {
"name": "Get client monitor setting of a device",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/:id/client-monitor",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the device-specific client monitor setting that override SSID's client monitor profile."
},
{
"info": {
"name": "Configure client monitor setting of a device",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/devices/:id/client-monitor",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Configure the device-specific client monitor setting that override SSID's client monitor profile."
},
{
"info": {
"name": "Delete client monitor setting for a device",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/devices/:id/client-monitor",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the device-specific client monitor setting that override SSID's client monitor profile."
},
{
"info": {
"name": "Get FTM Settings by device ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/:id/ftm-settings",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get FTM Settings for the specified device ID."
},
{
"info": {
"name": "Configure (create / update) device FTM Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/devices/:id/ftm-settings",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Configure (create / update) device FTM Settings."
},
{
"info": {
"name": "Delete FTM Settings by device ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/devices/:id/ftm-settings",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete FTM Settings by device ID."
},
{
"info": {
"name": "Get device radio operating modes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/:id/radio-operating-mode",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the device radio operating mode by device ID at device level."
},
{
"info": {
"name": "Configure radio operating mode of a device",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/devices/:id/radio-operating-mode",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Configure the device-specific radio operating mode setting at device level and set the radio profiles to the default radio profiles.
If the radio profile ID is not provided for a wifi interface in the request, the default Radio Profile will be added to device."
},
{
"info": {
"name": "Get the status of devices (online/offline)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/status",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "locationId",
"value": "",
"type": "query",
"description": "The location ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the connection status of the devices."
},
{
"info": {
"name": "Get Device connection status",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/rm-devices-connection-status",
"params": [
{
"name": "deviceCategory",
"value": "",
"type": "query",
"description": "The device category - wired, wireless (Defaults to \"ALL\" if not selected)"
},
{
"name": "deviceTypes",
"value": "",
"type": "query",
"description": "The device types to return (REAL by default)"
},
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned location"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of total devices, offline devices, online devices for both wired and wireless devices based on the provided siteIds filters."
},
{
"info": {
"name": "[LRO] List RM Devices Page",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/rm-devices-page",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search"
},
{
"name": "connected",
"value": "",
"type": "query",
"description": "The device connect status"
},
{
"name": "configMismatch",
"value": "",
"type": "query",
"description": "Config audit status(MATCHED(false) or UNMATCHED(true))"
},
{
"name": "adminStates",
"value": "",
"type": "query",
"description": "The device admin states"
},
{
"name": "deviceCategory",
"value": "",
"type": "query",
"description": "The device category - wired, wireless (Defaults to \"ALL\" if not selected)"
},
{
"name": "deviceTypes",
"value": "",
"type": "query",
"description": "The device types to return"
},
{
"name": "stackedView",
"value": "",
"type": "query",
"description": "Whether to include only virtual stack (when set to true) or also the stack members (when set to false)"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
},
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
},
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned location"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List RM Devices Page with filters and pagination."
},
{
"info": {
"name": "Get Metadata Information for given Device",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/rm-devices-metadata",
"params": [
{
"name": "deviceCategory",
"value": "",
"type": "query",
"description": "The device category - wired, wireless (Defaults to \"ALL\" if not selected)"
},
{
"name": "adminStates",
"value": "",
"type": "query",
"description": "The device admin states"
},
{
"name": "deviceTypes",
"value": "",
"type": "query",
"description": "The device types to return"
},
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned location"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get metadata info for RM Device Page with site ID filter."
},
{
"info": {
"name": "Get Stack Member Info for given Stack",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/rm-devices-stack/:stackId",
"params": [
{
"name": "stackId",
"value": "",
"type": "path",
"description": "The stack ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Stack Member Information for given stack ID."
},
{
"info": {
"name": "[LRO] Export RM devices page",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/rm-devices-page/export",
"params": [
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search"
},
{
"name": "connected",
"value": "",
"type": "query",
"description": "The device connect status"
},
{
"name": "configMismatch",
"value": "",
"type": "query",
"description": "Config audit status(MATCHED(false) or UNMATCHED(true))"
},
{
"name": "adminStates",
"value": "",
"type": "query",
"description": "The device admin states"
},
{
"name": "deviceCategory",
"value": "",
"type": "query",
"description": "The device category - wired, wireless (Defaults to \"ALL\" if not selected)"
},
{
"name": "deviceTypes",
"value": "",
"type": "query",
"description": "The device types to return"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
},
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
},
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned location"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Export RM devices page as a csv file."
},
{
"info": {
"name": "Download the Export CSV file for Device Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/devices/reports/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The report ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the CSV File of the device status based on the provided filters."
},
{
"info": {
"name": "Get metadata for supported device actions",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/actions-support-metadata",
"params": [
{
"name": "deviceActions",
"value": "",
"type": "query",
"description": "List of device actions to retrieve metadata info"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve metadata information about supported device actions for a given product type."
},
{
"info": {
"name": "List SSH active sessions",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/:ssh-active-sessions",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List active SSH sessions for devices."
},
{
"info": {
"name": "Start the Thread Commissioner by Building IDs",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/thread/commissioner/start",
"params": [
{
"name": "ownerId",
"value": "",
"type": "query",
"description": "The Owner Id"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Start the Thread Commissioner by Building IDs."
},
{
"info": {
"name": "Stop the Thread Commissioner by Building IDs",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/devices/thread/commissioner/stop",
"params": [
{
"name": "ownerId",
"value": "",
"type": "query",
"description": "The Owner Id"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Stop the Thread Commissioner by Building IDs."
}
]
},
{
"info": {
"name": "Network Policy",
"type": "folder"
},
"items": [
{
"info": {
"name": "List network policies",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/network-policies",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "policyNames",
"value": "",
"type": "query",
"description": "The list of policy names"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of network policies."
},
{
"info": {
"name": "Create network policy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/network-policies",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new network policy."
},
{
"info": {
"name": "Get the network policy",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/network-policies/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get an existing network policy by ID."
},
{
"info": {
"name": "Update the network policy",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/network-policies/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update network policy by ID."
},
{
"info": {
"name": "Delete the network policy",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/network-policies/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing network policy by ID."
},
{
"info": {
"name": "List SSIDs for a network policy",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/network-policies/:id/ssids",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of SSIDs for a specific network policy."
},
{
"info": {
"name": "Add SSIDs to a network policy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/network-policies/:id/ssids/:add",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Add SSIDs to a specific network policy."
},
{
"info": {
"name": "Removes SSIDs from the network policy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/network-policies/:id/ssids/:remove",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Removing multiple SSIDs from the network policy."
}
]
},
{
"info": {
"name": "Network Scorecard",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get device's overall health for given location",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/network-scorecard/locations/:id/device-health",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the device's overall health details for given location."
},
{
"info": {
"name": "Get clients' overall health for given location",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/network-scorecard/locations/:id/client-health",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "vlans",
"value": "",
"type": "query",
"description": "The associate vlan IDs"
},
{
"name": "userProfileNames",
"value": "",
"type": "query",
"description": "The user profile names"
},
{
"name": "ssids",
"value": "",
"type": "query",
"description": "The SSIDs"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the clients' overall health details for given location."
},
{
"info": {
"name": "Get devices' Wi-Fi health for given location",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/network-scorecard/locations/:id/wifi-health",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the devices' Wi-Fi health details for given location."
},
{
"info": {
"name": "Get devices' network health for given location",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/network-scorecard/locations/:id/network-health",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the devices' network health details for given location."
},
{
"info": {
"name": "Get devices' services health for given location",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/network-scorecard/locations/:id/services-health",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the devices' services health details for given location."
}
]
},
{
"info": {
"name": "Client",
"type": "folder"
},
"items": [
{
"info": {
"name": "List active clients",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/clients/active",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "The client fields to return"
},
{
"name": "views",
"value": "",
"type": "query",
"description": "The views to return client fields (Check fields for each view at XiqClientView schema)"
},
{
"name": "locationIds",
"value": "",
"type": "query",
"description": "The location IDs"
},
{
"name": "deviceIds",
"value": "",
"type": "query",
"description": "The device IDs"
},
{
"name": "vlans",
"value": "",
"type": "query",
"description": "The associate vlan IDs"
},
{
"name": "userProfileNames",
"value": "",
"type": "query",
"description": "The user profile names"
},
{
"name": "ssids",
"value": "",
"type": "query",
"description": "The SSIDs"
},
{
"name": "clientOsNames",
"value": "",
"type": "query",
"description": "The client os names"
},
{
"name": "clientConnectionTypes",
"value": "",
"type": "query",
"description": "The client connection types - 1 - WIRELESS, 2 - WIRED, -1 - UNDETERMINED"
},
{
"name": "clientHealthStatus",
"value": "",
"type": "query",
"description": "The client health status - 1 - HEALTHY, 2 - POOR"
},
{
"name": "excludeLocallyManaged",
"value": "",
"type": "query",
"description": "Return Cloud managed Devices' clients. Default value - false"
},
{
"name": "userNames",
"value": "",
"type": "query",
"description": "The user names."
},
{
"name": "searchString",
"value": "",
"type": "query",
"description": "The SearchString"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "Sort field. Available values - AUTH_METHOD, CHANNEL, CONNECTED_VIA, CONNECTION_TYPE, DEVICE_NAME, HOST_NAME, IPV4, IPV6, MAC, NAC_DETAILS, NAC_PROFILE, OS_TYPE, REPORTED_BY, START_TIME, USER_NAME, USER_PROFILE, VLAN"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Sort order (ascending by default). Available values - ASC, DESC"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List active clients with filters and pagination."
},
{
"info": {
"name": "Get client summary metrics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/clients/summary",
"params": [
{
"name": "locationIds",
"value": "",
"type": "query",
"description": "The location IDs"
},
{
"name": "deviceIds",
"value": "",
"type": "query",
"description": "The device IDs"
},
{
"name": "vlans",
"value": "",
"type": "query",
"description": "The associate VLAN IDs"
},
{
"name": "userProfileNames",
"value": "",
"type": "query",
"description": "The user profile names"
},
{
"name": "ssids",
"value": "",
"type": "query",
"description": "The SSIDs"
},
{
"name": "clientOsNames",
"value": "",
"type": "query",
"description": "The client os names"
},
{
"name": "clientHealthStatus",
"value": "",
"type": "query",
"description": "The client health status - 1 - HEALTHY, 2 - POOR"
},
{
"name": "excludeLocallyManaged",
"value": "",
"type": "query",
"description": "Return Cloud managed Devices' clients. Default value - false"
},
{
"name": "searchString",
"value": "",
"type": "query",
"description": "The SearchString"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get number of connected wireless clients and number of detected wired clients."
},
{
"info": {
"name": "Get usage per client",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/clients/usage",
"params": [
{
"name": "clientIds",
"value": "",
"type": "query",
"description": "The client IDs"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the client usage."
},
{
"info": {
"name": "Get client info",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/clients/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "The client fields to return"
},
{
"name": "views",
"value": "",
"type": "query",
"description": "The views to return client fields (Check fields for each view at XiqClientView schema)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get client detailed information."
},
{
"info": {
"name": "Set the aliases for multiple clients",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/clients/alias",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Bulk update the aliases for multiple clients based on the mac addresses. Empty or null alias value deletes the previous client alias."
},
{
"info": {
"name": "Get active clients count",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/clients/active/count",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "The client fields to return"
},
{
"name": "views",
"value": "",
"type": "query",
"description": "The views to return client fields (Check fields for each view at XiqClientView schema)"
},
{
"name": "locationIds",
"value": "",
"type": "query",
"description": "The location IDs"
},
{
"name": "deviceIds",
"value": "",
"type": "query",
"description": "The device IDs"
},
{
"name": "vlans",
"value": "",
"type": "query",
"description": "The associate vlan IDs"
},
{
"name": "userProfileNames",
"value": "",
"type": "query",
"description": "The user profile names"
},
{
"name": "ssids",
"value": "",
"type": "query",
"description": "The SSIDs"
},
{
"name": "clientOsNames",
"value": "",
"type": "query",
"description": "The client os names"
},
{
"name": "clientConnectionTypes",
"value": "",
"type": "query",
"description": "The client connection types - 1 - WIRELESS, 2 - WIRED, -1 - UNDETERMINED"
},
{
"name": "clientHealthStatus",
"value": "",
"type": "query",
"description": "The client health status - 1 - HEALTHY, 2 - POOR"
},
{
"name": "excludeLocallyManaged",
"value": "",
"type": "query",
"description": "Return Cloud managed Devices' clients. Default value - false"
},
{
"name": "searchString",
"value": "",
"type": "query",
"description": "The SearchString"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List active clients count."
},
{
"info": {
"name": "Disconnect the client",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/clients/byMac/:clientMac",
"params": [
{
"name": "clientMac",
"value": "",
"type": "path",
"description": "The mac address of client"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Disconnect the client."
},
{
"info": {
"name": "Get client info by mac",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/clients/getByMac/:clientMac",
"params": [
{
"name": "clientMac",
"value": "",
"type": "path",
"description": "The mac address of client"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "The client fields to return"
},
{
"name": "views",
"value": "",
"type": "query",
"description": "The views to return client fields (Check fields for each view at XiqClientView schema)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get detailed client information by mac."
},
{
"info": {
"name": "Disconnect clients",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/clients/disconnect",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Disconnect one or more clients by their MAC addresses."
}
]
},
{
"info": {
"name": "Application",
"type": "folder"
},
"items": [
{
"info": {
"name": "List the applications",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/applications",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Application Name"
},
{
"name": "detectionProtocol",
"value": "",
"type": "query",
"description": "Application Detection Protocol, only for custom Application"
},
{
"name": "detectionType",
"value": "",
"type": "query",
"description": "Application Detection Type, only for custom Application"
},
{
"name": "predefined",
"value": "true",
"type": "query",
"description": "Flag to filter predefined or custom Application"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of applications by filter."
},
{
"info": {
"name": "List the TopN applications",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/applications/top:n",
"params": [
{
"name": "n",
"value": "",
"type": "path",
"description": "The TopN number"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List the TopN applications by usage."
},
{
"info": {
"name": "List the TopN clients for a application",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/applications/:id/clients/top:n",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "n",
"value": "",
"type": "path",
"description": "The TopN number"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List the TopN clients by usage for a specific application."
},
{
"info": {
"name": "List application usage summary",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/applications/grid",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "sort_field",
"value": "",
"type": "query",
"description": "Field to sort by (e.g., usage, percentage_usage, clients, users)"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
},
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
},
{
"name": "search",
"value": "",
"type": "query",
"description": "Search term for application or category name"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns a paginated list of application usage summaries with support for search, filter, and sort."
},
{
"info": {
"name": "List application categories and names",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/applications/category_metadata",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns a list of unique application category names along with associated application names used in application usage data."
},
{
"info": {
"name": "Export application usage summary",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/applications/grid/export",
"params": [
{
"name": "search",
"value": "",
"type": "query",
"description": "Search term for application or category name"
},
{
"name": "sort_field",
"value": "",
"type": "query",
"description": "Field to sort by (e.g., usage, percentage_usage, clients, users)"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
},
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Export the application usage summary grid as a CSV file."
}
]
},
{
"info": {
"name": "Alert",
"type": "folder"
},
"items": [
{
"info": {
"name": "List the alerts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/alerts",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "acknowledged",
"value": "",
"type": "query",
"description": "Default is null, which will return all alerts. Set it to false to only return unacknowledged alerts. Otherwise, set it to true only return acknowledged alerts."
},
{
"name": "categoryIds",
"value": "",
"type": "query",
"description": "The alert category Ids to filter, use alert/metadata API to get category information."
},
{
"name": "severityIds",
"value": "",
"type": "query",
"description": "The alert severity identifiers to filter. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info."
},
{
"name": "messageMetadataIds",
"value": "",
"type": "query",
"description": "The message metadata ID list to filter. Use /alert/metadata/events-by-category or /alert/metadata/metrics-by-metricset APIs to get the message metadata information."
},
{
"name": "siteId",
"value": "",
"type": "query",
"description": "The site ID to filter."
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to filter, such as summery, severity, source and etc."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of alerts by filter."
},
{
"info": {
"name": "Acknowledge the alerts",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/alerts/:acknowledge",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Acknowledge the alerts by ID list."
},
{
"info": {
"name": "Count the alerts by different grouping",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/alerts/count-by-:group",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "group",
"value": "",
"type": "path",
"description": "The group to count from"
},
{
"name": "acknowledged",
"value": "",
"type": "query",
"description": "Default is null, which will return all alerts. Set it to false to only return unacknowledged alerts. Otherwise, set it to true only return acknowledged alerts."
},
{
"name": "siteId",
"value": "",
"type": "query",
"description": "The site ID to filter."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Count the number of alerts and events based on Severity, Category, and Alert Type."
},
{
"info": {
"name": "[LRO] Create alert event report",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/alerts/reports",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "acknowledged",
"value": "",
"type": "query",
"description": "Default is null, which will return all alerts. Set it to false to only return unacknowledged alerts. Otherwise, set it to true only return acknowledged alerts."
},
{
"name": "categoryIds",
"value": "",
"type": "query",
"description": "The alert category Ids to filter, use alert/metadata API to get category information."
},
{
"name": "severityIds",
"value": "",
"type": "query",
"description": "The alert severity identifiers to filter. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info."
},
{
"name": "messageMetadataIds",
"value": "",
"type": "query",
"description": "The message metadata ID list to filter. Use /alert/metadata/events-by-category or /alert/metadata/metrics-by-metricset APIs to get the message metadata information."
},
{
"name": "siteId",
"value": "",
"type": "query",
"description": "The site to filter, return global data if not specified"
},
{
"name": "timeZoneOffset",
"value": "",
"type": "query",
"description": "The time zone off set"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to filter, such as summery, severity, source and etc."
},
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates a report page of alert event. This API can be run at async mode, please follow the Long-Running Operation (LRO) guide to track the progress and the result."
},
{
"info": {
"name": "Download an alert event report",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/alerts/reports/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The report ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Download report of alert event ."
},
{
"info": {
"name": "List email subscriptions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/alert-subscriptions/emails",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List all email subscriptions."
},
{
"info": {
"name": "Create email subscription",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/alert-subscriptions/emails",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create email subscription."
},
{
"info": {
"name": "[LRO] Delete alert subscription email in bulk",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/alert-subscriptions/emails/:delete",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete alert subscription email by a list of IDs.This API can be run at async mode, please follow the Long-Running Operation (LRO) guide to track the progress and the result."
},
{
"info": {
"name": "Get email subscription info for a specific email",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/alert-subscriptions/emails/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get email subscription info for a specific email."
},
{
"info": {
"name": "Update email subscription",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/alert-subscriptions/emails/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update email subscription."
},
{
"info": {
"name": "Delete email subscription",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/alert-subscriptions/emails/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an exist email subscription."
},
{
"info": {
"name": "External email address verification",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/alert-subscriptions/emails/:id/:verify",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "User sends a verification email to the specified email address to verify, by clicking the verify link/button in the email."
},
{
"info": {
"name": "List webhook subscriptions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/alert-subscriptions/webhooks",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List webhook subscriptions."
},
{
"info": {
"name": "Create webhook subscription",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/alert-subscriptions/webhooks",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create webhook subscription."
},
{
"info": {
"name": "[LRO] Delete alert subscription webhook in bulk",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/alert-subscriptions/webhooks/:delete",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete alert subscription webhook by a list of IDs.This API can be run at async mode, please follow the Long-Running Operation (LRO) guide to track the progress and the result."
},
{
"info": {
"name": "Get webhook subscription info for a specific url",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/alert-subscriptions/webhooks/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get webhook subscription info for a specific url."
},
{
"info": {
"name": "Update webhook subscription",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/alert-subscriptions/webhooks/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update webhook subscription."
},
{
"info": {
"name": "Delete webhook subscription",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/alert-subscriptions/webhooks/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an exist webhook subscription."
},
{
"info": {
"name": "List ServiceNow subscriptions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/alert-subscriptions/servicenow",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List all ServiceNow subscriptions."
},
{
"info": {
"name": "Create ServiceNow subscription",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/alert-subscriptions/servicenow",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create ServiceNow subscription."
},
{
"info": {
"name": "Delete alert ServiceNow subscription in bulk",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/alert-subscriptions/servicenow/:delete",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete alert ServiceNow subscription by a list of provided IDs."
},
{
"info": {
"name": "Get a specific ServiceNow subscription",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/alert-subscriptions/servicenow/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get ServiceNow subscription info for a specific ServiceNow account."
},
{
"info": {
"name": "Update ServiceNow subscription",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/alert-subscriptions/servicenow/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update ServiceNow subscription."
},
{
"info": {
"name": "Partial or full update ServiceNow subscription",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.extremecloudiq.com/alert-subscriptions/servicenow/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Partial or full update ServiceNow subscription."
},
{
"info": {
"name": "Delete ServiceNow subscription",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/alert-subscriptions/servicenow/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an exist ServiceNow subscription."
},
{
"info": {
"name": "List all alert policies",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/alert-policies",
"params": [
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to filter, such as policy name or site name"
},
{
"name": "policyType",
"value": "",
"type": "query",
"description": "The policy type to filter, such as SITE or GLOBAL"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a list of all alert policies belonging to the current user and an overview of their associated alert rules. The details for the rules is available from the alert policy rules API."
},
{
"info": {
"name": "Create a site based alert policy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/alert-policies",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new site-based alert policy. The global policy for each account is created automatically."
},
{
"info": {
"name": "Get details of an alert policy",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/alert-policies/:policyId",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The alert policy identifier."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the details related to a specific alert policy, given the policy's identifier."
},
{
"info": {
"name": "Update a site-based alert policy",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/alert-policies/:policyId",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The alert policy identifier."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Modify a site-based alert policy's details, including the policy name and sites. The global policy cannot be updated. The sites can be obtained from the alerts/sites API."
},
{
"info": {
"name": "Delete a site-based alert policy",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/alert-policies/:policyId",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The alert policy identifier."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an alert policy. All the associated alert rules will be deleted as well. The global policy cannot be deleted."
},
{
"info": {
"name": "The list of current owner's available sites",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/alert-policies/available-sites",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List all sites belonging to the current owner. If the site has been configured an alert policy, then the site will not be available."
},
{
"info": {
"name": "Get details of an alert rule",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/alert-policies/:policyId/rules/:ruleId",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The alert policy identifier."
},
{
"name": "ruleId",
"value": "",
"type": "path",
"description": "The alert rule identifier."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the full details of an alert rule's state."
},
{
"info": {
"name": "Update an alert rule",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/alert-policies/:policyId/rules/:ruleId",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The alert policy identifier."
},
{
"name": "ruleId",
"value": "",
"type": "path",
"description": "The alert rule identifier."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the state of an alert rule. The rule's identifier may change as a result of this operation."
},
{
"info": {
"name": "Enable a rule from an alert policy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/alert-policies/:policyId/rules/:ruleId/:enable",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The alert policy identifier."
},
{
"name": "ruleId",
"value": "",
"type": "path",
"description": "The alert rule identifier."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Set the status of a rule to enabled. The rule's identifier may change as a result of this operation."
},
{
"info": {
"name": "Disable a rule from an alert policy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/alert-policies/:policyId/rules/:ruleId/:disable",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The alert policy identifier."
},
{
"name": "ruleId",
"value": "",
"type": "path",
"description": "The alert rule identifier."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Set the status of a rule to disabled. The rule's identifier may change as a result of this operation."
}
]
},
{
"info": {
"name": "Log",
"type": "folder"
},
"items": [
{
"info": {
"name": "List audit logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/logs/audit",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "categories",
"value": "",
"type": "query",
"description": "Audit category"
},
{
"name": "username",
"value": "",
"type": "query",
"description": "The user login name"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970. Note: endTime - startTime must be no greater than 2592000000 (30 days)"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The case-insensitive keyword to search in description"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The field for sorting"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of audit logs."
},
{
"info": {
"name": "Get audit log full descriptions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/logs/audit/full-descriptions/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get audit log full descriptions by ID."
},
{
"info": {
"name": "Create audit logs report",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/logs/audit/reports",
"params": [
{
"name": "categories",
"value": "",
"type": "query",
"description": "Audit category"
},
{
"name": "username",
"value": "",
"type": "query",
"description": "The user login name"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970, default is 0 if not specified or is negative"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "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)"
},
{
"name": "timeZoneOffset",
"value": "",
"type": "query",
"description": "The time zone off set"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The case-insensitive keyword to search in description"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The field for sorting"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates a report page of audit logs."
},
{
"info": {
"name": "Download audit logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/logs/audit/reports/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Download report of audit logs."
},
{
"info": {
"name": "List SMS logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/logs/sms",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "phoneNumber",
"value": "",
"type": "query",
"description": "The phone number"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970, default is 0 if not specified or is negative"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970, default is now if not specified or is negative"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of SMS logs."
},
{
"info": {
"name": "List Email logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/logs/email",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "username",
"value": "",
"type": "query",
"description": "The user login name"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970, default is 0 if not specified or is negative"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970, default is now if not specified or is negative"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of Email logs."
},
{
"info": {
"name": "List auth logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/logs/auth",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "username",
"value": "",
"type": "query",
"description": "The user login name"
},
{
"name": "callingStationId",
"value": "",
"type": "query",
"description": "The calling station ID"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970, default is 0 if not specified or is negative"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970, default is now if not specified or is negative"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of auth logs."
},
{
"info": {
"name": "List credential logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/logs/credential",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "username",
"value": "",
"type": "query",
"description": "The user login name"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970, default is 0 if not specified or is negative"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970, default is now if not specified or is negative"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of credential logs."
},
{
"info": {
"name": "List accounting logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/logs/accounting",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "username",
"value": "",
"type": "query",
"description": "The user login name"
},
{
"name": "callingStationId",
"value": "",
"type": "query",
"description": "The calling station ID"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970, default is 0 if not specified or is negative"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970, default is now if not specified or is negative"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of accounting logs."
}
]
},
{
"info": {
"name": "Notification",
"type": "folder"
},
"items": [
{
"info": {
"name": "List webhook subscriptions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/subscriptions/webhook",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List all webhook subscriptions."
},
{
"info": {
"name": "Create webhook subscriptions",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/subscriptions/webhook",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create multiple webhook subscriptions."
},
{
"info": {
"name": "Update webhook subscription by ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/subscriptions/webhook/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update an existing webhook subscription by the specified ID."
},
{
"info": {
"name": "Delete webhook subscription",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/subscriptions/webhook/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an exist webhook subscription."
},
{
"info": {
"name": "Export all webhook subscriptions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/subscriptions/webhook/export",
"params": [
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The field for sorting"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to filter - user name, email"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Export all webhook subscriptions as a csv file."
}
]
},
{
"info": {
"name": "Configuration - Deployment",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get list of deployments",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/deployments",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get firmware upgrade details across multiple sites and devices."
},
{
"info": {
"name": "[LRO] Push configuration and upgrade firmware",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/deployments",
"params": [
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Push configuration and upgrade firmware to the target devices."
},
{
"info": {
"name": "Get configuration deployment overview",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/deployments/overview",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get configuration deployment status overview."
},
{
"info": {
"name": "Get configuration deployment status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/deployments/status",
"params": [
{
"name": "deviceIds",
"value": "",
"type": "query",
"description": "The target device IDs"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get configuration deployment status for the target devices."
},
{
"info": {
"name": "Get device firmware metadatas",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/deployments/firmware-metadatas",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the compatible firmware metadatas for the devices."
},
{
"info": {
"name": "Get details of the deployment by deployment ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/deployments/:deploymentId",
"params": [
{
"name": "deploymentId",
"value": "",
"type": "path",
"description": "The deployment ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get firmware upgrade schedule details across sites."
},
{
"info": {
"name": "Update schedule with deployment ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/deployments/:deploymentId",
"params": [
{
"name": "deploymentId",
"value": "",
"type": "path",
"description": "The deployment ID"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update firmware upgrade across multiple sites."
},
{
"info": {
"name": "Delete the deployment schedule by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/deployments/:deploymentId",
"params": [
{
"name": "deploymentId",
"value": "",
"type": "path",
"description": "The deployment ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete firmware upgrade schedule."
},
{
"info": {
"name": "[LRO] Get firmware deployment status by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/deployments/:deploymentId/status",
"params": [
{
"name": "deploymentId",
"value": "",
"type": "path",
"description": "The deployment ID"
},
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get firmware upgrade schedule status for a site based on deployment ID."
}
]
},
{
"info": {
"name": "Configuration - Basic",
"type": "folder"
},
"items": [
{
"info": {
"name": "List VLAN profiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/vlan-profiles",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a page of VLAN profiles."
},
{
"info": {
"name": "Create VLAN profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/vlan-profiles",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new VLAN profile."
},
{
"info": {
"name": "Get a VLAN profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/vlan-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a specific VLAN profile by ID."
},
{
"info": {
"name": "Update a VLAN profile",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.extremecloudiq.com/vlan-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a specific VLAN profile."
},
{
"info": {
"name": "Delete a VLAN profile",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/vlan-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a specific VLAN profile by ID."
}
]
},
{
"info": {
"name": "Configuration - User Management",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Email templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/email-templates",
"params": [
{
"name": "passwordType",
"value": "",
"type": "query",
"description": "The password type"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List all Email notification templates."
},
{
"info": {
"name": "List SMS templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/sms-templates",
"params": [
{
"name": "passwordType",
"value": "",
"type": "query",
"description": "The password type"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List all SMS notification templates."
},
{
"info": {
"name": "List end users",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/endusers",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "user_group_ids",
"value": "",
"type": "query",
"description": "The user group IDs"
},
{
"name": "usernames",
"value": "",
"type": "query",
"description": "The list of username"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of end users."
},
{
"info": {
"name": "Create an end user",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/endusers",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new end user."
},
{
"info": {
"name": "Update an end user",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/endusers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a specific end user."
},
{
"info": {
"name": "Delete end user by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/endusers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a specific end user."
},
{
"info": {
"name": "Regenerate a new password for the end user",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/endusers/:id/:regenerate-password",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the end user's password with a system generated password."
},
{
"info": {
"name": "List user groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/usergroups",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "password_db_location",
"value": "",
"type": "query",
"description": "The password DB location"
},
{
"name": "password_type",
"value": "",
"type": "query",
"description": "The password type"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of user groups."
},
{
"info": {
"name": "Create user group",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/usergroups",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new user group."
},
{
"info": {
"name": "Update user group",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/usergroups/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update existing user group information."
},
{
"info": {
"name": "Delete user group by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/usergroups/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the user-group for the specified ID."
},
{
"info": {
"name": "List Key-based Private Client Groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/pcgs/key-based",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List all Key-based Private Client Groups."
},
{
"info": {
"name": " [LRO] Create a Key-based Private Client Group",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/pcgs/key-based",
"params": [
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Setup a Key-based Private Client Group, including network policy, user, user group, SSID, etc."
},
{
"info": {
"name": " [LRO] Create Key-based PCG in network policy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/pcgs/key-based/network-policy-:policyId/:onboard",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The network policy ID"
},
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a Key-based Private Client Group for a specific network policy."
},
{
"info": {
"name": "Delete Private Client Group from a network policy",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/pcgs/key-based/network-policy-:policyId",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The network policy ID"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "The IDs of the Key-based PCG entity to be deleted from network policy"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete Private Client Group settings from a network policy."
},
{
"info": {
"name": "Get users for a PCG-enabled network policy",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/pcgs/key-based/network-policy-:policyId/users",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The network policy ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get users for a specific PCG-enabled network policy."
},
{
"info": {
"name": " [LRO] Add users to a PCG-enabled network policy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/pcgs/key-based/network-policy-:policyId/users",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The network policy ID"
},
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Add users to a PCG-enabled network policy."
},
{
"info": {
"name": "Replace all users in a PCG-enabled network policy",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/pcgs/key-based/network-policy-:policyId/users",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The network policy ID"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Replace all users in a specific PCG-enabled network policy."
},
{
"info": {
"name": "Delete users from a PCG-enabled network policy",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/pcgs/key-based/network-policy-:policyId/users",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The network policy ID"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete users from a PCG-enabled network policy."
},
{
"info": {
"name": "Get device port assignments in network policy",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/pcgs/key-based/network-policy-:policyId/port-assignments",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The network policy ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get port assignments for devices (only support AP150W now) in a network policy."
},
{
"info": {
"name": "Assign ports to devices in network policy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/pcgs/key-based/network-policy-:policyId/port-assignments",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The network policy ID"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Assign ports for devices (only support AP150W now) in a network policy."
},
{
"info": {
"name": "Generate shared keys for users in network policy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/pcgs/key-based/network-policy-:policyId/keys/:generate",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The network policy ID"
},
{
"name": "userIds",
"value": "",
"type": "query",
"description": "The user IDs"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Generate/regenerate shared keys for specified users in a specific PCG-enable network policy."
},
{
"info": {
"name": "Send keys to users in network policy via Email",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/pcgs/key-based/network-policy-:policyId/keys/:email",
"params": [
{
"name": "policyId",
"value": "",
"type": "path",
"description": "The network policy ID"
},
{
"name": "userIds",
"value": "",
"type": "query",
"description": "The user IDs"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Send keys to specified users in PCG-enabled network policy via Email."
}
]
},
{
"info": {
"name": "Configuration - Policy",
"type": "folder"
},
"items": [
{
"info": {
"name": "List classification rules",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/classification-rules",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of classification rules."
},
{
"info": {
"name": "Create classification rule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/classification-rules",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new classification rule."
},
{
"info": {
"name": "Get a classification rule by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/classification-rules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a specific classification rule."
},
{
"info": {
"name": "Update classification rule",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/classification-rules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the exist classification rule."
},
{
"info": {
"name": "Delete classification rule by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/classification-rules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing classification rule by ID."
},
{
"info": {
"name": "List L3 address profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/l3-address-profiles",
"params": [
{
"name": "addressType",
"value": "",
"type": "query",
"description": "The address type"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List all L3 Address Profiles."
},
{
"info": {
"name": "Create L3 address profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/l3-address-profiles",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new L3 address profile."
},
{
"info": {
"name": "Get L3 address profile by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/l3-address-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get an existing L3 address profile by the specified ID."
},
{
"info": {
"name": "Update L3 address profile by ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/l3-address-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update an existing L3 address profile by the specified ID."
},
{
"info": {
"name": "Delete L3 address profile by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/l3-address-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing L3 address profile by the specified ID."
},
{
"info": {
"name": "List IP Firewall policies",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ip-firewall-policies",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of IP Firewall policies."
},
{
"info": {
"name": "Create IP Firewall policy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ip-firewall-policies",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new IP Firewall policy."
},
{
"info": {
"name": "Get IP Firewall Policy by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ip-firewall-policies/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get an existing IP Firewall policy by the specified ID."
},
{
"info": {
"name": "Update IP Firewall policy by ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/ip-firewall-policies/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update an existing IP Firewall policy by the specified ID."
},
{
"info": {
"name": "Delete IP Firewall policy by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/ip-firewall-policies/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing IP Firewall policy by the specified ID."
},
{
"info": {
"name": "Attach IP Firewall Rule to IP Firewall policy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ip-firewall-policies/:id/ip-firewall-rule/:attach",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Attach IP Firewall Rule to a IP Firewall policy."
},
{
"info": {
"name": "Detach IP Firewall Rule from IP Firewall policy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ip-firewall-policies/:id/ip-firewall-rule/:detach",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Detach IP Firewall Rule from a IP Firewall policy."
},
{
"info": {
"name": "List MAC Firewall policies",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/mac-firewall-policies",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of MAC Firewall policies."
},
{
"info": {
"name": "Create MAC Firewall Policy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/mac-firewall-policies",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new MAC Firewall policy."
},
{
"info": {
"name": "Get MAC Firewall Policy by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/mac-firewall-policies/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get an existing MAC Firewall policy by the specified ID."
},
{
"info": {
"name": "Update MAC Firewall policy by ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/mac-firewall-policies/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update an existing MAC Firewall policy by the specified ID."
},
{
"info": {
"name": "Delete MAC Firewall policy by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/mac-firewall-policies/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing MAC Firewall policy by the specified ID."
},
{
"info": {
"name": "List MAC objects",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/mac-object-profiles",
"params": [
{
"name": "macType",
"value": "",
"type": "query",
"description": "The MAC object type"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of MAC objects."
},
{
"info": {
"name": "Create MAC object",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/mac-object-profiles",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new MAC object."
},
{
"info": {
"name": "Get MAC object by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/mac-object-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get an existing MAC object by the specified ID."
},
{
"info": {
"name": "Update MAC object by ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/mac-object-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update an existing MAC object by the specified ID."
},
{
"info": {
"name": "Delete MAC object by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/mac-object-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing MAC object by the specified ID."
},
{
"info": {
"name": "Attach MAC Firewall Rule to MAC Firewall policy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/mac-firewall-policies/:id/mac-firewall-rule/:attach",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Attach MAC Firewall Rule to a MAC Firewall policy."
},
{
"info": {
"name": "Detach MAC Firewall Rule from IP Firewall policy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/mac-firewall-policies/:id/mac-firewall-rule/:detach",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Detach MAC Firewall Rule from a IP Firewall policy."
},
{
"info": {
"name": "List radio profiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radio-profiles",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of radio profiles."
},
{
"info": {
"name": "Create a radio profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/radio-profiles",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new radio profile."
},
{
"info": {
"name": "Get radio profile by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radio-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get radio profile details for the specified ID."
},
{
"info": {
"name": "Update radio profile by ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/radio-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the existing radio profile by the profile ID."
},
{
"info": {
"name": "Delete radio profile by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/radio-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the existing radio profile by the profile ID."
},
{
"info": {
"name": "Get channel selection settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radio-profiles/channel-selection/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the channel selection settings belonging to a radio profile."
},
{
"info": {
"name": "Update channel selection settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/radio-profiles/channel-selection/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the channel selection settings belonging to a radio profile."
},
{
"info": {
"name": "List MAC OUI profiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radio-profiles/mac-ouis",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of MAC OUI profiles."
},
{
"info": {
"name": "Create a MAC OUI profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/radio-profiles/mac-ouis",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new MAC OUI profile for radio usage optimization."
},
{
"info": {
"name": "Get MAC OUI profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radio-profiles/mac-ouis/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the MAC OUI profile belonging the radio optimization settings."
},
{
"info": {
"name": "Update MAC OUI profile",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/radio-profiles/mac-ouis/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the existing MAC OUI profile for radio usage optimization."
},
{
"info": {
"name": "Delete MAC OUI profile",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/radio-profiles/mac-ouis/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the existing MAC OUI profile for radio usage optimization."
},
{
"info": {
"name": "Get radio miscellaneous settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radio-profiles/miscellaneous/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the radio miscellaneous settings belonging to a radio profile."
},
{
"info": {
"name": "Update radio miscellaneous settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/radio-profiles/miscellaneous/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the radio miscellaneous settings belonging to a radio profile."
},
{
"info": {
"name": "Get neighborhood analysis settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radio-profiles/neighborhood-analysis/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the neighborhood analysis settings belonging to a radio profile."
},
{
"info": {
"name": "Update neighborhood analysis settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/radio-profiles/neighborhood-analysis/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the neighborhood analysis settings belonging to a radio profile."
},
{
"info": {
"name": "Get radio usage optimization settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radio-profiles/radio-usage-opt/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the radio usage optimization settings belonging to a radio profile."
},
{
"info": {
"name": "Update radio usage optimization settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/radio-profiles/radio-usage-opt/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the radio usage optimization settings belonging to a radio profile."
},
{
"info": {
"name": "Get sensor scan settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radio-profiles/sensor-scan/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the sensor scan settings belonging to a radio profile."
},
{
"info": {
"name": "Update sensor scan settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/radio-profiles/sensor-scan/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the sensor scan settings belonging to a radio profile."
},
{
"info": {
"name": "Get Wmm QoS settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radio-profiles/wmm-qos/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the Wi-Fi Multimedia (WMM) QoS settings belonging to a radio profile."
},
{
"info": {
"name": "Update Wmm QoS settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/radio-profiles/wmm-qos/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the Wi-Fi Multimedia (WMM) QoS settings belonging to a radio profile."
},
{
"info": {
"name": "List user profiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/user-profiles",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of user profiles."
},
{
"info": {
"name": "Create a user profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/user-profiles",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new user profile."
},
{
"info": {
"name": "Get user profile by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/user-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get user profile details for the specified ID."
},
{
"info": {
"name": "Update user profile",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/user-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update an existing user profile."
},
{
"info": {
"name": "Delete an user profile by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/user-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing user profile by ID."
},
{
"info": {
"name": "List User Profile Assignments",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/user-profile-assignments",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of User Profile Assignments."
},
{
"info": {
"name": "Create User Profile Assignment",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/user-profile-assignments",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create User Profile Assignment."
},
{
"info": {
"name": "Get User Profile Assignment by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/user-profile-assignments/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get an existing User Profile Assignment object by the specified ID."
},
{
"info": {
"name": "Delete User Profile Assignment by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/user-profile-assignments/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing User Profile Assignment by the specified ID."
},
{
"info": {
"name": "Attach IP Firewall policy to User Profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/user-profiles/:id/ip-firewall-policies/:attach",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Attach an IP Firewall policy to a User Profile."
},
{
"info": {
"name": "Detach IP Firewall policy from User Profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/user-profiles/:id/ip-firewall-policies/:detach",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Detach an IP Firewall policy from a User Profile."
},
{
"info": {
"name": "Attach MAC Firewall policy to User Profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/user-profiles/:id/mac-firewall-policies/:attach",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Attach a MAC Firewall policy to a User Profile."
},
{
"info": {
"name": "Detach MAC Firewall policy from User Profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/user-profiles/:id/mac-firewall-policies/:detach",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Detach a MAC Firewall policy from a User Profile."
},
{
"info": {
"name": "List Hotspot profiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/hotspot-profiles",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of Hotspot profiles."
},
{
"info": {
"name": "Create a Hotspot profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/hotspot-profiles",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new Hotspot profile."
},
{
"info": {
"name": "Get Hotspot profile by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/hotspot-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Hotspot profile for the specified ID."
},
{
"info": {
"name": "Update Hotspot profile by ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/hotspot-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the existing Hotspot profile by the profile ID."
},
{
"info": {
"name": "Delete Hotspot profile by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/hotspot-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the existing Hotspot profile by the profile ID."
},
{
"info": {
"name": "List Hotspot Service Provider profiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/hotspot-service-profiler-profiles",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of Hotspot Service Provider profiles."
},
{
"info": {
"name": "Create a Hotspot Service Provider profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/hotspot-service-profiler-profiles",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a Hotspot Service Provider profile."
},
{
"info": {
"name": "Get Hotspot Service Provider profile by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/hotspot-service-provider-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Hotspot Service Provider profile for the specified ID."
},
{
"info": {
"name": "Update Hotspot Service Provider profile by ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/hotspot-service-provider-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the existing Hotspot Service Provider profile by ID."
},
{
"info": {
"name": "Delete Hotspot Service Provider profile by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/hotspot-service-provider-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the existing Hotspot Service Provider profile by ID."
},
{
"info": {
"name": "List SSIDs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ssids",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List SSIDs with filter and pagination."
},
{
"info": {
"name": "Rename SSID (Wireless name)",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ssids/:id/:rename",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Change SSID broadcast name (Wireless name)."
},
{
"info": {
"name": "Attach CWP to an SSID",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ssids/:id/cwp/:attach",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Attach CWP to an SSID."
},
{
"info": {
"name": "Enable and attach the CWP on the SSID",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ssids/:id/cwp/:enable",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Enable and attach the CWP on the SSID."
},
{
"info": {
"name": "Disable the CWP on the SSID",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ssids/:id/cwp/:disable",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Disable the CWP on the SSID."
},
{
"info": {
"name": "Change the SSID mode to 802.1x and Authentication",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/ssids/:id/mode/dot1x",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Change the SSID mode to 802.1x."
},
{
"info": {
"name": "Change the SSID mode to open access",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/ssids/:id/mode/open",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Change the SSID mode to open access."
},
{
"info": {
"name": "Change the SSID mode to PSK",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/ssids/:id/mode/psk",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Change the SSID mode to PSK."
},
{
"info": {
"name": "Change the SSID mode to PPSK",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/ssids/:id/mode/ppsk",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Change the SSID mode to PPSK."
},
{
"info": {
"name": "Change the SSID mode to WEP",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/ssids/:id/mode/wep",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Change the SSID mode to WEP."
},
{
"info": {
"name": "Change the SSID PSK password",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/ssids/:id/psk/password",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Change the SSID PSK password."
},
{
"info": {
"name": "Attach radius server group to an SSID",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ssids/:id/radius-server-group/:attach",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Attach radius server group to an SSID."
},
{
"info": {
"name": "Attach RADIUS client profile to an SSID",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ssids/:id/radius-client-profile/:attach",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Attach RADIUS client profile to an SSID."
},
{
"info": {
"name": "Attach User Profile Assignment to SSID",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ssids/:id/user-profile-assignments/:attach",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Attach User Profile Assignment to an SSID."
},
{
"info": {
"name": "Detach User Profile Assignment from SSID",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ssids/:id/user-profile-assignments/:detach",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Detach User Profile Assignment from an SSID."
},
{
"info": {
"name": "Attach user profile to an SSID",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ssids/:id/user-profile/:attach",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Attach user profile to an SSID."
},
{
"info": {
"name": "Get advanced settings for SSID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ssids/advanced-settings/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the advanced settings belonging to a SSID profile."
},
{
"info": {
"name": "Update SSID advanced settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/ssids/advanced-settings/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the advanced settings belonging to a SSID profile."
},
{
"info": {
"name": "Enable and attach the Hotspot profile on the SSID",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ssids/:id/hotspot-profiles/:enable",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Enable and attach the Hotspot profile on the SSID."
},
{
"info": {
"name": "Disable the Hotspot profile on the SSID",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ssids/:id/hotspots-profiles/:disable",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Disable the Hotspot profile on the SSID."
},
{
"info": {
"name": "[LRO] List clould config groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ccgs",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a papge of cloud config groups."
},
{
"info": {
"name": "Create new cloud config group",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ccgs",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new cloud config group."
},
{
"info": {
"name": "Get a cloud config group",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ccgs/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get cloud config group info for the specified ID."
},
{
"info": {
"name": "Update cloud config group information",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/ccgs/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the cloud config group details having the specified ID."
},
{
"info": {
"name": "Delete a cloud config group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/ccgs/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a specific cloud config group by ID."
},
{
"info": {
"name": "List IoT profiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/iot-profiles",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "appSupported",
"value": "",
"type": "query",
"description": "IoT profile app supported type"
},
{
"name": "appId",
"value": "",
"type": "query",
"description": "IoT profile app ID type"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of IoT profiles."
},
{
"info": {
"name": "Create an IoT profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/iot-profiles",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new IoT profile."
},
{
"info": {
"name": "Get IoT profile by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/iot-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get IoT profile details for the specified ID."
},
{
"info": {
"name": "Update IoT profile by ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/iot-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the existing IoT profile by the profile ID."
},
{
"info": {
"name": "Delete IoT profile by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/iot-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the existing IoT profile by the profile ID."
},
{
"info": {
"name": "List client monitor profiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/client-monitor-profiles",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "Sort field. Available values - NAME"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of client monitor profiles."
},
{
"info": {
"name": "Create a client monitor profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/client-monitor-profiles",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new client monitor profile."
},
{
"info": {
"name": "Get a client monitor profile by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/client-monitor-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get client monitor profile details for the specified ID."
},
{
"info": {
"name": "Update client monitor profile by ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/client-monitor-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update an existing client monitor profile."
},
{
"info": {
"name": "Delete a client monitor profile by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/client-monitor-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing client monitor profile by ID."
},
{
"info": {
"name": "Attach client monitor profile to an SSID",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ssids/:id/client-monitor-profile/:attach",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Attach client monitor profile to an SSID."
},
{
"info": {
"name": "Get AP Radio Operating Mode",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radio-operating-modes/:productType",
"params": [
{
"name": "productType",
"value": "",
"type": "path",
"description": "Product/AP Model"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Modern AP hardware types include dual or triple band radios.\nA limited subset of band combinations are supported.\nOperating mode defines the supported band combinations per radio. \nAccess Points with fixed band radios use GENERIC operating mode. \nSERVICE_2_5_6: wifi0-2.4Ghz, wifi1-5Ghz, wifi2-6Ghz\nSENSOR_SERVICE_5_6: wifi0-Tri-band sensor, wifi1-5Ghz, wifi2-6Ghz\nSERVICE_5L_5H_6: wifi0-5G Low, wifi1-5G High, wifi2-6Ghz\nSENSOR_SERVICE_5_2: wifi0-Tri-band sensor, wifi1-5GHz, wifi2-2.4Ghz\nSERV"
}
]
},
{
"info": {
"name": "Configuration - Network",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Tunnel Concentrator services",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/tunnel-concentrators",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a page of Tunnel Concentrator services."
},
{
"info": {
"name": "Create Tunnel Concentrator Service",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/tunnel-concentrators",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new Tunnel Concentrator Service."
},
{
"info": {
"name": "Get a Tunnel Concentrator Service",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/tunnel-concentrators/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a specific Tunnel Concentrator Service by ID."
},
{
"info": {
"name": "Update a Tunnel Concentrator Service",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/tunnel-concentrators/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a specific Tunnel Concentrator Service."
},
{
"info": {
"name": "Delete a Tunnel Concentrator Service",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/tunnel-concentrators/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a specific Tunnel Concentrator Service by ID."
},
{
"info": {
"name": "List Network Services",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/network-services",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Network Service name."
},
{
"name": "ipProtocol",
"value": "",
"type": "query",
"description": "IP Protocol, only for custom Application."
},
{
"name": "algType",
"value": "",
"type": "query",
"description": "Application Layer Gateway (ALG) type, only for custom Application."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of Network Services."
},
{
"info": {
"name": "Create Network Service",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/network-services",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new Network Service."
},
{
"info": {
"name": "Delete a Network Service by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/network-services/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a Network Service by ID."
}
]
},
{
"info": {
"name": "Configuration - Authentication",
"type": "folder"
},
"items": [
{
"info": {
"name": "List active directory servers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ad-servers",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of active directory servers."
},
{
"info": {
"name": "List captive web portals",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/cwps",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of Captive Web Portals."
},
{
"info": {
"name": "List LDAP servers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ldap-servers",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of LDAP servers."
},
{
"info": {
"name": "Create LDAP server",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ldap-servers",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new LDAP server."
},
{
"info": {
"name": "Get LDAP server by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ldap-servers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a specific LDAP server by ID."
},
{
"info": {
"name": "Update LDAP server configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/ldap-servers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update configuration for a specific LDAP server."
},
{
"info": {
"name": "Delete a LDAP server",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/ldap-servers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a specific LDAP server by ID."
},
{
"info": {
"name": "List RADIUS client objects",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radius-client-objects",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of RADIUS client object configurations."
},
{
"info": {
"name": "Create RADIUS client object configuration",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/radius-client-objects",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new RADIUS client object configuration."
},
{
"info": {
"name": "Get RADIUS client object by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radius-client-objects/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get detailed configuration for a specific RADIUS client object."
},
{
"info": {
"name": "Update RADIUS client object configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/radius-client-objects/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update RADIUS client object configuration by ID."
},
{
"info": {
"name": "Delete a RADIUS client object configuration",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/radius-client-objects/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing RADIUS client object configuration by ID."
},
{
"info": {
"name": "List RADIUS proxies",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radius-proxies",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of RADIUS proxy configurations."
},
{
"info": {
"name": "Create RADIUS proxy configuration",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/radius-proxies",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new RADIUS proxy configuration."
},
{
"info": {
"name": "Get the RADIUS proxy configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radius-proxies/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get an existing RADIUS proxy configuration by ID."
},
{
"info": {
"name": "Update RADIUS proxy configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/radius-proxies/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update RADIUS proxy configuration by ID."
},
{
"info": {
"name": "Delete the RADIUS proxy configuration",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/radius-proxies/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing RADIUS proxy configuration by ID."
},
{
"info": {
"name": "List Radius proxy devices",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radius-proxies/devices",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List devices for Radius Proxy."
},
{
"info": {
"name": "List all internal RADIUS servers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radius-servers/internal",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List all internal RADIUS servers configurations."
},
{
"info": {
"name": "Create internal RADIUS server configuration",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/radius-servers/internal",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new internal RADIUS server configuration."
},
{
"info": {
"name": "Get internal RADIUS server by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radius-servers/internal/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get detailed configuration for internal RADIUS server by ID."
},
{
"info": {
"name": "Update internal RADIUS server configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/radius-servers/internal/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update internal RADIUS server configuration by ID."
},
{
"info": {
"name": "Delete internal RADIUS server configuration",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/radius-servers/internal/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing internal RADIUS server configuration by ID."
},
{
"info": {
"name": "List all internal RADIUS devices",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radius-servers/internal/devices",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List all internal RADIUS devices fields."
},
{
"info": {
"name": "List external RADIUS servers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radius-servers/external",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of external RADIUS server configurations."
},
{
"info": {
"name": "Create external RADIUS server configuration",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/radius-servers/external",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new external RADIUS server configuration."
},
{
"info": {
"name": "Get external RADIUS server by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radius-servers/external/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get detailed configuration for a specific external RADIUS server."
},
{
"info": {
"name": "Update external RADIUS server configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/radius-servers/external/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update external RADIUS server configuration by ID."
},
{
"info": {
"name": "Delete external RADIUS server configuration",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/radius-servers/external/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing external RADIUS server configuration by ID."
},
{
"info": {
"name": "List RADSEC proxies",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radsec-proxies",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of RADSEC proxy configurations."
},
{
"info": {
"name": "Create RADSEC proxy configuration",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/radsec-proxies",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new RADSEC proxy configuration."
},
{
"info": {
"name": "Get the RADSEC proxy configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/radsec-proxies/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get an existing RADSEC proxy configuration by ID."
},
{
"info": {
"name": "Update RADSEC proxy configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/radsec-proxies/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update RADSEC proxy configuration by ID."
},
{
"info": {
"name": "Delete the RADSEC proxy configuration",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/radsec-proxies/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing RADSEC proxy configuration by ID."
}
]
},
{
"info": {
"name": "Configuration - Certificate",
"type": "folder"
},
"items": [
{
"info": {
"name": "List certificates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/certificates",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "certType",
"value": "",
"type": "query",
"description": "The certificate type"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of certificates."
},
{
"info": {
"name": "Import Certificate",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/certificates/import",
"body": {
"type": "multipart-form",
"data": []
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Import a Certificate."
},
{
"info": {
"name": "Delete Certificate",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/certificates/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing Certificate by ID."
},
{
"info": {
"name": "List Certificate Bundles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/certificate-bundles",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of Certificate Bundle configurations."
},
{
"info": {
"name": "Create Certificate Bundle",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/certificate-bundles",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new Certificate Bundle configuration."
},
{
"info": {
"name": "Get the Certificate Bundle",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/certificate-bundles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get an existing Certificate Bundle configuration by ID."
},
{
"info": {
"name": "Update Certificate Bundle",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/certificate-bundles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update Certificate Bundle configuration by ID."
},
{
"info": {
"name": "Delete the Certificate Bundle",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/certificate-bundles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing Certificate Bundle configuration by ID."
}
]
},
{
"info": {
"name": "Copilot - Connectivity Experience",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Wireless Connectivity Experiences",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/connectivity/wireless/experience",
"params": [
{
"name": "viewType",
"value": "",
"type": "query",
"description": "The wireless experience view type"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of Quality-Index trends by selected view type."
},
{
"info": {
"name": "List Wired Connectivity Experiences",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/connectivity/wired/experience",
"params": [
{
"name": "viewType",
"value": "",
"type": "query",
"description": "The wired experience view type"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of Quality-Index trends by selected view type."
},
{
"info": {
"name": "Get Wired Connectivity QualityIndex",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/connectivity/wired/quality-index",
"params": [
{
"name": "viewType",
"value": "",
"type": "query",
"description": "The wired experience view type"
},
{
"name": "viewId",
"value": "",
"type": "query",
"description": "The view identifier based on selected view type"
},
{
"name": "forensicBucket",
"value": "",
"type": "query",
"description": "The historical period bucket"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "locationId",
"value": "",
"type": "query",
"description": "The location id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Quality-Index for a specific view type."
},
{
"info": {
"name": "List Wired Connectivity Events",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/connectivity/wired/events",
"params": [
{
"name": "viewType",
"value": "",
"type": "query",
"description": "The wired experience view type"
},
{
"name": "viewId",
"value": "",
"type": "query",
"description": "The view identifier based on selected view type"
},
{
"name": "scoreType",
"value": "",
"type": "query",
"description": "The wired score type"
},
{
"name": "forensicBucket",
"value": "",
"type": "query",
"description": "The historical period bucket"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
},
{
"name": "searchKey",
"value": "",
"type": "query",
"description": "The search key"
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "The timestamp to query, epoch time in milliseconds since 1/1/1970"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of wired events over a selected period of time."
},
{
"info": {
"name": "Get Connectivity By Locations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/connectivity/locations",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "locationId",
"value": "",
"type": "query",
"description": "The location id"
},
{
"name": "searchKey",
"value": "",
"type": "query",
"description": "The search key"
},
{
"name": "clientType",
"value": "",
"type": "query",
"description": "The client type"
},
{
"name": "qualityIndex",
"value": "",
"type": "query",
"description": "The quality index score"
},
{
"name": "forensicBucket",
"value": "",
"type": "query",
"description": "The historical period bucket"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Connectivity details by Locations in a Table with pagination & sorting."
},
{
"info": {
"name": "Get Connectivity By Client Type",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/connectivity/client-type",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "locationId",
"value": "",
"type": "query",
"description": "The location id"
},
{
"name": "clientType",
"value": "",
"type": "query",
"description": "The client type"
},
{
"name": "qualityIndex",
"value": "",
"type": "query",
"description": "The quality index score"
},
{
"name": "forensicBucket",
"value": "",
"type": "query",
"description": "The historical period bucket"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Connectivity details by client type in the widgets."
},
{
"info": {
"name": "Get Wireless QualityIndex By Locations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/connectivity/wireless/locations/quality-index",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "forensicBucket",
"value": "",
"type": "query",
"description": "The historical period bucket"
},
{
"name": "locationId",
"value": "",
"type": "query",
"description": "The location id"
},
{
"name": "ssid",
"value": "",
"type": "query",
"description": "The ssid value"
},
{
"name": "osType",
"value": "",
"type": "query",
"description": "The os type value"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Quality-Index for a specific view type."
},
{
"info": {
"name": "Get Wireless Time-To-Connect By Locations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/connectivity/wireless/locations/time-to-connect",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "forensicBucket",
"value": "",
"type": "query",
"description": "The historical period bucket"
},
{
"name": "locationId",
"value": "",
"type": "query",
"description": "The location id"
},
{
"name": "ssid",
"value": "",
"type": "query",
"description": "The ssid value"
},
{
"name": "osType",
"value": "",
"type": "query",
"description": "The os type value"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of Time-To-Connect score data over a selected period of time."
},
{
"info": {
"name": "Get Wireless Connectivity Performance By Locations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/connectivity/wireless/locations/performance",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "forensicBucket",
"value": "",
"type": "query",
"description": "The historical period bucket"
},
{
"name": "locationId",
"value": "",
"type": "query",
"description": "The location id"
},
{
"name": "ssid",
"value": "",
"type": "query",
"description": "The ssid value"
},
{
"name": "osType",
"value": "",
"type": "query",
"description": "The os type value"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of Performance score data over a selected period of time."
},
{
"info": {
"name": "List Wireless Connectivity Events By Locations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/connectivity/wireless/locations/events",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
},
{
"name": "scoreType",
"value": "",
"type": "query",
"description": "The wireless score type"
},
{
"name": "forensicBucket",
"value": "",
"type": "query",
"description": "The historical period bucket"
},
{
"name": "searchKey",
"value": "",
"type": "query",
"description": "The search key"
},
{
"name": "locationId",
"value": "",
"type": "query",
"description": "The location id"
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "The timestamp to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "ssid",
"value": "",
"type": "query",
"description": "The ssid value"
},
{
"name": "osType",
"value": "",
"type": "query",
"description": "The os type value"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of wireless events over a selected period of time."
},
{
"info": {
"name": "Get Wired - Hardware By Locations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/connectivity/wired/locations/hardware",
"params": [
{
"name": "viewType",
"value": "",
"type": "query",
"description": "The wired experience view type"
},
{
"name": "viewId",
"value": "",
"type": "query",
"description": "The view identifier based on selected view type"
},
{
"name": "forensicBucket",
"value": "",
"type": "query",
"description": "The historical period bucket"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of hardware score data over a selected period of time and total ports with affected."
}
]
},
{
"info": {
"name": "Copilot - Anomalies",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get POE Flapping Anomaly Device Stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/poeflapping/stats",
"params": [
{
"name": "anomalyId",
"value": "",
"type": "query",
"description": "The anomaly id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get all the stats for anomaly device."
},
{
"info": {
"name": "Get PortEfficiency Device Stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/port-efficiency/stats",
"params": [
{
"name": "anomalyId",
"value": "",
"type": "query",
"description": "The anomaly id"
},
{
"name": "offsetTime",
"value": "",
"type": "query",
"description": "The offset value"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get all the stats for PortEfficiency device."
},
{
"info": {
"name": "Get PortEfficiency Device Speed and Duplex Stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/port-efficiency/speed-duplex-stats",
"params": [
{
"name": "anomalyId",
"value": "",
"type": "query",
"description": "The anomaly id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get all the speed and duplex for PortEfficiency device."
},
{
"info": {
"name": "Get DFSRecurrence Device Channel Count Stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/dfs-recurrence/count-stats",
"params": [
{
"name": "anomalyId",
"value": "",
"type": "query",
"description": "The anomaly id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get DFS Recurrence anomaly radar event count stats."
},
{
"info": {
"name": "Get DFSRecurrence Device Channel Change Stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/dfs-recurrence/channel-stats",
"params": [
{
"name": "anomalyId",
"value": "",
"type": "query",
"description": "The anomaly id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get DFS Recurrence anomaly device channel change stats."
},
{
"info": {
"name": "Get Adverse Traffic Pattern Anomaly Device Stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/adverse-traffic/device-stats",
"params": [
{
"name": "anomalyId",
"value": "",
"type": "query",
"description": "The anomaly id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get all the stats for anomaly device."
},
{
"info": {
"name": "Get Adverse Traffic Pattern Anomaly Packet Counts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/adverse-traffic/packet-counts",
"params": [
{
"name": "anomalyId",
"value": "",
"type": "query",
"description": "The anomaly id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get all the stats for anomaly device."
},
{
"info": {
"name": "Get WifiEfficiency Device Stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/wifi-efficiency/stats",
"params": [
{
"name": "anomalyId",
"value": "",
"type": "query",
"description": "The anomaly id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get all the stats for WifiEfficiency device."
},
{
"info": {
"name": "Get WifiEfficiency contributing client list",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/wifi-efficiency/client-list",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device id"
},
{
"name": "channel",
"value": "",
"type": "query",
"description": "The channel number"
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "The timestamp"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get all the client list for WifiEfficiency device."
},
{
"info": {
"name": "Get WifiCapacity Device Stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/wifi-capacity/stats",
"params": [
{
"name": "anomalyId",
"value": "",
"type": "query",
"description": "The anomaly id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get all the stats for WifiCapacity device."
},
{
"info": {
"name": "Get WifiCapacity contributing client list",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/wifi-capacity/client-list",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device id"
},
{
"name": "channel",
"value": "",
"type": "query",
"description": "The channel number"
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "The timestamp"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get all the client list for WifiCapacity device."
},
{
"info": {
"name": "Get AssuranceScans for all anomaly devices",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/assurance-scans/overview",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get all assuranceScans data for a given location."
},
{
"info": {
"name": "Update Anomalies Feedback",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/copilot/anomalies/devices/feedback",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update and save Anomaly Feedback."
},
{
"info": {
"name": "Get Anomalies by Categories",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/anomalies-by-category",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time"
},
{
"name": "buildingId",
"value": "",
"type": "query",
"description": "The building id"
},
{
"name": "severity",
"value": "",
"type": "query",
"description": "The anomaly severity"
},
{
"name": "anomalyType",
"value": "",
"type": "query",
"description": "The anomaly type"
},
{
"name": "excludeMuted",
"value": "",
"type": "query",
"description": "To filter muted anomalies"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get all anomalies for a given viewType."
},
{
"info": {
"name": "Devices with Locations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/devices-with-locations",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time"
},
{
"name": "buildingId",
"value": "",
"type": "query",
"description": "The building id"
},
{
"name": "severity",
"value": "",
"type": "query",
"description": "The anomaly severity"
},
{
"name": "anomalyType",
"value": "",
"type": "query",
"description": "The anomaly type"
},
{
"name": "excludeMuted",
"value": "",
"type": "query",
"description": "To filter muted anomalies"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "searchKey",
"value": "",
"type": "query",
"description": "The search key"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get all devices for all the anomalies and locations."
},
{
"info": {
"name": "Update Devices Action",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/copilot/anomalies/update-device-action",
"params": [
{
"name": "async",
"value": "",
"type": "query",
"description": "Whether to enable async mode"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update & save action for Anomaly devices."
},
{
"info": {
"name": "Download Anomalies Report",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/report",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time"
},
{
"name": "buildingId",
"value": "",
"type": "query",
"description": "The building id"
},
{
"name": "severity",
"value": "",
"type": "query",
"description": "The anomaly severity"
},
{
"name": "anomalyType",
"value": "",
"type": "query",
"description": "The anomaly type"
},
{
"name": "excludeMuted",
"value": "",
"type": "query",
"description": "To filter muted anomalies"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
},
{
"name": "searchKey",
"value": "",
"type": "query",
"description": "The search key"
},
{
"name": "fileType",
"value": "",
"type": "query",
"description": "The file type"
},
{
"name": "offsetTime",
"value": "",
"type": "query",
"description": "The offset value"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Download all devices and locations for all the anomalies."
},
{
"info": {
"name": "Get POE Flapping Anomaly Device Power Mode Trends",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/poeflapping/trends",
"params": [
{
"name": "anomalyId",
"value": "",
"type": "query",
"description": "The anomaly id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get all the poe trends for anomalous device."
},
{
"info": {
"name": "Get anomalous device lldp cdp Info details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/poeflapping/lldp-cdp-info",
"params": [
{
"name": "anomalyId",
"value": "",
"type": "query",
"description": "The anomaly id"
},
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device id"
},
{
"name": "lastDetectedTime",
"value": "",
"type": "query",
"description": "The last detected time"
},
{
"name": "anomalyType",
"value": "",
"type": "query",
"description": "The anomaly type"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get LLDP-CDP information and location details for anomalous devices."
},
{
"info": {
"name": "Get Excluded Vlan List",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/excluded-vlans-list",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Excluded vlans details with Site details."
},
{
"info": {
"name": "Excluding Vlan from Sites",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/copilot/anomalies/exclude-vlans",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Add, Update, Delete excluded vlan from sites."
},
{
"info": {
"name": "Excluding Vlan from Sites - CSV",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/copilot/anomalies/exclude-vlans-csv",
"params": [
{
"name": "action_type",
"value": "",
"type": "query",
"description": "The type of action to perform (add)"
},
{
"name": "dismiss",
"value": "",
"type": "query",
"description": "Whether to dismiss the action after execution"
}
],
"body": {
"type": "multipart-form",
"data": [
{
"name": "csv_file",
"type": "text",
"value": ""
}
]
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Add excluded vlan from sites using CSV."
},
{
"info": {
"name": "Get MissingVlan Anomalies Count",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/missing-vlan/count",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The Start time"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The End time"
},
{
"name": "vlanIds",
"value": "",
"type": "query",
"description": "The vlan ids"
},
{
"name": "siteIds",
"value": "",
"type": "query",
"description": "The site ids"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "MissingVlan anomaly count for specified vlanIds and siteIds."
},
{
"info": {
"name": "Get HardwareHealth Anomaly Stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/hardware-health/stats",
"params": [
{
"name": "anomalyId",
"value": "",
"type": "query",
"description": "The anomaly id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get all the stats for anomaly device."
},
{
"info": {
"name": "Get HardwareHealth contributing client list",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/hardware-health/client-list",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device id"
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "The timestamp"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get all the client list for HardwareHealth device."
},
{
"info": {
"name": "Get HardwareHealth CPU & Memory Stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/copilot/anomalies/hardware-health/cpu-mem-stats",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device id"
},
{
"name": "hhStatsFieldType",
"value": "",
"type": "query",
"description": "The Hardware Health anomaly CPU or Memory Stats type"
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "The timestamp"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get CPU or memory details for HardwareHealth device."
}
]
},
{
"info": {
"name": "PacketCaptures",
"type": "folder"
},
"items": [
{
"info": {
"name": "List packet capture sessions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/packetcaptures",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "searchString",
"value": "",
"type": "query",
"description": "The string to be searched in capture session name, interface name and device host name"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "Sort field. Available values - NAME, START_TIME and STATUS"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "The packet capture fields to return"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List packet capture sessions with filters and pagination."
},
{
"info": {
"name": "Create a new packet capture session",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/packetcaptures",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create and start a new packet capture session with requested capture location and filter criteria."
},
{
"info": {
"name": "Get a packet capture session by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/packetcaptures/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "The packet capture fields to return"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a packet capture session by id."
},
{
"info": {
"name": "Delete a packet capture session",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/packetcaptures/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing packet capture session and capture files by ID."
},
{
"info": {
"name": "Stop a packet capture session",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/packetcaptures/:id/:stop",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Stop an active packet capture session."
},
{
"info": {
"name": "Upload a packet capture session's capture files",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/packetcaptures/:id/:upload",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Upload the capture files from a packet capture session, if files previously failed to be uploaded to XIQ cloud."
},
{
"info": {
"name": "Get an AP packet capture file",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/packetcaptures/files",
"params": [
{
"name": "cloudFileUrl",
"value": "",
"type": "query",
"description": "The packet capture file path"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get an AP packet capture file from XIQ cloud storage."
}
]
},
{
"info": {
"name": "Essentials - ExtremeLocation",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get the last known location of the client",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/essentials/eloc/clients/:clientMac/last-known-location",
"params": [
{
"name": "clientMac",
"value": "",
"type": "path",
"description": "The mac address of client"
},
{
"name": "floorId",
"value": "",
"type": "query",
"description": "The location ID of the floor"
},
{
"name": "parentId",
"value": "",
"type": "query",
"description": "The location ID of the floor's parent"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the last known location of the client on the floor plan."
}
]
},
{
"info": {
"name": "Misc",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get country list",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/countries"
},
"docs": "Get list of countries and country codes."
},
{
"info": {
"name": "Validate country code",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/countries/:countryCode/:validate",
"params": [
{
"name": "countryCode",
"value": "",
"type": "path",
"description": "The country code."
}
]
},
"docs": "Validate whether the country code is a valid code or not."
},
{
"info": {
"name": "Get state list in a country",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/countries/:countryAlpha2Code/states",
"params": [
{
"name": "countryAlpha2Code",
"value": "",
"type": "path",
"description": "The country ISO 2-letter code."
}
]
},
"docs": "Get list of states or provinces in a country with country alpha2 code."
}
]
},
{
"info": {
"name": "Thread",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get active thread networks",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/thread/networks",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "folderId",
"value": "",
"type": "query",
"description": "Thread network config folder id"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "The thread network config fields to return"
},
{
"name": "views",
"value": "",
"type": "query",
"description": "The views to return thread network config fields"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get thread networks with atleast one device."
},
{
"info": {
"name": "Get thread network topology",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/thread/topology",
"params": [
{
"name": "networkConfigIds",
"value": "",
"type": "query",
"description": "Thread network config id"
},
{
"name": "routerFields",
"value": "",
"type": "query",
"description": "The thread router fields to return"
},
{
"name": "routerViews",
"value": "",
"type": "query",
"description": "The views to return thread router fields"
},
{
"name": "clientViews",
"value": "",
"type": "query",
"description": "The views to return client fields (Check fields for each view at XiqClientView schema)"
},
{
"name": "clientFields",
"value": "",
"type": "query",
"description": "The client fields to return"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get thread routers, neighboring routers and end-devices."
},
{
"info": {
"name": "List thread routers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/thread/routers",
"params": [
{
"name": "ids",
"value": "",
"type": "query",
"description": "The thread router IDs"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order (ascending by default)"
},
{
"name": "views",
"value": "",
"type": "query",
"description": "The views to return thread router fields"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "The thread router fields to return"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List thread routers with pagination."
}
]
},
{
"info": {
"name": "AFC",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get list of AFC Servers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/afcserver",
"params": [
{
"name": "ownerId",
"value": "",
"type": "query",
"description": "The Owner Id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get list of AFC Servers."
},
{
"info": {
"name": "Get AFC server Statistics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/afcserver/statistics/:server_id",
"params": [
{
"name": "server_id",
"value": "",
"type": "path",
"description": "The Id of the server"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "Query Start Time"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "Query End Time"
},
{
"name": "precision",
"value": "",
"type": "query",
"description": "precision specified in seconds"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get AFC server Statistics."
},
{
"info": {
"name": "Get AP Interface status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ap/afc/interface/details/:sn",
"params": [
{
"name": "sn",
"value": "",
"type": "path",
"description": "The serial number of an Ap."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get AP Interface status info."
},
{
"info": {
"name": "AFC Recalculate Geolocation",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/afc/recalculateSite/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The device id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Recalculate geolocation for site."
},
{
"info": {
"name": "Request FTM data for APs",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/afc/aps/reportFtm",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Request FTM data for a list of Access Points."
},
{
"info": {
"name": "AFC AP status Summary",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/afc/aps/status/summary",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "AFC Status summary of AP channels and powers query."
},
{
"info": {
"name": "Get AFC Floor Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/floor/afc/details",
"params": [
{
"name": "ownerId",
"value": "",
"type": "query",
"description": "The Owner Id"
},
{
"name": "floorId",
"value": "",
"type": "query",
"description": "The Id of the floor"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve AFC related floor height and accuracy data for a specific floor."
},
{
"info": {
"name": "Add AFC Floor Details",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/floor/afc/details",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create new AFC related floor height and accuracy data for a floor."
},
{
"info": {
"name": "Update AFC Floor Details",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/floor/afc/details",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update existing AFC related floor height and accuracy data for a floor."
},
{
"info": {
"name": "Query AFC APs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/aps/afc/query",
"params": [
{
"name": "ownerId",
"value": "",
"type": "query",
"description": "The Owner Id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve AFC summary information for access points including status, geolocation, and spectrum mismatch data."
},
{
"info": {
"name": "Query AFC APs",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/aps/afc/query",
"params": [
{
"name": "ownerId",
"value": "",
"type": "query",
"description": "The Owner Id"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve AFC summary information for access points including status, geolocation, and spectrum mismatch data."
},
{
"info": {
"name": "Get AFC AP Diagnostics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ap/afc/diagnostics/:id",
"params": [
{
"name": "ownerId",
"value": "",
"type": "query",
"description": "The Owner Id"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "device id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve AFC diagnostics information."
},
{
"info": {
"name": "Get AFC Floor Report",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ap/afc/floorReport/:deviceId",
"params": [
{
"name": "deviceId",
"value": "",
"type": "path",
"description": "Device ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves the AFC geolocation floor report for a specific device."
},
{
"info": {
"name": "Request Manual Spectrum for device(s)",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/aps/afc/update",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Manual Spectrum request for device(s)."
},
{
"info": {
"name": "Get AFC Site Schedule",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/site/afc/schedule",
"params": [
{
"name": "ownerId",
"value": "",
"type": "query",
"description": "The Owner Id"
},
{
"name": "folderId",
"value": "",
"type": "query",
"description": "The folder id for the location"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get AFC site update settings."
},
{
"info": {
"name": "Create AFC Site Schedule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/site/afc/schedule",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create AFC Site Schedule."
},
{
"info": {
"name": "Update AFC SiteSchedule",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/site/afc/schedule",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update AFC SiteSchedule."
},
{
"info": {
"name": "Find potential AP candidates to be used as anchor",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/afc/mobileapp/apcandidates",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Find potential AP candidates to be used as anchor."
}
]
},
{
"info": {
"name": "Universal Compute Platform",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get list of all installed engines for a UCP device",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ucp/:id/engines/installed",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve the list of installed engines from a connected UCP device."
}
]
},
{
"info": {
"name": "Administration",
"type": "folder"
},
"items": [
{
"info": {
"name": "List API Access Tokens",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/acct-api-token",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The field for sorting"
},
{
"name": "searchString",
"value": "",
"type": "query",
"description": "The SearchString"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List tokens to which API Access has been granted."
},
{
"info": {
"name": "Add API Access token",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/acct-api-token",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a API token."
},
{
"info": {
"name": "Update API Access token",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.extremecloudiq.com/acct-api-token/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update API token by ID."
},
{
"info": {
"name": "Delete API Access Token by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/acct-api-token/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing API Access Token by the specified ID."
},
{
"info": {
"name": "Bulk Delete API Access Token by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/acct-api-token_:delete",
"params": [
{
"name": "ids",
"value": "",
"type": "query",
"description": "The API Access Token ids to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Bulk Delete existing API Access Tokens by the specified IDs."
},
{
"info": {
"name": "List 3rd party API connection",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/third-party-api-connection",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List the 3rd party API connection."
},
{
"info": {
"name": "Update 3rd party API connection",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/third-party-api-connection",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the 3rd party API connection."
},
{
"info": {
"name": "Delete 3rd party API connection",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/third-party-api-connection",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an exist 3rd party API connection."
},
{
"info": {
"name": "List Credential Distribution Groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/credential-distribution-groups",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a page of Credential Distribution Groups."
},
{
"info": {
"name": "Create Credential Distribution Group",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/credential-distribution-groups",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new Credential Distribution Groups."
},
{
"info": {
"name": "Update Credential Distribution Group",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/credential-distribution-groups/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a existing Credential Distribution Group by the specified ID."
},
{
"info": {
"name": "Delete Credential Distribution Group by IDs",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/credential-distribution-groups_:delete",
"params": [
{
"name": "ids",
"value": "",
"type": "query",
"description": "The API Access Token ids to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing Credential Distribution Group by the specified IDs."
}
]
},
{
"info": {
"name": "Dashboard",
"type": "folder"
},
"items": [
{
"info": {
"name": "Alert statistics",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/alerts",
"params": [
{
"name": "alertsTimeRange",
"value": "",
"type": "query",
"description": "Alerts Time Range in days (defaults to 1 day)"
},
{
"name": "include_unassigned",
"value": "",
"type": "query",
"description": "To include unassigned location"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of different types of alerts (critical, warning, information, and total unacknowledged) based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Asset statistics",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/assets",
"params": [
{
"name": "include_unassigned",
"value": "",
"type": "query",
"description": "To include unassigned location"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of total devices, total offline devices, wired offline devices, and wireless offline devices based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Client health statistics",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/clients",
"params": [
{
"name": "include_unassigned",
"value": "",
"type": "query",
"description": "To include unassigned location"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of total clients, total unhealthy clients, wired unhealthy clients, and wireless unhealthy clients based on the provided filters.You can filter the results by sites."
},
{
"info": {
"name": "Device health statistics",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/devices",
"params": [
{
"name": "include_unassigned",
"value": "",
"type": "query",
"description": "To include unassigned location"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of total devices, total unhealthy devices, wired unhealthy devices, and wireless unhealthy devices based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Usage & capacity statistics",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/usage-capacity",
"params": [
{
"name": "include_unassigned",
"value": "",
"type": "query",
"description": "To include unassigned location"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of wired, wireless and total usage & capacity issues based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Sites with issues",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/sites-with-issues",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The site name filter"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order"
},
{
"name": "alertsTimeRange",
"value": "",
"type": "query",
"description": "Alerts Time Range in days (defaults to 1 day)"
},
{
"name": "include_unassigned",
"value": "",
"type": "query",
"description": "To include unassigned location"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the site names along with alerts, usage and capacity, assets, client health, and device health based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Dashboard device types",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/dashboard/device_types",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns a list of diagnostics device types."
},
{
"info": {
"name": "Export Sites with issues as CSV File",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/export",
"params": [
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The site name filter"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order"
},
{
"name": "alertsTimeRange",
"value": "",
"type": "query",
"description": "Alerts Time Range in days (defaults to 1 day)"
},
{
"name": "include_unassigned",
"value": "",
"type": "query",
"description": "To include unassigned location"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the site names along with alerts, usage and capacity, assets, client health, and device health based on the provided filters as CSV File. You can filter the results by sites."
},
{
"info": {
"name": "Criteria for Wireless Diagnostics Dashboard",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/dashboard/wireless/dashboard/criteria",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the criteria for wireless diagnostics dashboard, including client health, device health, and usage and capacity issues."
},
{
"info": {
"name": "Create Criteria for Wireless Diagnostics Dashboard",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/dashboard/criteria",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the criteria for wireless diagnostics dashboard, including client health, device health, and usage and capacity issues."
},
{
"info": {
"name": "Download the Export CSV file",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/dashboard/wireless/dashboard/reports/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The report ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the CSV File of the Site With Issue status based on the provided filters."
}
]
},
{
"info": {
"name": "D360",
"type": "folder"
},
"items": [
{
"info": {
"name": "Surrounding APs",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/d360/wireless/surrounding-aps",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "selectedTime",
"value": "",
"type": "query",
"description": "The selected time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a list of surrounding APs."
},
{
"info": {
"name": "Wireless Interfaces Stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/d360/wireless/interfaces-stats",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "selectedTime",
"value": "",
"type": "query",
"description": "The selected time to query, epoch time in milliseconds since 1/1/1970"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Statistics of wireless interfaces of a device."
},
{
"info": {
"name": "Get Device Summary",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/d360/overview/devices-summary",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List the summary of device details."
},
{
"info": {
"name": "Get Device Geo Location",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/d360/overview/devices-location",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the geographical location of device."
},
{
"info": {
"name": "Alerts Graph",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/d360/alert/graph",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
}
]
},
"docs": "List a list of alerts for Graphing API."
},
{
"info": {
"name": "Client Graph",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/d360/client/graph",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a list of connected clients for Graphing API of D360."
},
{
"info": {
"name": "Device metadata",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/d360/device-metadata",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
},
{
"name": "deviceType",
"value": "",
"type": "query",
"description": "The device type (wired/wireless)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "The device metadata like timestamp from which device is online and location."
},
{
"info": {
"name": "Installation Media-upload",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/d360/installation/media",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Upload installation media."
},
{
"info": {
"name": "Installation Media-delete",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/d360/installation/media",
"params": [
{
"name": "mediaId",
"value": "",
"type": "query",
"description": "The id of the media file"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete installation media."
},
{
"info": {
"name": "Wired Interfaces",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/d360/wired/interface-grid",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Wired Interfaces -Grid."
},
{
"info": {
"name": "Device Location",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/d360/device/location",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves the device location details on the map for the device."
},
{
"info": {
"name": "Device Issues",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/d360/device/issues",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves the various issues for device."
},
{
"info": {
"name": "Device Stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/d360/device/stats",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Grid of Device Stats."
},
{
"info": {
"name": "Wireless Interfaces Graph",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/d360/wireless/interfaces-graph",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "channel",
"value": "",
"type": "query",
"description": "The channel filters."
},
{
"name": "source",
"value": "",
"type": "query",
"description": "The source filters."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a list of wireless interfaces metrics for Graphing API."
},
{
"info": {
"name": "Client Stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/d360/client/stats",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Client statistics."
},
{
"info": {
"name": "Wireless Interfaces per device",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/d360/device/interfaces",
"params": [
{
"name": "deviceModel",
"value": "",
"type": "query",
"description": "The model of device"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List available wifi interfaces on device model."
},
{
"info": {
"name": "Client Grid",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/d360/client/grid",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search"
},
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "selectedTime",
"value": "",
"type": "query",
"description": "The selected time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "clientStatus",
"value": "",
"type": "query",
"description": "The client statistics filter."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List a list of connected clients for Graphing API of D360."
},
{
"info": {
"name": "SSID metadata of surrounding APs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/d360/wireless/surrounding-aps/ssid-metadata",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Grid of Device Stats."
},
{
"info": {
"name": "Events Graph",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/d360/event/graph",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time to query, epoch time in milliseconds since 1/1/1970"
},
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filter events by type. Only selected event types will be included in the response. Valid values: `CRITICAL`, `MAJOR`, `MINOR`, `INFO`, `ACTIVE`, `CLEARED`, `ALL`.\n"
}
]
},
"docs": "Retrieve a time-series graph of event metrics. Each timestamp includes an array of event types with their respective counts. Only selected filters will be included in the response."
},
{
"info": {
"name": "Wired QOS queue grid",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/d360/wired/queue-grid",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The unique device identifier. It can be virtual slot id and all stack ports will be returned or a member slot id and only that slot ports will be returned."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns all QOS queue statistics for a wired device."
}
]
},
{
"info": {
"name": "Dashboard - Wireless Client Health",
"type": "folder"
},
"items": [
{
"info": {
"name": "Wireless client health grid",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/client-health/grid",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order"
},
{
"name": "connectionStatus",
"value": "",
"type": "query",
"description": "The current connection status of the client (e.g., connected, disconnected)."
},
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned clients"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the client health grid of wireless devices based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Wireless clients count with connectivity issues",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/client-health/connectivity-issues",
"params": [
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned clients"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the wireless clients with connectivity issues based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Wireless clients count with frequency distribution",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/client-health/frequency-distribution",
"params": [
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned clients"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the wireless clients with different frequency distribution based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Count of wireless clients with roaming issues",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/client-health/roaming-issues",
"params": [
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned clients"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the wireless clients with roaming issues based on the provided filters. You can filter the results by sites, device types, and a specific timestamp."
},
{
"info": {
"name": "Wireless client health grid filter metadata",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/client-health/filter-metadata",
"params": [
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned clients"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns the client health health grid filter metadata. You can filter the results by sites."
},
{
"info": {
"name": "Wireless client health association issues",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/client-health/issue/association",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "macAddress",
"value": "",
"type": "query",
"description": "The macAddress to filter"
},
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned clients"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the client health association issues based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Wireless client health authentication issues",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/client-health/issue/authentication",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "macAddress",
"value": "",
"type": "query",
"description": "The macAddress to filter"
},
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned clients"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the client health authentication issues based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Wireless client health roaming issues",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/client-health/issue/roaming",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "macAddress",
"value": "",
"type": "query",
"description": "The macAddress to filter"
},
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned clients"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the client health roaming issues based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Wireless client health ip address issues",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/client-health/issue/ipaddress",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "macAddress",
"value": "",
"type": "query",
"description": "The macAddress to filter"
},
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned clients"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the client health ip address issues based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Export Grid as a CSV File",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/client-health/export",
"params": [
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order"
},
{
"name": "connectionStatus",
"value": "",
"type": "query",
"description": "The current connection status of the client (e.g., connected, disconnected)."
},
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned clients"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the CSV File of the client health grid of wireless devices based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Download the Export CSV file",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/dashboard/wireless/client-health/reports/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The report ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the CSV File of the Wireless Client Health status based on the provided filters."
}
]
},
{
"info": {
"name": "Dashboard - Wireless Usage and Capacity",
"type": "folder"
},
"items": [
{
"info": {
"name": "Wireless usage & capacity grid",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/usage-capacity/grid",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort order"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order"
},
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned devices"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the usage & capacity grid of wireless devices based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Count of APs with excessive packet loss",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/usage-capacity/excessive-packet-loss",
"params": [
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned devices"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of wireless devices having excessive packet loss based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Count of APs with excessive utilization",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/usage-capacity/excessive-utilization",
"params": [
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned devices"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of wireless devices having excessive channel utilization based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Count of APs with excessive retries",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/usage-capacity/excessive-retries",
"params": [
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned devices"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of wireless devices having excessive retries based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Export Wireless usage & capacity grid as CSV File ",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/usage-capacity/export",
"params": [
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order"
},
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned devices"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the CSV File of the usage & capacity grid of wireless devices based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Download the Export CSV file",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/dashboard/wireless/usage-capacity/reports/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The report ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the CSV File of the Wireless Usage And Capacity status based on the provided filters."
}
]
},
{
"info": {
"name": "Dashboard - Wireless Device Health",
"type": "folder"
},
"items": [
{
"info": {
"name": "Wireless device health grid",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/device-health/grid",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order"
},
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned devices"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the device health grid of wireless devices based on the provided filters. The results can be filtered by sites."
},
{
"info": {
"name": "CPU usage issues for wireless devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/device-health/issues/cpu-usage-issues",
"params": [
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned devices"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of wireless devices having CPU usage issues (CPU usage >= 95%) based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Memory usage issues for wireless devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/device-health/issues/memory-usage-issues",
"params": [
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned devices"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of wireless devices having Memory usage issues (CPU usage >= 95%) based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "PoE usage issues for wireless devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/device-health/issues/poe-usage-issues",
"params": [
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned devices"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of wireless devices having PoE usage issues (Non-adequate power) based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Device health summary for wireless devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/device-health/summary",
"params": [
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned devices"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of total wireless devices and total devices with health issues based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Wireless device reboot summary",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/dashboard/wireless/device-health/reboot/summary",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The deviceId to collect reboot summary"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the device reboot summary of a device."
},
{
"info": {
"name": "Wireless device health grid Export",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wireless/device-health/export",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order"
},
{
"name": "includeUnassigned",
"value": "",
"type": "query",
"description": "To include unassigned devices"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the device health grid export of wireless devices based on the provided filters. The results can be filtered by sites."
},
{
"info": {
"name": "Download the Export CSV file",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/dashboard/wireless/device-health/reports/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The report ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the CSV File of the wireless Device Health status based on the provided filters."
}
]
},
{
"info": {
"name": "Dashboard - Wired Client Health",
"type": "folder"
},
"items": [
{
"info": {
"name": "Wired client health grid",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/client-health/grid",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the client health grid of wired devices based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Wired clients count with IP connectivity issues",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/client-health/ip-connectivity-issues",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the wired clients with IP connectivity issues based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Wired clients count with port congestion issues",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/client-health/port-congestion",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the wired clients with port congestion issues based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Wired clients count with traffic anomalies",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/client-health/traffic-anomalies",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the wired clients with traffic anomalies based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Wired clients count with port errors",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/client-health/port-errors",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the wired clients with port errors based on the provided filters. You can filter the results by sites."
}
]
},
{
"info": {
"name": "Dashboard - Wired Device Health",
"type": "folder"
},
"items": [
{
"info": {
"name": "Device health summary for wired devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/device-health/summary",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of total wired devices and total devices with health issues based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "CPU usage issues for wired devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/device-health/cpu-usage-issues",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of wired devices having CPU usage issues (CPU usage >= 95%) based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Memory usage issues for wired devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/device-health/memory-usage-issues",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of wired devices having memory usage issues (memory usage >= 95%) based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Temperature issues for wired devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/device-health/temperature-issues",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of wired devices having temperature issues based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "PoE usage issues for wired devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/device-health/poe-usage-issues",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of wired devices having PoE usage issues based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Fan status issues for wired devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/device-health/fan-issues",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of wired devices having fan status issues based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "PSU status issues for wired devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/device-health/psu-issues",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the count of wired devices having PSU status issues based on the provided filters. You can filter the results by sites."
},
{
"info": {
"name": "Wired Device Health Grid",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/device-health/grid",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The sort field"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the device health grid of wired devices based on the provided filters. The results can be filtered by sites."
},
{
"info": {
"name": "PoE usage status for wired devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/device-health/poe-usage-status",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID to provide the PoE usage (all the slots will be provided for a stack)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the PoE usage for wired devices based on the provided device ID."
},
{
"info": {
"name": "Temperature status for wired devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/device-health/temperature-status",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID to provide the temperature (all the slots will be provided for a stack)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the temperature for wired devices based on the provided device ID."
},
{
"info": {
"name": "Fan status for wired devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/device-health/fan-status",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID to provide the fan health status (all the slots will be provided for a stack)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the fan health status for wired devices based on the provided device ID."
},
{
"info": {
"name": "PSU status for wired devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/device-health/psu-status",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID to provide the fan health status (all the slots will be provided for a stack)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the PSU health status for wired devices based on the provided device ID."
}
]
},
{
"info": {
"name": "Dashboard - Wired Usage and Capacity",
"type": "folder"
},
"items": [
{
"info": {
"name": "Wired Usage and Capacity grid",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/usage-capacity/grid",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search (hostname, IP or site)"
},
{
"name": "sortField",
"value": "",
"type": "query",
"description": "The field used for sorting."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns information related to usage and capacity for wired devices based on the provided filters. The result can be filtered by sites."
},
{
"info": {
"name": "Wired devices total utilized bandwidth",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/usage-capacity/usage-utilization",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns total bandwidth utilized by wired devices based on the provided filters. The result can be filtered by sites."
},
{
"info": {
"name": "Wired devices throughput",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/usage-capacity/wired-throughput",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the throughput for wired devices based on the provided filters. The result can be filtered by sites."
},
{
"info": {
"name": "Wired devices congestion",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/dashboard/wired/usage-capacity/wired-congestion",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the congestion for wired devices based on the provided filters. The result can be filtered by sites."
}
]
},
{
"info": {
"name": "Switch Inspector Panel",
"type": "folder"
},
"items": [
{
"info": {
"name": "Diagnostics Widget for Wired Devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/switch-inspector/diagnostics",
"params": [
{
"name": "deviceId",
"value": "",
"type": "query",
"description": "The device ID for which the \"Device Health\", \"Usage and Capacity\" and \"Client Health\" current number of issues needs to be provided"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the \"Device Health\", \"Usage and Capacity\" and \"Client Health\" current number of issues for wired devices based on the provided device ID."
}
]
},
{
"info": {
"name": "Geo-View",
"type": "folder"
},
"items": [
{
"info": {
"name": "Geo View Data",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/geo-view",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Geo View hierarchical data."
}
]
},
{
"info": {
"name": "NG Reports",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get scheduled reports",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ng-reports/reports",
"params": [
{
"name": "request",
"value": "",
"type": "query",
"description": "Type of report to retrieve"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "Keyword to search reports"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve scheduled reports based on frequency and keyword search."
},
{
"info": {
"name": "Create a new scheduled report",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ng-reports/reports",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new scheduled report with specified details."
},
{
"info": {
"name": "Update an existing scheduled report",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/ng-reports/reports/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the details of a scheduled report by its ID."
},
{
"info": {
"name": "Delete a scheduled report",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/ng-reports/reports/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a scheduled report by its unique identifier."
},
{
"info": {
"name": "Time Series data in NG Reports Metrics",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ng-reports/metrics/timeseries.yaml",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "This API returns the data for the graph widgets."
},
{
"info": {
"name": "Table Data data in NG Reports Metrics",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ng-reports/metrics/tabledata.yaml",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "This API returns the table (raw) Data data in NG Reports Metrics."
},
{
"info": {
"name": "Ssid filter metadata",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ng-reports/metrics/metadata/ssid",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns the Ssid filter metadata. You can filter the results by sites,buildings,floor."
},
{
"info": {
"name": "Client Os filter metadata",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ng-reports/metrics/metadata/os",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns the Client Os filter metadata. You can filter the results by sites,buildings,floor,ssid,band."
},
{
"info": {
"name": "Band filter metadata",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ng-reports/metrics/metadata/band",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns the Band filter metadata. You can filter the results by sites,buildings,floor,ssid."
},
{
"info": {
"name": "Client filter metadata",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ng-reports/metrics/metadata/client",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns the Client filter metadata. You can filter the results by sites,buildings,floor,usernames."
},
{
"info": {
"name": "User filter metadata",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ng-reports/metrics/metadata/user",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns the user filter metadata. You can filter the results by sites,buildings,floor."
},
{
"info": {
"name": "Application filter metadata",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ng-reports/metrics/metadata/applications",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns the Application filter metadata. You can filter the results by sites, buildings, floor, usernames, and client MAC addresses."
},
{
"info": {
"name": "Devices filter metadata",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ng-reports/metrics/metadata/devices",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns the Channel filter metadata. You can filter the results by sites,buildings,floor,channel,band."
},
{
"info": {
"name": "Grouping of Metrics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ng-reports/metrics/get-metrics-grouping"
},
"docs": "Provides detailed information about the grouping of different metrics."
},
{
"info": {
"name": "Download NG reports",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ng-reports/download/reports",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the Xlsx/pdf for provided metrics on the provided filters."
},
{
"info": {
"name": "Download the file",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ng-reports/download/reports/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The file name"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the file for the given metrics based on the provided filters."
},
{
"info": {
"name": "Information of filters",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ng-reports/information/:metrics",
"params": [
{
"name": "metrics",
"value": "",
"type": "path",
"description": "**The below table defines the different REPORT_METRICS values and their descriptions**\n\n| Metric Identifier | Description |\n|-----------------------------|-----------------------------------------------------------------------------|\n| MAX_CONCURRENT_CLIENTS | Maximum concurrent clients over time |\n| UNIQUE_CLIENTS_BY_SSID | Unique clients over time by SSID |\n| UNIQUE_WIFI_CLIENTS | Unique WiFi clients over time |\n| CLIENT_QUALITY_SCORE | Client quality score over time |\n| CLIENT_SESSIONS | Client sessions over time |\n| CLIENT_AIRTIME_USAGE | Client airtime usage over time |\n| WIRELESS_CLIENTS_BY_OS | Wireless clients categorized by OS |\n| UNIQUE_CLIENTS_BY_OS | Unique clients categorized by OS |\n| TRAFFIC_VOLUME_PER_APP | Traffic volume per application |\n| APP_TRAFFIC_PERCENTAGE | Percentage of total traffic per application |\n| DEVICES_BY_CLIENTS | Devices used by clients over time |\n| SWITCH_SUMMARY | Summary of switch-related metrics |\n"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns the filter for the given metrics."
}
]
},
{
"info": {
"name": "NG Scheduled Reports",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Scheduled Network Summary Reports",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ng-reports/scheduled/network-summary",
"params": [
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search the report file name and recipient email"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Fetches all the scheduled Network Summary Reports."
},
{
"info": {
"name": "Get Scheduled PCI Compliance Reports",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ng-reports/scheduled/pci-compliance",
"params": [
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search the report file name and recipient email"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Fetches all the scheduled PCI Compliance Reports."
},
{
"info": {
"name": "Enable/Disable Report Schedule",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.extremecloudiq.com/ng-reports/scheduled/:reportScheduleId",
"params": [
{
"name": "reportScheduleId",
"value": "",
"type": "path",
"description": "Unique identifier for the report schedule"
},
{
"name": "enableSchedule",
"value": "",
"type": "query",
"description": "Whether the schedule is enabled"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Enable/Disable an existing schedule for a Report."
},
{
"info": {
"name": "Get Scheduled Custom Reports",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ng-reports/scheduled/custom",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number, min = 1"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Page Size, min = 1, max = 100"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Frequency of the report (MONTHLY, WEEKLY, DAILY)"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search the report name and recipient email"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Fetches all the schedules for Custom Reports based on frequency."
},
{
"info": {
"name": "Create Schedule for Custom Report",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ng-reports/scheduled/custom",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates a schedule for a Custom Report using the provided schedule ID."
},
{
"info": {
"name": "Delete Report Schedules",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/ng-reports/scheduled/custom",
"params": [
{
"name": "reportScheduleIds",
"value": "",
"type": "query",
"description": "Comma-separated list of report schedule IDs to delete"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Deletes an existing schedule for a Report."
},
{
"info": {
"name": "Get Custom Report Schedule by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ng-reports/scheduled/custom/:reportId",
"params": [
{
"name": "reportId",
"value": "",
"type": "path",
"description": "Unique identifier of the scheduled report"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Fetches a specific scheduled custom report using its report ID."
},
{
"info": {
"name": "Edit Schedule for Custom Report",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/ng-reports/scheduled/custom/:reportId",
"params": [
{
"name": "reportId",
"value": "",
"type": "path",
"description": "Unique identifier for the report schedule"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Updates an existing schedule for a Custom Report."
},
{
"info": {
"name": "Get Report Runs for Custom Report Schedule",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ng-reports/scheduled/custom/:reportScheduleId/runs",
"params": [
{
"name": "reportScheduleId",
"value": "",
"type": "path",
"description": "Unique identifier for the report schedule"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Filter by frequency (MONTHLY, WEEKLY, DAILY)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves all report runs for a given custom report schedule."
},
{
"info": {
"name": "Delete Report Runs",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.extremecloudiq.com/ng-reports/scheduled/runs",
"params": [
{
"name": "reportRunIds",
"value": "",
"type": "query",
"description": "Comma-separated list of report run IDs to delete"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Deletes an existing Report schedule run."
},
{
"info": {
"name": "Get Recipients for given Report Run",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ng-reports/scheduled/runs/:reportRunId/recipients",
"params": [
{
"name": "reportRunId",
"value": "",
"type": "path",
"description": "Unique identifier for the report run"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves all recipients for a given report run ID."
},
{
"info": {
"name": "Get Recipients for given Report",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ng-reports/scheduled/:reportId/recipients",
"params": [
{
"name": "reportId",
"value": "",
"type": "path",
"description": "Unique identifier for the report"
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword to search"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves all recipients for a given report ID."
},
{
"info": {
"name": "Delete Recipients from Report",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/ng-reports/scheduled/:reportId/recipients",
"params": [
{
"name": "reportId",
"value": "",
"type": "path",
"description": "Unique identifier for the report"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Deletes a list of recipient emails from the specified report."
},
{
"info": {
"name": "Add Recipients to Report",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.extremecloudiq.com/ng-reports/scheduled/:reportId/recipients",
"params": [
{
"name": "reportId",
"value": "",
"type": "path",
"description": "Unique identifier for the report"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Adds a list of recipient emails to the specified report."
},
{
"info": {
"name": "Download or Preview Scheduled Report File",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/ng-reports/scheduled/reports/download",
"params": [
{
"name": "reportRunId",
"value": "",
"type": "query",
"description": "Unique identifier of the report to download"
},
{
"name": "fileFormat",
"value": "",
"type": "query",
"description": "File format to download (PDF or XLSX)"
},
{
"name": "preview",
"value": "",
"type": "query",
"description": "Param to view Preview, (applicable only when fileFormat = PDF)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Downloads or previews a scheduled report file in PDF or XLSX format."
}
]
},
{
"info": {
"name": "Client - Details",
"type": "folder"
},
"items": [
{
"info": {
"name": "Client Trail Topology",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/client-details/topology/client-trail/:macAddress",
"params": [
{
"name": "macAddress",
"value": "",
"type": "path",
"description": "The Mac Address of Client"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Return the Nodes and Links to draw the topology for client."
},
{
"info": {
"name": "Client Details Overview",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.extremecloudiq.com/client-details/overview/info/:clientId",
"params": [
{
"name": "clientId",
"value": "",
"type": "path",
"description": "The Id of Client"
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "The start time for the data to be returned (in milliseconds since epoch)"
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "The end time for the data to be returned (in milliseconds since epoch)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Return the Details for the clients."
}
]
},
{
"info": {
"name": "RTTS",
"type": "folder"
},
"items": [
{
"info": {
"name": "List RTTS supported devices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.extremecloudiq.com/rtts/supported-devices",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List RTTS supported devices for the specified location filter."
}
]
}
],
"bundled": true
}