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

The API documentation is still under draft.

API Guide

Concepts

We will explain some basic concepts in our ExtremeCloud IQ™ platform.

Term Description

XIQ

ExtremeCloud IQ™. The account created by the customer in our platform.

VIQ

Virtual ExtremeCloud IQ™. The VIQ data are stored at Regional Data Center (RDC). Ideally one XIQ account can have multiple VIQs, but currently we only allow one VIQ per XIQ.

HIQ

Hierarchical ExtremeCloud IQ™, a special XIQ account type allows the customers offers managed service using our platform to their own customers. In this mode, each VIQ can be further partitioned to multiple organizations (ORG).

ORG

HIQ organization, a logical unit in VIQ. An ORG in HIQ is similar to a VIQ in normal XIQ account.

GDC

Global Data Center. Store those data for customer’s accounts information and users information. We have multiple GDCs to store customer information in different countries to obey their laws and regulations.

RDC

Regional Data Center. Store those data for customer networks, such as devices, configurations, metrics, etc.

REST API Overview

All of our REST APIs strives to follow RESTful API best practices.

Endpoint

There are dozens of data centers managed by ExtremeCloud IQ™. Customer data and VIQ data are stored in one of them.

ExtremeCloud IQ™ provides a uniform API endpoint for users so that they don’t need to know which specific RDC to access.

The endpoint URL prefix: https://api.extremecloudiq.com
All API access is over HTTPS.

Path Templating

Path templating refers to the usage of curly braces {} to mark a section of a URL path as replaceable using path parameters.

HTTP Verbs

Where possible, REST API strives to use appropriate HTTP verbs for each action.

HTTP Verb Description

GET

Retrieving resources.

POST

Creating resources or calling business operations.

PUT

Replacing resources or creating resources if the resources don’t exist.

PATCH

Updating resources with partial JSON data.

DELETE

Deleting resources.

Media Type

All data is sent and received as JSON format if no explicit requirement.
HTTP Headers
Content-Type: application/json
Accept: application/json

HTTP Status Code

The HTTP Status Codes are used to indicate the status of the executed operation.

Table 1. Success
HTTP Status Code Description Use Cases

200

OK

Standard response for successful HTTP requests.

201

Created

The request has been fulfilled, resulting in the creation of a new resource.

202

Accepted

The request is queued for background processing (async tasks).

204

No Content

The server successfully processed the request and is not returning any content.

Table 2. Client Error
HTTP Status Description Use Cases Client recovery policy

400

Bad Request

The API endpoint exists, but the HTTP request syntax or payload is incorrect, detail will be given in response.

Do not retry. Fix the request.

401

Unauthorized

The server can be reached and understood the request, but refuses to take any further action, because the client must provide authorization.

If the client has provided authorization, the server is indicating the provided authorization is unsuitable or invalid.

If the user has not supplied authorization information, prompt them for the appropriate credentials.

If the user has supplied authorization information, inform them their credentials were rejected and optionally prompt them again.

403

Forbidden

The server can be reached and understood the request, but refuses to take any further action, because it is configured to deny access for some reason to the requested resource by the client.

Do not retry. Fix the request.

404

Not Found

The API endpoint doesn’t exist or resource doesn’t exist.

Do not retry. Fix the request.

415

Unsupported Media Type

The request entity has a media type which the server or resource does not support.

Do not retry. Fix the request.

Table 3. Server Error
HTTP Status Code Description Use Cases Client recovery policy

500

Internal Server Error

Server side Exception caught, detail will be given in response.

Ask user to retry later or the client automatically calls retry request.

503

Service Unavailable

The server is temporary unavailable.

Ask user to retry later or the client automatically calls retry request.

HTTP Response Schema

Successful Response

Successful response is the HTTP response with status code 2xx.

Single resource

Single resource response is object of key-value pairs.

{
  "key1": "...",
  "key2": 10,
  "key3": true
}
Multiple resources

Multiple resource response is the array of objects without pagination information.

[
  {
    "key1": "...",
    "key2": 10,
    "key3": true
  },
  {
    "key1": "...",
    "key2": 11,
    "key3": false
  }
]
Paged resources

Paged resource response is object with pagination information and array of paged objects.

{
  "pagination": {
    "total": {total objects},
    ""
  }
data: [
{
  "name1": "...",
  "name2": {number},
  "name3": true|false,
...
},
{
...
},
...
  ]
...
}
Unsuccessful Response

Unsuccessful response is the HTTP response with status code 4xx and 5xx.

Unsuccessful response schema
{
  "error": "...",
  "uuid": "...",
  "message": "..."
}
Name Required Description

error

The error code, used to classify different error type.

uuid

The unique identifier of the error message, used to locate error message in the backend.

message

The associated descriptive error message.

Common Fields
Name Format

Timestamp

ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

REST API Reference

Authentication

Login

POST /login
Request Fields

Unresolved directive in reference/authentication/login.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/login-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/authentication/login.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/login-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/authentication/login.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/login-success/response-fields.adoc[]

Successful Login Response

Unresolved directive in reference/authentication/login.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/login-success/http-response.adoc[]

Unsuccessful Login Response

Unresolved directive in reference/authentication/login.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/login-failed/http-response.adoc[]

cURL Request

Unresolved directive in reference/authentication/login.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/login-success/curl-request.adoc[]

Authorization

Generate API Token

POST /auth/apitoken
Request Fields

Unresolved directive in reference/authorization/apitoken/generate.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-api-token-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/authorization/apitoken/generate.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-api-token-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/authorization/apitoken/generate.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-api-token-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/authorization/apitoken/generate.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-api-token-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/authorization/apitoken/generate.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-api-token-success/curl-request.adoc[]

Get API Token details

GET /auth/apitoken/info
HTTP Request

Unresolved directive in reference/authorization/apitoken/show.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-api-token-info-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/authorization/apitoken/show.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-api-token-info-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/authorization/apitoken/show.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-api-token-info-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/authorization/apitoken/show.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-api-token-info-success/curl-request.adoc[]

Get user permissions

GET /auth/permissions
HTTP Request

Unresolved directive in reference/authorization/permission/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-auth-permissions-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/authorization/permission/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-auth-permissions-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/authorization/permission/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-auth-permissions-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/authorization/permission/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-auth-permissions-success/curl-request.adoc[]

Check permissions

POST /auth/permissions/:check
Request Fields

Unresolved directive in reference/authorization/permission/check.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/check-permissions-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/authorization/permission/check.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/check-permissions-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/authorization/permission/check.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/check-permissions-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/authorization/permission/check.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/check-permissions-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/authorization/permission/check.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/check-permissions-success/curl-request.adoc[]

Account

Switch account

POST /account/:switch
Request Parameters

Unresolved directive in reference/account/switch.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/switch-account-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/account/switch.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/switch-account-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/account/switch.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/switch-account-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/account/switch.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/switch-account-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/account/switch.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/switch-account-success/curl-request.adoc[] = List external accounts

GET /account/external
HTTP Request

Unresolved directive in reference/account/external.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-external-accounts-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/account/external.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-external-accounts-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/account/external.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-external-accounts-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/account/external.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-external-accounts-success/curl-request.adoc[] = Get basic info

GET /account/home
HTTP Request

Unresolved directive in reference/account/info.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-account-info-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/account/info.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-account-info-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/account/info.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-account-info-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/account/info.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-account-info-success/curl-request.adoc[]

Get VIQ info

GET /account/viq
HTTP Request

Unresolved directive in reference/account/viq/info.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-viq-info-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/account/viq/info.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-viq-info-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/account/viq/info.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-viq-info-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/account/viq/info.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-viq-info-success/curl-request.adoc[]

VIQ backup

POST /account/viq/:backup
HTTP Request

Unresolved directive in reference/account/viq/backup.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/backup-viq-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/account/viq/backup.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/backup-viq-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/account/viq/backup.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/backup-viq-success/curl-request.adoc[]

User

Get user list

GET /users
Request Parameters

Unresolved directive in reference/user/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-users-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/user/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-users-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/user/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-users-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/user/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-users-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/user/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-users-success/curl-request.adoc[] = Create new user

POST /users
Request Fields

Unresolved directive in reference/user/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-user-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/user/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-user-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/user/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-user-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/user/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-user-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/user/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-user-success/curl-request.adoc[] = Get user

GET /users/{id}
Path parameters

Unresolved directive in reference/user/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-user-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/user/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-user-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/user/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-user-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/user/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-user-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/user/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-user-success/curl-request.adoc[] = Delete user

DELETE /users/{id}
Path Parameters

Unresolved directive in reference/user/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-user-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/user/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-user-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/user/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-user-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/user/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-user-success/curl-request.adoc[] = Update user

PATCH /users/{id}
Path Parameters

Unresolved directive in reference/user/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/user/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/user/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/user/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/user/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/user/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-success/curl-request.adoc[]

Get external user list

GET /users/external
Request Parameters

Unresolved directive in reference/user/external/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-external-users-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/user/external/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-external-users-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/user/external/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-external-users-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/user/external/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-external-users-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/user/external/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-external-users-success/curl-request.adoc[] = Grant external user

POST /users/external
Request Fields

Unresolved directive in reference/user/external/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/grant-external-user-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/user/external/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/grant-external-user-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/user/external/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/grant-external-user-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/user/external/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/grant-external-user-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/user/external/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/grant-external-user-success/curl-request.adoc[] = Get external user

GET /users/external/{id}
Path parameters

Unresolved directive in reference/user/external/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-external-user-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/user/external/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-external-user-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/user/external/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-external-user-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/user/external/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-external-user-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/user/external/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-external-user-success/curl-request.adoc[] = Revoke external user

DELETE /users/external/{id}
Path Parameters

Unresolved directive in reference/user/external/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-external-user-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/user/external/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-external-user-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/user/external/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-external-user-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/user/external/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-external-user-success/curl-request.adoc[] = Update external user

PATCH /users/external/{id}
Path Parameters

Unresolved directive in reference/user/external/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-external-user-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/user/external/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-external-user-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/user/external/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-external-user-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/user/external/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-external-user-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/user/external/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-external-user-success/curl-request.adoc[]

Get current user

GET /users/me
HTTP Request

Unresolved directive in reference/user/profile.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-user-profile-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/user/profile.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-user-profile-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/user/profile.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-user-profile-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/user/profile.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-user-profile-success/curl-request.adoc[]

HIQ

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

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

Get HIQ context

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

GET /hiq/context
HTTP Request

Unresolved directive in reference/hiq/context/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-hiq-context-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/hiq/context/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-hiq-context-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/hiq/context/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-hiq-context-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/hiq/context/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-hiq-context-success/curl-request.adoc[] = Set HIQ context

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

PUT /hiq/context
Request Fields

Unresolved directive in reference/hiq/context/set.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-hiq-context-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/hiq/context/set.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-hiq-context-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/hiq/context/set.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-hiq-context-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/hiq/context/set.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-hiq-context-success/curl-request.adoc[]

Get creating context

Get organization for creating new data

GET /hiq/context/creating
HTTP Request

Unresolved directive in reference/hiq/context/creating/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-creating-org-id-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/hiq/context/creating/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-creating-org-id-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/hiq/context/creating/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-creating-org-id-success/curl-request.adoc[] = Set creating context

Set organization for creating new data

PUT /hiq/context/creating
HTTP Request

Unresolved directive in reference/hiq/context/creating/set.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-creating-org-id-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/hiq/context/creating/set.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-creating-org-id-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/hiq/context/creating/set.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-creating-org-id-success/curl-request.adoc[]

Get reading context

Get organizations for reading data

GET /hiq/context/reading
HTTP Request

Unresolved directive in reference/hiq/context/reading/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-reading-org-ids-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/hiq/context/reading/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-reading-org-ids-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/hiq/context/reading/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-reading-org-ids-success/curl-request.adoc[]

Set reading context

Set organizations for reading data

PUT /hhm/context/reading
HTTP Request

Unresolved directive in reference/hiq/context/reading/set.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-reading-org-ids-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/hiq/context/reading/set.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-reading-org-ids-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/hiq/context/reading/set.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-reading-org-ids-success/curl-request.adoc[]

Get all organizations

GET /hiq/organizations
HTTP Request

Unresolved directive in reference/hiq/organization/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-all-organization-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/hiq/organization/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-all-organization-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/hiq/organization/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-all-organization-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/hiq/organization/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-all-organization-success/curl-request.adoc[] = Create organization

POST /hiq/organizations
Request Fields

Unresolved directive in reference/hiq/organization/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-organization-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/hiq/organization/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-organization-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/hiq/organization/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-organization-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/hiq/organization/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-organization-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/hiq/organization/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-organization-success/curl-request.adoc[] = Delete organization

DELETE /hiq/organizations/{id}
Path Parameters

Unresolved directive in reference/hiq/organization/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-organization-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/hiq/organization/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-organization-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/hiq/organization/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-organization-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/hiq/organization/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-organization-success/curl-request.adoc[] = Rename organization

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

Unresolved directive in reference/hiq/organization/rename.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/rename-organization-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/hiq/organization/rename.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/rename-organization-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/hiq/organization/rename.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/rename-organization-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/hiq/organization/rename.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/rename-organization-success/curl-request.adoc[]

Get HIQ status

GET /hiq/status
HTTP Request

Unresolved directive in reference/hiq/status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-hiq-status-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/hiq/status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-hiq-status-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/hiq/status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-hiq-status-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/hiq/status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-hiq-status-success/curl-request.adoc[]

Location

Create location

POST /locations
Request Fields

Unresolved directive in reference/location/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-location-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/location/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-location-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/location/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-location-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/location/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-location-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/location/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-location-success/curl-request.adoc[] = Update location

PUT /locations/{id}
Path Parameters

Unresolved directive in reference/location/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-location-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/location/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-location-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/location/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-location-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/location/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-location-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/location/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-location-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/location/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-location-success/curl-request.adoc[] = Delete location

DELETE /locations/{id}
Path Parameters

Unresolved directive in reference/location/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-location-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/location/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-location-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/location/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-location-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/location/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-location-success/curl-request.adoc[]

Create building

POST /locations/building
Request Fields

Unresolved directive in reference/location/building/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-building-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/location/building/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-building-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/location/building/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-building-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/location/building/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-building-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/location/building/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-building-success/curl-request.adoc[] = Update building

PUT /locations/building/{id}
Path Parameters

Unresolved directive in reference/location/building/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-building-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/location/building/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-building-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/location/building/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-building-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/location/building/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-building-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/location/building/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-building-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/location/building/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-building-success/curl-request.adoc[] = Delete building

DELETE /locations/building/{id}
Path Parameters

Unresolved directive in reference/location/building/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-building-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/location/building/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-building-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/location/building/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-building-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/location/building/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-building-success/curl-request.adoc[]

Create floor

POST /locations/floor
Request Fields

Unresolved directive in reference/location/floor/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-floor-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/location/floor/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-floor-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/location/floor/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-floor-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/location/floor/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-floor-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/location/floor/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-floor-success/curl-request.adoc[] = Update floor

PUT /locations/floor/{id}
Path Parameters

Unresolved directive in reference/location/floor/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-floor-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/location/floor/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-floor-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/location/floor/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-floor-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/location/floor/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-floor-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/location/floor/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-floor-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/location/floor/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-floor-success/curl-request.adoc[] = Delete floor

DELETE /locations/floor/{id}
Path Parameters

Unresolved directive in reference/location/floor/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-floor-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/location/floor/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-floor-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/location/floor/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-floor-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/location/floor/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-floor-success/curl-request.adoc[] = Upload floor plan

POST /locations/floorplan
HTTP Request

Unresolved directive in reference/location/floor/upload.plan.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/upload-floor-plan-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/location/floor/upload.plan.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/upload-floor-plan-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/location/floor/upload.plan.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/upload-floor-plan-success/curl-request.adoc[]

Get location tree

GET /locations/tree
Request Parameters

Unresolved directive in reference/location/tree.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-location-tree-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/location/tree.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-location-tree-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/location/tree.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-location-tree-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/location/tree.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-location-tree-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/location/tree.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-location-tree-success/curl-request.adoc[]

Device

Get device list

GET /devices
Request Parameters

Unresolved directive in reference/device/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-devices-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-devices-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/device/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-devices-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/device/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-devices-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-devices-success/curl-request.adoc[]

Send CLI

Send CLI to devices.

POST /devices/:cli
Request Fields

Unresolved directive in reference/device/cli.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/send-cli-to-devices-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/device/cli.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/send-cli-to-devices-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/device/cli.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/send-cli-to-devices-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/device/cli.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/send-cli-to-devices-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/cli.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/send-cli-to-devices-success/curl-request.adoc[]

Delete devices

Delete devices by the given device ID list.

POST /devices/:delete
Request Fields

Unresolved directive in reference/device/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-devices-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/device/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-devices-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-devices-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-devices-success/curl-request.adoc[]

Change status to Managed

Change device management status to Managed status.

POST /devices/:manage
Request Fields

Unresolved directive in reference/device/manage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-status-to-manage-success/request-body.adoc[]

HTTP Request

Unresolved directive in reference/device/manage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-status-to-manage-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/manage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-status-to-manage-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/manage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-status-to-manage-success/curl-request.adoc[]

Onboard devices

POST /devices/:onboard
Request Fields

Unresolved directive in reference/device/onboard.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/onboard-devices-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/device/onboard.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/onboard-devices-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/onboard.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/onboard-devices-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/onboard.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/onboard-devices-success/curl-request.adoc[]

Reboot devices

POST /devices/:reboot
Request Fields

Unresolved directive in reference/device/reboot.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/reboot-devices-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/device/reboot.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/reboot-devices-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/reboot.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/reboot-devices-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/reboot.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/reboot-devices-success/curl-request.adoc[]

Change status to Unmanaged

Change device management status to Unmanaged status.

POST /devices/:unmanage
Request Fields

Unresolved directive in reference/device/unmanage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-status-to-unmanage-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/device/unmanage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-status-to-unmanage-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/unmanage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-status-to-unmanage-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/unmanage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-status-to-unmanage-success/curl-request.adoc[]

Get device details for one device

GET /devices/{id}
Path parameters

Unresolved directive in reference/device/show.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-success/path-parameters.adoc[]

Request Parameters

Unresolved directive in reference/device/show.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/show.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/device/show.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/device/show.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/show.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-success/curl-request.adoc[]

Delete device

Delete one device.

DELETE /devices/{id}
Path parameters

Unresolved directive in reference/device/delete.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-device-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/delete.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-device-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/delete.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-device-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/delete.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-device-success/curl-request.adoc[]

Send CLI to one device

Send CLI to one device.

POST /devices/{id}/:cli
Path parameters

Unresolved directive in reference/device/cli.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/send-cli-to-device-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/device/cli.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/send-cli-to-device-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/device/cli.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/send-cli-to-device-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/cli.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/send-cli-to-device-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/cli.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/send-cli-to-device-success/curl-request.adoc[]

Change status to Managed for one device

Change device management status to Managed status.

POST /devices/{id}/:manage
Path parameters

Unresolved directive in reference/device/manage.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-device-status-to-manage-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/manage.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-device-status-to-manage-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/manage.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-device-status-to-manage-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/manage.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-device-status-to-manage-success/curl-request.adoc[]

Reboot one device

POST /devices/{id}/:reboot
Path parameters

Unresolved directive in reference/device/reboot.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/reboot-device-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/reboot.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/reboot-device-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/reboot.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/reboot-device-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/reboot.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/reboot-device-success/curl-request.adoc[]

Change status to Unmanaged for one device

Change device management status to Unmanaged status.

POST /devices/{id}/:unmanage
Path parameters

Unresolved directive in reference/device/unmanage.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-device-status-to-unmanage-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/unmanage.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-device-status-to-unmanage-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/unmanage.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-device-status-to-unmanage-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/unmanage.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-device-status-to-unmanage-success/curl-request.adoc[]

Get device alarms for one device

GET /devices/{id}/alarms
Path parameters

Unresolved directive in reference/device/alarm.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-device-alarms-success/path-parameters.adoc[]

Request Parameters

Unresolved directive in reference/device/alarm.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-device-alarms-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/alarm.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-device-alarms-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/device/alarm.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-device-alarms-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/device/alarm.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-device-alarms-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/alarm.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-device-alarms-success/curl-request.adoc[]

Get device cpu and memory usage for one device

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

Unresolved directive in reference/device/cpu.mem.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-cpu-mem-success/path-parameters.adoc[]

Request Parameters

Unresolved directive in reference/device/cpu.mem.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-cpu-mem-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/cpu.mem.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-cpu-mem-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/device/cpu.mem.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-cpu-mem-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/device/cpu.mem.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-cpu-mem-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/cpu.mem.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-cpu-mem-success/curl-request.adoc[]

Change hostname for one device

PUT /devices/{id}/hostname
Path parameters

Unresolved directive in reference/device/hostname.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-hostname-success/path-parameters.adoc[]

Request Parameters

Unresolved directive in reference/device/hostname.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-hostname-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/hostname.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-hostname-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/hostname.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-hostname-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/hostname.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-hostname-success/curl-request.adoc[]

Get location for one device

GET /devices/{id}/location
Path parameters

Unresolved directive in reference/device/location/query.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-location-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/location/query.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-location-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/device/location/query.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-location-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/device/location/query.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-location-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/location/query.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-location-success/curl-request.adoc[]

Assign location to one device

PUT /devices/{id}/location
Path parameters

Unresolved directive in reference/device/location/assign.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-device-location-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/device/location/assign.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-device-location-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/device/location/assign.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-device-location-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/location/assign.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-device-location-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/location/assign.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-device-location-success/curl-request.adoc[]

Revoke location for one device

DELETE /devices/{id}/location
Path parameters

Unresolved directive in reference/device/location/revoke.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-device-location-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/location/revoke.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-device-location-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/location/revoke.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-device-location-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/location/revoke.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-device-location-success/curl-request.adoc[]

Get network policy for one device

GET /devices/{id}/network-policy
Path parameters

Unresolved directive in reference/device/network-policy/query.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-network-policy-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/network-policy/query.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-network-policy-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/device/network-policy/query.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-network-policy-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/device/network-policy/query.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-network-policy-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/network-policy/query.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-network-policy-success/curl-request.adoc[]

Assign network policy to one device

PUT /devices/{id}/network-policy
Path parameters

Unresolved directive in reference/device/network-policy/assign.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-device-network-policy-success/path-parameters.adoc[]

Request Parameters

Unresolved directive in reference/device/network-policy/assign.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-device-network-policy-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/network-policy/assign.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-device-network-policy-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/network-policy/assign.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-device-network-policy-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/network-policy/assign.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-device-network-policy-success/curl-request.adoc[]

Revoke network policy for one device

DELETE /devices/{id}/network-policy
Path parameters

Unresolved directive in reference/device/network-policy/revoke.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-device-network-policy-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/network-policy/revoke.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-device-network-policy-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/network-policy/revoke.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-device-network-policy-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/network-policy/revoke.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-device-network-policy-success/curl-request.adoc[]

Device level SSID override

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

Unresolved directive in reference/device/ssid/ssid.override.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/override-device-level-ssid-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/device/ssid/ssid.override.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/override-device-level-ssid-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/device/ssid/ssid.override.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/override-device-level-ssid-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/ssid/ssid.override.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/override-device-level-ssid-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/ssid/ssid.override.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/override-device-level-ssid-success/curl-request.adoc[]

Get device level SSID status on each wifi interface

GET /devices/{id}/ssid/status
Path parameters

Unresolved directive in reference/device/ssid/get.ssid.status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-level-ssid-status-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/ssid/get.ssid.status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-level-ssid-status-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/device/ssid/get.ssid.status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-level-ssid-status-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/device/ssid/get.ssid.status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-level-ssid-status-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/ssid/get.ssid.status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-device-level-ssid-status-success/curl-request.adoc[]

Change the device level SSID status on each wifi interface

POST /devices/{id}/ssid/status/:change
Path parameters

Unresolved directive in reference/device/ssid/change.ssid.status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-device-level-ssid-status-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/device/ssid/change.ssid.status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-device-level-ssid-status-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/device/ssid/change.ssid.status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-device-level-ssid-status-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/ssid/change.ssid.status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-device-level-ssid-status-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/ssid/change.ssid.status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-device-level-ssid-status-success/curl-request.adoc[]

Assign location to multiple devices

POST /devices/location/:assgin
Request Fields

Unresolved directive in reference/device/location/assign.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-devices-location-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/device/location/assign.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-devices-location-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/location/assign.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-devices-location-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/location/assign.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-devices-location-success/curl-request.adoc[]

Query location for multiple devices

POST /devices/location/:query
Request Fields

Unresolved directive in reference/device/location/query.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/query-devices-location-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/device/location/query.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/query-devices-location-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/device/location/query.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/query-devices-location-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/device/location/query.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/query-devices-location-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/location/query.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/query-devices-location-success/curl-request.adoc[]

Revoke location for multiple devices

POST /devices/location/:revoke
Request Fields

Unresolved directive in reference/device/location/revoke.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-devices-location-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/device/location/revoke.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-devices-location-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/location/revoke.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-devices-location-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/location/revoke.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-devices-location-success/curl-request.adoc[]

Assign network policy to multiple devices

POST /devices/network-policy/:assgin
Request Fields

Unresolved directive in reference/device/network-policy/assign.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-devices-network-policy-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/device/network-policy/assign.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-devices-network-policy-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/network-policy/assign.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-devices-network-policy-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/network-policy/assign.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-devices-network-policy-success/curl-request.adoc[]

Query network policy for multiple devices

POST /devices/network-policy/:query
Request Fields

Unresolved directive in reference/device/network-policy/query.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/query-devices-location-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/device/network-policy/query.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/query-devices-network-policy-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/device/network-policy/query.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/query-devices-location-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/device/network-policy/query.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/query-devices-location-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/network-policy/query.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/query-devices-location-success/curl-request.adoc[]

Revoke network policy for multiple devices

POST /devices/network-policy/:revoke
Request Fields

Unresolved directive in reference/device/network-policy/revoke.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-devices-network-policy-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/device/network-policy/revoke.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-devices-network-policy-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/network-policy/revoke.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-devices-network-policy-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/network-policy/revoke.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-devices-network-policy-success/curl-request.adoc[]

List assigned devices for network policy

GET /devices/network-policy/{policyId}
Path parameters

Unresolved directive in reference/device/list.per.network.policy.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-devices-by-network-policy-success/path-parameters.adoc[]

Request Parameters

Unresolved directive in reference/device/list.per.network.policy.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-devices-by-network-policy-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/list.per.network.policy.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-devices-by-network-policy-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/device/list.per.network.policy.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-devices-by-network-policy-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/device/list.per.network.policy.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-devices-by-network-policy-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/list.per.network.policy.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-devices-by-network-policy-success/curl-request.adoc[]

Change multiple devices OS mode

POST /devices/os/:change
Request Fields

Unresolved directive in reference/device/os.change.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-devices-os-mode-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/device/os.change.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-devices-os-mode-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/os.change.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-devices-os-mode-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/os.change.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-devices-os-mode-success/curl-request.adoc[]

Assign radius proxy to multiple devices

PUT /devices/radius-proxy/:assgin
Request Parameters

Unresolved directive in reference/device/radius-proxy/assign.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-devices-radius-proxy-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/radius-proxy/assign.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-devices-radius-proxy-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/radius-proxy/assign.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-devices-radius-proxy-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/radius-proxy/assign.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-devices-radius-proxy-success/curl-request.adoc[]

Revoke radius proxy for multiple devices

DELETE /devices/radius-proxy/:revoke
Request Parameters

Unresolved directive in reference/device/radius-proxy/revoke.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-devices-radius-proxy-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/radius-proxy/revoke.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-devices-radius-proxy-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/device/radius-proxy/revoke.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-devices-radius-proxy-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/radius-proxy/revoke.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/revoke-devices-radius-proxy-success/curl-request.adoc[]

List device status summary

GET /device/stats
Request Parameters

Unresolved directive in reference/device/status.summary.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-device-status-summary-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/device/status.summary.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-device-status-summary-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/device/status.summary.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-device-status-summary-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/device/status.summary.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-device-status-summary-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/device/status.summary.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-device-status-summary-success/curl-request.adoc[]

Network Policy

List network policies

GET /network-policies
Request Parameters

Unresolved directive in reference/network-policy/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-network-polices-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/network-policy/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-network-polices-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/network-policy/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-network-polices-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/network-policy/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-network-polices-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/network-policy/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-network-polices-success/curl-request.adoc[]

List SSID list for the network policy

GET /network-policies/{id}/ssids
Path Parameters

Unresolved directive in reference/network-policy/list.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ssids-by-network-policy-success/path-parameters.adoc[]

Request Parameters

Unresolved directive in reference/network-policy/list.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ssids-by-network-policy-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/network-policy/list.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ssids-by-network-policy-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/network-policy/list.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ssids-by-network-policy-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/network-policy/list.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ssids-by-network-policy-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/network-policy/list.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ssids-by-network-policy-success/curl-request.adoc[]

Adding multiple SSIDs to the network policy

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

Unresolved directive in reference/network-policy/add.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/add-ssids-to-network-policy-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/network-policy/add.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/add-ssids-to-network-policy-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/network-policy/add.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/add-ssids-to-network-policy-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/network-policy/add.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/add-ssids-to-network-policy-success/curl-request.adoc[]

Removing multiple SSIDs from the network policy

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

Unresolved directive in reference/network-policy/remove.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/remove-ssids-from-network-policy-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/network-policy/remove.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/remove-ssids-from-network-policy-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/network-policy/remove.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/remove-ssids-from-network-policy-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/network-policy/remove.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/remove-ssids-from-network-policy-success/curl-request.adoc[]

Client

Get client details for one client

GET /clients/{id}
Path parameters

Unresolved directive in reference/client/show.client.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-client-success/path-parameters.adoc[]

Request Parameters

Unresolved directive in reference/client/show.client.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-client-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/client/show.client.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-client-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/client/show.client.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-client-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/client/show.client.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-client-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/client/show.client.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-client-success/curl-request.adoc[]

Get client list

GET /clients/active
Request Parameters

Unresolved directive in reference/client/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-active-clients-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/client/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-active-clients-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/client/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-active-clients-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/client/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-active-clients-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/client/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-active-clients-success/curl-request.adoc[]

Get client summary

GET /clients/summary
Request Parameters

Unresolved directive in reference/client/summary.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-active-clients-summary-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/client/summary.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-active-clients-summary-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/client/summary.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-active-clients-summary-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/client/summary.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-active-clients-summary-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/client/summary.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-active-clients-summary-success/curl-request.adoc[]

Get client usage

GET /clients/usage
Request Parameters

Unresolved directive in reference/client/usage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-clients-usage-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/client/usage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-clients-usage-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/client/usage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-clients-usage-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/client/usage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-clients-usage-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/client/usage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-clients-usage-success/curl-request.adoc[]

Application

List the applications

GET /applications
Request Parameters

Unresolved directive in reference/application/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-applications-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/application/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-applications-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/application/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-applications-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/application/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-applications-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/application/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-applications-success/curl-request.adoc[]

List Top N clients usage for one application

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

Unresolved directive in reference/application/list-application-top-n-clients-usage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-application-top-n-clients-usage-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/application/list-application-top-n-clients-usage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-application-top-n-clients-usage-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/application/list-application-top-n-clients-usage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-application-top-n-clients-usage-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/application/list-application-top-n-clients-usage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-application-top-n-clients-usage-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/application/list-application-top-n-clients-usage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-application-top-n-clients-usage-success/curl-request.adoc[]

List Top N applications usage

GET /applications/top{n}
Path parameters

Unresolved directive in reference/application/list-top-n-applications-usage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-top-n-applications-usage-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/application/list-top-n-applications-usage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-top-n-applications-usage-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/application/list-top-n-applications-usage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-top-n-applications-usage-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/application/list-top-n-applications-usage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-top-n-applications-usage-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/application/list-top-n-applications-usage.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-top-n-applications-usage-success/curl-request.adoc[]

Log

List Accounting Log

GET /logs/accounting
Request Parameters

Unresolved directive in reference/log/accounting.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-accounting-logs-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/log/accounting.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-accounting-logs-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/log/accounting.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-accounting-logs-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/log/accounting.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-accounting-logs-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/log/accounting.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-accounting-logs-success/curl-request.adoc[]

List Audit Log

GET /logs/audit
Request Parameters

Unresolved directive in reference/log/audit.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-audit-logs-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/log/audit.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-audit-logs-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/log/audit.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-audit-logs-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/log/audit.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-audit-logs-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/log/audit.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-audit-logs-success/curl-request.adoc[]

List Authentication Log

GET /logs/auth
Request Parameters

Unresolved directive in reference/log/auth.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-auth-logs-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/log/auth.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-auth-logs-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/log/auth.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-auth-logs-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/log/auth.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-auth-logs-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/log/auth.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-auth-logs-success/curl-request.adoc[]

List Credential Log

GET /logs/credential
Request Parameters

Unresolved directive in reference/log/credential.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-credential-logs-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/log/credential.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-credential-logs-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/log/credential.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-credential-logs-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/log/credential.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-credential-logs-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/log/credential.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-credential-logs-success/curl-request.adoc[]

List Email Log

GET /logs/email
Request Parameters

Unresolved directive in reference/log/email.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-email-logs-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/log/email.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-email-logs-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/log/email.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-email-logs-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/log/email.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-email-logs-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/log/email.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-email-logs-success/curl-request.adoc[]

List SMS Log

GET /logs/sms
Request Parameters

Unresolved directive in reference/log/sms.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-sms-logs-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/log/sms.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-sms-logs-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/log/sms.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-sms-logs-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/log/sms.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-sms-logs-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/log/sms.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-sms-logs-success/curl-request.adoc[]

Unresolved directive in reference/index.adoc - include::webhook/index.adoc[]

Configuration - Deployment

Push configuration and upgrade firmware to devices

POST /deployments
Request Fields

Unresolved directive in reference/configuration/deployment/deploy.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/deploy-config-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/deployment/deploy.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/deploy-config-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/deployment/deploy.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/deploy-config-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/deployment/deploy.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/deploy-config-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/deployment/deploy.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/deploy-config-success/curl-request.adoc[]

Get configuration deployment overview

GET /deployments/overview
HTTP Request

Unresolved directive in reference/configuration/deployment/overview.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-deploy-overview-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/deployment/overview.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-deploy-overview-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/deployment/overview.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-deploy-overview-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/deployment/overview.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-deploy-overview-success/curl-request.adoc[]

Get configuration deployment status

GET /deployments/status
Request Parameters

Unresolved directive in reference/configuration/deployment/status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-deploy-status-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/deployment/status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-deploy-status-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/deployment/status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-deploy-status-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/deployment/status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-deploy-status-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/deployment/status.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-deploy-status-success/curl-request.adoc[]

Configuration - Basic

List the Vlan Profiles

GET /vlan-profiles
Request Parameters

Unresolved directive in reference/configuration/basic/vlan-profile/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-vlan-profile-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/basic/vlan-profile/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-vlan-profile-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/basic/vlan-profile/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-vlan-profile-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/basic/vlan-profile/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-vlan-profile-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/basic/vlan-profile/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-vlan-profile-success/curl-request.adoc[] = Create Vlan Profile Configuration

POST /vlan-profiles
Request Fields

Unresolved directive in reference/configuration/basic/vlan-profile/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-vlan-profile-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/basic/vlan-profile/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-vlan-profile-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/basic/vlan-profile/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-vlan-profile-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/basic/vlan-profile/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-vlan-profile-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/basic/vlan-profile/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-vlan-profile-success/curl-request.adoc[] = Get Vlan Profile by ID

GET /vlan-profiles/{id}
Path parameters

Unresolved directive in reference/configuration/basic/vlan-profile/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-vlan-profile-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/basic/vlan-profile/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-vlan-profile-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/basic/vlan-profile/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-vlan-profile-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/basic/vlan-profile/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-vlan-profile-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/basic/vlan-profile/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-vlan-profile-success/curl-request.adoc[] = Delete Vlan Profile configuration

DELETE /vlan-profiles/{id}
Path Parameters

Unresolved directive in reference/configuration/basic/vlan-profile/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-vlan-profile-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/basic/vlan-profile/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-vlan-profile-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/basic/vlan-profile/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-vlan-profile-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/basic/vlan-profile/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-vlan-profile-success/curl-request.adoc[] = Update Vlan Profile configuration

PATCH /vlan-profiles/{id}
Path Parameters

Unresolved directive in reference/configuration/basic/vlan-profile/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-vlan-profile-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/basic/vlan-profile/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-vlan-profile-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/basic/vlan-profile/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-vlan-profile-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/basic/vlan-profile/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-vlan-profile-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/basic/vlan-profile/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-vlan-profile-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/basic/vlan-profile/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-vlan-profile-success/curl-request.adoc[]

Configuration - User Management

List email templates

GET /email-templates
Request Parameters

Unresolved directive in reference/configuration/usermgmt/email-templates.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-email-templates-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/email-templates.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-email-templates-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/usermgmt/email-templates.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-email-templates-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/email-templates.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-email-templates-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/email-templates.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-email-templates-success/curl-request.adoc[]

List end users

GET /endusers
Request Parameters

Unresolved directive in reference/configuration/usermgmt/end-user/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-end-users-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/end-user/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-end-users-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/usermgmt/end-user/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-end-users-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/end-user/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-end-users-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/end-user/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-end-users-success/curl-request.adoc[] = Create end user

POST /endusers
Request Fields

Unresolved directive in reference/configuration/usermgmt/end-user/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-end-user-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/end-user/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-end-user-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/usermgmt/end-user/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-end-user-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/end-user/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-end-user-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/end-user/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-end-user-success/curl-request.adoc[] = Update end user

PUT /endusers/{id}
Path Parameters

Unresolved directive in reference/configuration/usermgmt/end-user/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-end-user-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/usermgmt/end-user/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-end-user-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/end-user/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-end-user-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/usermgmt/end-user/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-end-user-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/end-user/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-end-user-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/end-user/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-end-user-success/curl-request.adoc[] = Delete end user

DELETE /endusers/{id}
Path Parameters

Unresolved directive in reference/configuration/usermgmt/end-user/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-end-user-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/end-user/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-end-user-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/end-user/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-end-user-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/end-user/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-end-user-success/curl-request.adoc[]

List all Key Based PCG entries

GET /pcgs/key-based
HTTP Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-key-based-pcg-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-key-based-pcg-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-key-based-pcg-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-key-based-pcg-success/curl-request.adoc[] = Initiate Key Based PCG

Initiate Key Based PCG network Policy, include initiate user, user group, SSID and Key Based PCGentry data

POST /pcgs/key-based
Request Fields

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/init.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/init-key-based-pcg-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/init.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/init-key-based-pcg-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/init.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/init-key-based-pcg-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/init.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/init-key-based-pcg-success/curl-request.adoc[] = Delete Key Based PCG

Delete Key Based PCG from network policy

DELETE /pcgs/key-based/network-policy-{policyId}
Path Parameters

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-key-based-pcg-success/path-parameters.adoc[]

Request Parameters

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-key-based-pcg-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-key-based-pcg-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-key-based-pcg-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-key-based-pcg-success/curl-request.adoc[] = Create Key Based PCG Data

Create Key Based PCG entry from exist network policy, SSID profile and users.

POST /pcgs/key-based/network-policy-{policyId}/:onboard
Path Parameters

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/onboard.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/onboard-key-based-pcg-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/onboard.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/onboard-key-based-pcg-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/onboard.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/onboard-key-based-pcg-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/onboard.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/onboard-key-based-pcg-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/onboard.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/onboard-key-based-pcg-success/curl-request.adoc[] = Email keys

Email keys for Key Based PCG users

POST /pcgs/key-based/network-policy-{policyId}/keys/:email
Path Parameters

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/email-keys.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/email-key-based-pcg-keys-success/path-parameters.adoc[]

Request Parameters

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/email-keys.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/email-key-based-pcg-keys-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/email-keys.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/email-key-based-pcg-keys-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/email-keys.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/email-key-based-pcg-keys-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/email-keys.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/email-key-based-pcg-keys-success/curl-request.adoc[] = Generate keys

Generate keys for Key Based PCG users

POST /pcgs/key-based/network-policy-{policyId}/keys/:generate
Path Parameters

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/generate-keys.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/generate-key-based-pcg-keys-success/path-parameters.adoc[]

Request Parameters

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/generate-keys.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/generate-key-based-pcg-keys-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/generate-keys.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/generate-key-based-pcg-keys-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/generate-keys.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/generate-key-based-pcg-keys-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/generate-keys.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/generate-key-based-pcg-keys-success/curl-request.adoc[] = Get port assignment details of AP150W

GET /pcgs/key-based/network-policy-{policyId}/port-assignments
Path Parameters

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/assign-ports-details.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-port-assignment-details-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/assign-ports-details.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-port-assignment-details-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/assign-ports-details.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-port-assignment-details-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/assign-ports-details.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-port-assignment-details-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/assign-ports-details.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-port-assignment-details-success/curl-request.adoc[] = Assign ports for AP150W

POST /pcgs/key-based/network-policy-{policyId}/port-assignments
Path Parameters

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/assign-ports.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-ports-for-pcg-key-based-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/assign-ports.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-ports-for-pcg-key-based-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/assign-ports.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-ports-for-pcg-key-based-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/assign-ports.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-ports-for-pcg-key-based-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/assign-ports.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-ports-for-pcg-key-based-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/assign-ports.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/assign-ports-for-pcg-key-based-success/curl-request.adoc[] = Get Key Based PCG users from given network policy ID

GET /pcgs/key-based/network-policy-{policyId}/users
Path Parameters

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/get-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-key-based-pcg-users-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/get-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-key-based-pcg-users-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/get-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-key-based-pcg-users-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/get-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-key-based-pcg-users-success//http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/get-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-key-based-pcg-users-success//curl-request.adoc[] = Replace all Key Based PCG users

PUT /pcgs/key-based/network-policy-{policyId}/users
Path Parameters

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/update-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-key-based-pcg-users-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/update-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-key-based-pcg-users-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/update-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-key-based-pcg-users-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/update-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-key-based-pcg-users-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/update-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-key-based-pcg-users-success/curl-request.adoc[] = Add Key Based PCG users to an exists Key Based PCG

POST /pcgs/key-based/network-policy-{policyId}/users
Path Parameters

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/create-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-key-based-pcg-users-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/create-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-key-based-pcg-users-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/create-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-key-based-pcg-users-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/create-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-key-based-pcg-users-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/create-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-key-based-pcg-users-success/curl-request.adoc[] = Delete Key Based PCG users

DELETE /pcgs/key-based/network-policy-{policyId}/users
Path Parameters

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/delete-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-key-based-pcg-users-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/delete-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-key-based-pcg-users-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/delete-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-key-based-pcg-users-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/delete-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-key-based-pcg-users-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/key-based-pcg/delete-users.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-key-based-pcg-users-success/curl-request.adoc[]

List sms templates

GET /sms-templates
Request Parameters

Unresolved directive in reference/configuration/usermgmt/sms-templates.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-sms-templates-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/sms-templates.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-sms-templates-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/usermgmt/sms-templates.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-sms-templates-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/sms-templates.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-sms-templates-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/sms-templates.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-sms-templates-success/curl-request.adoc[]

List user groups

GET /usergroups
Request Parameters

Unresolved directive in reference/configuration/usermgmt/user-group/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-user-groups-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/user-group/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-user-groups-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/usermgmt/user-group/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-user-groups-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/user-group/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-user-groups-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/user-group/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-user-groups-success/curl-request.adoc[] = Create user group

POST /usergroups
Request Fields

Unresolved directive in reference/configuration/usermgmt/user-group/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-user-group-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/user-group/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-user-group-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/usermgmt/user-group/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-user-group-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/user-group/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-user-group-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/user-group/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-user-group-success/curl-request.adoc[] = Update user group

PUT /usergroups/{id}
Path Parameters

Unresolved directive in reference/configuration/usermgmt/user-group/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-group-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/usermgmt/user-group/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-group-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/user-group/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-group-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/usermgmt/user-group/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-group-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/user-group/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-group-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/user-group/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-group-success/curl-request.adoc[] = Delete user group

DELETE /usergroups/{id}
Path Parameters

Unresolved directive in reference/configuration/usermgmt/user-group/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-user-group-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/usermgmt/user-group/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-user-group-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/usermgmt/user-group/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-user-group-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/usermgmt/user-group/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-user-group-success/curl-request.adoc[]

Configuration - Policy

List cloud config groups

GET /ccgs
Request Parameters

Unresolved directive in reference/configuration/policy/cloud-config-group/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ccgs-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/cloud-config-group/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ccgs-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/policy/cloud-config-group/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ccgs-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/cloud-config-group/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ccgs-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/cloud-config-group/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ccgs-success/curl-request.adoc[] = Create cloud config group

POST /ccgs
Request Fields

Unresolved directive in reference/configuration/policy/cloud-config-group/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-ccg-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/cloud-config-group/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-ccg-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/policy/cloud-config-group/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-ccg-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/cloud-config-group/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-ccg-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/cloud-config-group/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-ccg-success/curl-request.adoc[] = Get cloud config group

GET /ccgs/{id}
Path parameters

Unresolved directive in reference/configuration/policy/cloud-config-group/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-ccg-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/cloud-config-group/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-ccg-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/policy/cloud-config-group/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-ccg-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/cloud-config-group/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-ccg-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/cloud-config-group/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-ccg-success/curl-request.adoc[] = Update cloud config group

PUT /ccgs/{id}
Path Parameters

Unresolved directive in reference/configuration/policy/cloud-config-group/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-ccg-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/policy/cloud-config-group/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-ccg-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/cloud-config-group/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-ccg-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/policy/cloud-config-group/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-ccg-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/cloud-config-group/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-ccg-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/cloud-config-group/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-ccg-success/curl-request.adoc[] = Delete cloud config group

DELETE /ccgs/{id}
Path Parameters

Unresolved directive in reference/configuration/policy/cloud-config-group/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-ccg-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/cloud-config-group/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-ccg-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/cloud-config-group/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-ccg-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/cloud-config-group/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-ccg-success/curl-request.adoc[]

List the Classification Rules

GET /classification-rules
Request Parameters

Unresolved directive in reference/configuration/policy/classification-rule/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-classification-rule-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/classification-rule/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-classification-rule-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/policy/classification-rule/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-classification-rule-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/classification-rule/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-classification-rule-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/classification-rule/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-classification-rule-success/curl-request.adoc[] = Create Classification Rule Configuration

POST /classification-rules
Request Fields

Unresolved directive in reference/configuration/policy/classification-rule/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-classification-rule-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/classification-rule/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-classification-rule-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/policy/classification-rule/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-classification-rule-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/classification-rule/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-classification-rule-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/classification-rule/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-classification-rule-success/curl-request.adoc[] = Get Classification Rule by ID

GET /classification-rules/{id}
Path Parameters

Unresolved directive in reference/configuration/policy/classification-rule/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-classification-rule-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/classification-rule/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-classification-rule-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/policy/classification-rule/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-classification-rule-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/classification-rule/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-classification-rule-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/classification-rule/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-classification-rule-success/curl-request.adoc[] = Update Classification Rule configuration

PUT /classification-rules/{id}
Path Parameters

Unresolved directive in reference/configuration/policy/classification-rule/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-classification-rule-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/policy/classification-rule/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-classification-rule-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/classification-rule/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-classification-rule-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/policy/classification-rule/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-classification-rule-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/classification-rule/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-classification-rule-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/classification-rule/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-classification-rule-success/curl-request.adoc[] = Delete Classification Rule configuration

DELETE /classification-rules/{id}
Path Parameters

Unresolved directive in reference/configuration/policy/classification-rule/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-classification-rule-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/classification-rule/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-classification-rule-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/classification-rule/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-classification-rule-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/classification-rule/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-classification-rule-success/curl-request.adoc[]

List the L3 Address Profile

GET /l3-address-profiles
Request Parameters

Unresolved directive in reference/configuration/policy/l3-address-profile/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-l3-address-profiles-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/l3-address-profile/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-l3-address-profiles-success/http-request.adoc[]

HTTP Response Fields

Unresolved directive in reference/configuration/policy/l3-address-profile/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-l3-address-profiles-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/l3-address-profile/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-l3-address-profiles-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/l3-address-profile/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-l3-address-profiles-success/curl-request.adoc[]

List SSIDs

GET /ssids
Request Parameters

Unresolved directive in reference/configuration/policy/ssid/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ssids-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/ssid/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ssids-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/policy/ssid/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ssids-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/ssid/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ssids-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/ssid/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ssids-success/curl-request.adoc[] = Rename SSID(Wireless name)

POST /ssids/{id}/:rename
Path Parameters

Unresolved directive in reference/configuration/policy/ssid/rename.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/rename-ssid-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/ssid/rename.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/rename-ssid-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/ssid/rename.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/rename-ssid-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/ssid/rename.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/rename-ssid-success/curl-request.adoc[] = Attach CWP to an SSID

POST /ssids/{id}/cwp/:attach
Path Parameters

Unresolved directive in reference/configuration/policy/ssid/attach.cwp.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/attach-cwp-to-ssid-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/ssid/attach.cwp.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/attach-cwp-to-ssid-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/ssid/attach.cwp.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/attach-cwp-to-ssid-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/ssid/attach.cwp.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/attach-cwp-to-ssid-success/curl-request.adoc[] = Disable and detach the CWP on the SSID

POST /ssids/{id}/cwp/:disable
Path Parameters

Unresolved directive in reference/configuration/policy/ssid/disable.ssid.cwp.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/disable-ssid-cwp-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/ssid/disable.ssid.cwp.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/disable-ssid-cwp-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/ssid/disable.ssid.cwp.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/disable-ssid-cwp-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/ssid/disable.ssid.cwp.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/disable-ssid-cwp-success/curl-request.adoc[] = Enable and attach the CWP on the SSID

POST /ssids/{id}/cwp/:enable
Path Parameters

Unresolved directive in reference/configuration/policy/ssid/enable.ssid.cwp.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/enable-ssid-cwp-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/ssid/enable.ssid.cwp.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/enable-ssid-cwp-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/ssid/enable.ssid.cwp.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/enable-ssid-cwp-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/ssid/enable.ssid.cwp.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/enable-ssid-cwp-success/curl-request.adoc[] = Set SSID mode to Dot1x

PUT /ssids/{id}/mode/dot1x
Path Parameters

Unresolved directive in reference/configuration/policy/ssid/set.mode.dot1x.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-dot1x-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/policy/ssid/set.mode.dot1x.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-dot1x-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/ssid/set.mode.dot1x.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-dot1x-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/ssid/set.mode.dot1x.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-dot1x-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/ssid/set.mode.dot1x.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-dot1x-success/curl-request.adoc[] = Set SSID mode to open access

PUT /ssids/{id}/mode/open
Path Parameters

Unresolved directive in reference/configuration/policy/ssid/set.mode.open.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-open-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/ssid/set.mode.open.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-open-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/ssid/set.mode.open.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-open-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/ssid/set.mode.open.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-open-success/curl-request.adoc[] = Set SSID mode to PPSK

PUT /ssids/{id}/mode/ppsk
Path Parameters

Unresolved directive in reference/configuration/policy/ssid/set.mode.ppsk.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-ppsk-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/policy/ssid/set.mode.ppsk.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-ppsk-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/ssid/set.mode.ppsk.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-ppsk-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/ssid/set.mode.ppsk.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-ppsk-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/ssid/set.mode.ppsk.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-ppsk-success/curl-request.adoc[] = Set SSID mode to PSK

PUT /ssids/{id}/mode/psk
Path Parameters

Unresolved directive in reference/configuration/policy/ssid/set.mode.psk.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-psk-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/policy/ssid/set.mode.psk.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-psk-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/ssid/set.mode.psk.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-psk-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/ssid/set.mode.psk.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-psk-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/ssid/set.mode.psk.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-psk-success/curl-request.adoc[] = Set SSID mode to WEP

PUT /ssids/{id}/mode/wep
Path Parameters

Unresolved directive in reference/configuration/policy/ssid/set.mode.wep.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-wep-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/policy/ssid/set.mode.wep.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-wep-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/ssid/set.mode.wep.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-wep-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/ssid/set.mode.wep.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-wep-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/ssid/set.mode.wep.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/set-ssid-mode-wep-success/curl-request.adoc[] = Change the SSID PSK password

PUT /ssids/{id}/psk/password
Path Parameters

Unresolved directive in reference/configuration/policy/ssid/change.psk.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-psk-password-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/ssid/change.psk.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-psk-password-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/ssid/change.psk.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-psk-password-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/ssid/change.psk.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/change-psk-password-success/curl-request.adoc[] = Attach radius server group to an SSID

POST /ssids/{id}/radius-server-group/:attach
Path parameters

Unresolved directive in reference/configuration/policy/ssid/attach.radius-server-group.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/attach-radius-server-group-to-ssid-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/ssid/attach.radius-server-group.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/attach-radius-server-group-to-ssid-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/ssid/attach.radius-server-group.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/attach-radius-server-group-to-ssid-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/ssid/attach.radius-server-group.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/attach-radius-server-group-to-ssid-success/curl-request.adoc[] = Attach user profile to an SSID

POST /ssids/{id}/user-profile/:attach
Path parameters

Unresolved directive in reference/configuration/policy/ssid/attach.up.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/attach-user-profile-to-ssid-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/ssid/attach.up.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/attach-user-profile-to-ssid-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/ssid/attach.up.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/attach-user-profile-to-ssid-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/ssid/attach.up.ssid.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/attach-user-profile-to-ssid-success/curl-request.adoc[]

List the User Profiles

GET /user-profiles
Request Parameters

Unresolved directive in reference/configuration/policy/user-profile/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-user-profile-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/user-profile/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-user-profile-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/policy/user-profile/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-user-profile-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/user-profile/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-user-profile-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/user-profile/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-user-profile-success/curl-request.adoc[] = Create User Profile Configuration

POST /user-profiles
Request Fields

Unresolved directive in reference/configuration/policy/user-profile/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-user-profile-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/user-profile/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-user-profile-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/policy/user-profile/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-user-profile-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/user-profile/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-user-profile-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/user-profile/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-user-profile-success/curl-request.adoc[] = Get User Profile by ID

GET /user-profiles/{id}
Path Parameters

Unresolved directive in reference/configuration/policy/user-profile/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-user-profile-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/user-profile/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-user-profile-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/policy/user-profile/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-user-profile-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/user-profile/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-user-profile-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/user-profile/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-user-profile-success/curl-request.adoc[] = Update User Profile configuration

PUT /user-profiles/{id}
Path Parameters

Unresolved directive in reference/configuration/policy/user-profile/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-profile-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/policy/user-profile/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-profile-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/user-profile/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-profile-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/policy/user-profile/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-profile-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/user-profile/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-profile-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/user-profile/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-user-profile-success/curl-request.adoc[] = Delete User Profile configuration

DELETE /user-profiles/{id}
Path Parameters

Unresolved directive in reference/configuration/policy/user-profile/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-user-profile-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/policy/user-profile/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-user-profile-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/policy/user-profile/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-user-profile-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/policy/user-profile/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-user-profile-success/curl-request.adoc[]

Configuration - Authentication

List the Active Directory Server

GET /ad-servers
Request Parameters

Unresolved directive in reference/configuration/authentication/active-directory-server/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-active-directory-server-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/active-directory-server/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-active-directory-server-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/active-directory-server/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-active-directory-server-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/active-directory-server/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-active-directory-server-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/active-directory-server/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-active-directory-server-success/curl-request.adoc[]

List captive web portals

GET /cwps
Request Parameters

Unresolved directive in reference/configuration/authentication/cwp/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-cwps-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/cwp/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-cwps-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/cwp/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-cwps-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/cwp/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-cwps-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/cwp/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-cwps-success/curl-request.adoc[]

List LDAP servers

GET /ldap-servers
Request Parameters

Unresolved directive in reference/configuration/authentication/ldap-server/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ldap-servers-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/ldap-server/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ldap-servers-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/ldap-server/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ldap-servers-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/ldap-server/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ldap-servers-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/ldap-server/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-ldap-servers-success/curl-request.adoc[] = Create LDAP server

POST /ldap-servers
Request Fields

Unresolved directive in reference/configuration/authentication/ldap-server/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-ldap-server-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/ldap-server/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-ldap-server-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/ldap-server/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-ldap-server-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/ldap-server/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-ldap-server-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/ldap-server/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-ldap-server-success/curl-request.adoc[] = Get LDAP server

GET /ldap-servers/{id}
Path parameters

Unresolved directive in reference/configuration/authentication/ldap-server/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-ldap-server-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/ldap-server/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-ldap-server-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/ldap-server/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-ldap-server-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/ldap-server/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-ldap-server-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/ldap-server/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-ldap-server-success/curl-request.adoc[] = Update LDAP server

PUT /ldap-servers/{id}
Path Parameters

Unresolved directive in reference/configuration/authentication/ldap-server/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-ldap-server-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/authentication/ldap-server/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-ldap-server-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/ldap-server/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-ldap-server-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/ldap-server/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-ldap-server-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/ldap-server/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-ldap-server-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/ldap-server/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-ldap-server-success/curl-request.adoc[] = Delete LDAP server

DELETE /ldap-servers/{id}
Path Parameters

Unresolved directive in reference/configuration/authentication/ldap-server/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-ldap-server-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/ldap-server/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-ldap-server-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/ldap-server/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-ldap-server-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/ldap-server/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-ldap-server-success/curl-request.adoc[]

List the RADIUS Client Objects Configuration

GET /radius-client-objects
Request Parameters

Unresolved directive in reference/configuration/authentication/radius-client-object/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-radius-client-objects-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-client-object/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-radius-client-objects-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/radius-client-object/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-radius-client-objects-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-client-object/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-radius-client-objects-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-client-object/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-radius-client-objects-success/curl-request.adoc[] = Create RADIUS Client Object Configuration

POST /radius-client-objects
Request Fields

Unresolved directive in reference/configuration/authentication/radius-client-object/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-radius-client-object-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-client-object/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-radius-client-object-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/radius-client-object/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-radius-client-object-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-client-object/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-radius-client-object-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-client-object/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-radius-client-object-success/curl-request.adoc[] = List the RADIUS Client Object Configuration by ID

GET /radius-client-objects/{id}
Path parameters

Unresolved directive in reference/configuration/authentication/radius-client-object/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-radius-client-object-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-client-object/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-radius-client-object-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/radius-client-object/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-radius-client-object-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-client-object/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-radius-client-object-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-client-object/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-radius-client-object-success/curl-request.adoc[] = Update RADIUS Client Object Configuration

PUT /radius-client-objects/{id}
Path Parameters

Unresolved directive in reference/configuration/authentication/radius-client-object/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-radius-client-object-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/authentication/radius-client-object/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-radius-client-object-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-client-object/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-radius-client-object-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-client-object/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-radius-client-object-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-client-object/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-radius-client-object-success/curl-request.adoc[] = Delete RADIUS Client Object Configuration

DELETE /radius-client-objects/{id}
Path Parameters

Unresolved directive in reference/configuration/authentication/radius-client-object/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-radius-client-object-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-client-object/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-radius-client-object-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-client-object/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-radius-client-object-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-client-object/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-radius-client-object-success/curl-request.adoc[]

List the RADIUS Proxy Configuration

GET /radius-proxies
Request Parameters

Unresolved directive in reference/configuration/authentication/radius-proxy/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-radius-proxy-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-proxy/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-radius-proxy-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/radius-proxy/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-radius-proxy-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-proxy/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-radius-proxy-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-proxy/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-radius-proxy-success/curl-request.adoc[] = List the RADIUS proxy devices

GET /radius-proxies/devices
Request Parameters

Unresolved directive in reference/configuration/authentication/radius-proxy/list.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-radius-proxy-devices-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-proxy/list.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-radius-proxy-devices-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/radius-proxy/list.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-radius-proxy-devices-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-proxy/list.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-radius-proxy-devices-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-proxy/list.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-radius-proxy-devices-success/curl-request.adoc[] = Create RADIUS Proxy Configuration

POST /radius-proxies
Request Fields

Unresolved directive in reference/configuration/authentication/radius-proxy/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-radius-proxy-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-proxy/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-radius-proxy-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/radius-proxy/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-radius-proxy-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-proxy/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-radius-proxy-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-proxy/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-radius-proxy-success/curl-request.adoc[] = Get the RADIUS Proxy Configuration by ID

GET /radius-proxies/{id}
Path parameters

Unresolved directive in reference/configuration/authentication/radius-proxy/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-radius-proxy-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-proxy/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-radius-proxy-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/radius-proxy/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-radius-proxy-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-proxy/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-radius-proxy-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-proxy/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-radius-proxy-success/curl-request.adoc[] = Update RADIUS Proxy Configuration

PUT /radius-proxies/{id}
Path Parameters

Unresolved directive in reference/configuration/authentication/radius-proxy/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-radius-proxy-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/authentication/radius-proxy/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-radius-proxy-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-proxy/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-radius-proxy-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/radius-proxy/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-radius-proxy-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-proxy/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-radius-proxy-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-proxy/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-radius-proxy-success/curl-request.adoc[] = Delete RADIUS Proxy Configuration

DELETE /radius-proxies/{id}
Path Parameters

Unresolved directive in reference/configuration/authentication/radius-proxy/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-radius-proxy-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-proxy/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-radius-proxy-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-proxy/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-radius-proxy-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-proxy/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-radius-proxy-success/curl-request.adoc[]

List the external RADIUS servers

GET /radius-servers/external
Request Parameters

Unresolved directive in reference/configuration/authentication/radius-server/external/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-external-radius-servers-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-server/external/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-external-radius-servers-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/radius-server/external/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-external-radius-servers-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-server/external/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-external-radius-servers-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-server/external/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-external-radius-servers-success/curl-request.adoc[] = Create External RADIUS Server Configuration

POST /radius-servers/external
Request Fields

Unresolved directive in reference/configuration/authentication/radius-server/external/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-external-radius-server-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-server/external/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-external-radius-server-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/radius-server/external/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-external-radius-server-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-server/external/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-external-radius-server-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-server/external/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-external-radius-server-success/curl-request.adoc[] = List the external RADIUS server by ID

GET /radius-servers/external/{id}
Path Parameters

Unresolved directive in reference/configuration/authentication/radius-server/external/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-external-radius-server-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-server/external/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-external-radius-server-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/radius-server/external/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-external-radius-server-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-server/external/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-external-radius-server-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-server/external/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-external-radius-server-success/curl-request.adoc[] = Update external RADIUS server configuration

PUT /radius-servers/external/{id}
Path Parameters

Unresolved directive in reference/configuration/authentication/radius-server/external/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-external-radius-server-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/authentication/radius-server/external/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-external-radius-server-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-server/external/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-external-radius-server-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-server/external/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-external-radius-server-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-server/external/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-external-radius-server-success/curl-request.adoc[] = Delete external RADIUS server configuration

DELETE /radius-servers/external/{id}
Path Parameters

Unresolved directive in reference/configuration/authentication/radius-server/external/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-external-radius-server-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-server/external/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-external-radius-server-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-server/external/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-external-radius-server-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-server/external/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-external-radius-server-success/curl-request.adoc[]

List the internal RADIUS servers

GET /radius-servers/internal
Request Parameters

Unresolved directive in reference/configuration/authentication/radius-server/internal/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-internal-radius-servers-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-server/internal/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-internal-radius-servers-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/radius-server/internal/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-internal-radius-servers-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-server/internal/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-internal-radius-servers-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-server/internal/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-internal-radius-servers-success/curl-request.adoc[] = List the internal RADIUS devices

GET /radius-servers/internal/devices
Request Parameters

Unresolved directive in reference/configuration/authentication/radius-server/internal/list.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-internal-radius-devices-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-server/internal/list.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-internal-radius-devices-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/radius-server/internal/list.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-internal-radius-devices-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-server/internal/list.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-internal-radius-devices-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-server/internal/list.device.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-internal-radius-devices-success/curl-request.adoc[] = Create Internal RADIUS Server Configuration

POST /radius-servers/internal
Request Fields

Unresolved directive in reference/configuration/authentication/radius-server/internal/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-internal-radius-server-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-server/internal/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-internal-radius-server-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/radius-server/internal/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-internal-radius-server-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-server/internal/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-internal-radius-server-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-server/internal/create.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/create-internal-radius-server-success/curl-request.adoc[] = List the internal RADIUS server by ID

GET /radius-servers/internal/{id}
Path Parameters

Unresolved directive in reference/configuration/authentication/radius-server/internal/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-internal-radius-server-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-server/internal/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-internal-radius-server-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/radius-server/internal/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-internal-radius-server-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-server/internal/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-internal-radius-server-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-server/internal/get.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/get-internal-radius-server-success/curl-request.adoc[] = Update internal RADIUS server configuration

PUT /radius-servers/internal/{id}
Path Parameters

Unresolved directive in reference/configuration/authentication/radius-server/internal/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-internal-radius-server-success/path-parameters.adoc[]

Request Fields

Unresolved directive in reference/configuration/authentication/radius-server/internal/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-internal-radius-server-success/request-fields.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-server/internal/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-internal-radius-server-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/authentication/radius-server/internal/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-internal-radius-server-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-server/internal/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-internal-radius-server-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-server/internal/update.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/update-internal-radius-server-success/curl-request.adoc[] = Delete internal RADIUS server configuration

DELETE /radius-servers/internal/{id}
Path Parameters

Unresolved directive in reference/configuration/authentication/radius-server/internal/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-internal-radius-server-success/path-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/authentication/radius-server/internal/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-internal-radius-server-success/http-request.adoc[]

HTTP Response

Unresolved directive in reference/configuration/authentication/radius-server/internal/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-internal-radius-server-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/authentication/radius-server/internal/delete.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/delete-internal-radius-server-success/curl-request.adoc[]

Configuration - Certificate

List certificates

GET /certificates
Request Parameters

Unresolved directive in reference/configuration/certificate/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-certificates-by-type-success/request-parameters.adoc[]

HTTP Request

Unresolved directive in reference/configuration/certificate/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-certificates-by-type-success/http-request.adoc[]

Response Fields

Unresolved directive in reference/configuration/certificate/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-certificates-by-type-success/response-fields.adoc[]

HTTP Response

Unresolved directive in reference/configuration/certificate/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-certificates-by-type-success/http-response.adoc[]

cURL Request

Unresolved directive in reference/configuration/certificate/list.adoc - include::/var/lib/jenkins/workspace/XIQ-SNAPSHOT-BUILDS/Feature-SNAPSHOT-builds/xcloudiq-api/xcloudiq-api-doc/target/generated-snippets/list-certificates-by-type-success/curl-request.adoc[]

Release Notes

This section summarizes the changes in each release.

Version 1.0 - 09/10/2020

The initial release covers the ExtremeCloud IQ core features.

Authentication
  • Support username/password authentication

Authorization
  • Fine-grained and flexible access control

  • Generate new API Token

  • Show user permissions

  • Permission check

Account
  • Get XIQ Account basic information

  • Get VIQ information

User
  • Get user profile

HIQ
  • Get HIQ status

  • Enable HIQ

  • Organization management

  • Switch HIQ context

Device
  • Get device list

  • Get device details

  • Device onboarding

  • Delete device

  • Send CLI to device

  • Reboot device

  • Push configuration

  • Switch device management status

Monitoring
  • Get client list

  • Get client details