Endpoints
Skip to sectionGET | /v1/licenses/assignments |
POST | /v1/licenses/assignments/actions/add |
POST | /v1/licenses/assignments/actions/delete |
POST | /v1/licenses/assignments/actions/update |
GET | /v1/licenses/consumption |
GET | /v1/licenses/overview |
GET | /v1/licenses/settings |
PUT | /v1/licenses/settings |
GET | /v1/licenses/status |
Retrieves assignments for the current tenant
Facts GET /v1/licenses/assignments
Rate limit required | Tier 1 (1000 requests per minute) |
Header Parameters GET /v1/licenses/assignments
authorization string<bearer> | Authentication token |
Query Parameters GET /v1/licenses/assignments
filter string | The filter for finding entries. |
limit default=20, minimum=1, maximum=100 integer<int32> | The preferred number of entries to return. |
page string | The requested page. |
sort string | The field to sort on; can be prefixed with +/- for ascending/descending sort order. |
Responses GET /v1/licenses/assignments
200 application/json | List of assignments. |
400 application/json | Bad request, invalid query. |
401 application/json | Unauthorized (invalid token). |
403 application/json | Insufficient access |
GET/v1/licenses/assignments
curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/assignments" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/licenses/assignments
{
"data": [
{
"type": "analyzer",
"excess": false,
"created": "2020-12-03T09:24:48.114Z",
"subject": "qlik\\kalle"
},
{
"type": false,
"created": "2020-12-03T09:24:48.114Z",
"subject": "qlik\\nalle"
}
],
"links": {
"next": {
"href": "http://license/v1/licenses/assignments?limit=4&page=bmV4dDpGZ0FBQUFkZmFXUUFYOHBUcTlpM1U4UU1YWHZrQUE%3D"
},
"prev": {
"href": "http://license/v1/licenses/assignments?limit=4&page=cHJldjpGZ0FBQUFkZmFXUUFYOHBUcTlpM1U4UU1YWHZ0QUE%3D"
}
}
}
Assigns license access to the given users
Facts POST /v1/licenses/assignments/actions/add
Rate limit required | Tier 2 (100 requests per minute) |
Header Parameters POST /v1/licenses/assignments/actions/add
authorization string<bearer> | Authentication token |
Request Body POST /v1/licenses/assignments/actions/add
application/json | List of subjects to allocate assignments for. |
Responses POST /v1/licenses/assignments/actions/add
207 application/json | Processed. (The status of the individual assignments is found in the response body) |
400 application/json | Body is invalid or missing. |
401 application/json | Unauthorized (invalid token). |
403 application/json | Insufficient access |
POST/v1/licenses/assignments/actions/add
curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/assignments/actions/add" \
-X POST \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"add":[{"type":"professional","subject":"qlik\\kalle"},{"type":"analyzer","subject":"qlik\\nalle"}]}'
Request POST /v1/licenses/assignments/actions/add
{
"add": [
{
"type": "professional",
"subject": "qlik\\kalle"
},
{
"type": "analyzer",
"subject": "qlik\\nalle"
}
]
}
Response POST /v1/licenses/assignments/actions/add
{
"data": [
{
"type": "professional",
"status": 201,
"subject": "qlik\\kalle"
},
{
"code": "LICENSES-011",
"type": "analyzer",
"title": "No available allotment error, No available allotment.",
"status": 403,
"subject": "qlik\\nalle"
}
]
}
Removes license access for the given users
Facts POST /v1/licenses/assignments/actions/delete
Rate limit required | Tier 2 (100 requests per minute) |
Header Parameters POST /v1/licenses/assignments/actions/delete
authorization string<bearer> | Authentication token |
Request Body POST /v1/licenses/assignments/actions/delete
application/json | List of assignments to delete. |
Responses POST /v1/licenses/assignments/actions/delete
207 application/json | Processed. (The status of the individual assignments is found in the response body) |
400 application/json | Body is invalid or missing. |
401 application/json | Unauthorized (invalid token). |
403 application/json | Insufficient access |
POST/v1/licenses/assignments/actions/delete
curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/assignments/actions/delete" \
-X POST \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"delete":[{"type":"analyzer","subject":"qlik\\malik"}]}'
Request POST /v1/licenses/assignments/actions/delete
{
"delete": [
{
"type": "analyzer",
"subject": "qlik\\malik"
}
]
}
Response POST /v1/licenses/assignments/actions/delete
{
"data": [
{
"type": "professional",
"status": 200,
"subject": "qlik\\malik"
},
{
"code": "LICENSES-016",
"type": "analyzer",
"title": "Assignment not found.",
"status": 404,
"subject": "qlik\\no"
}
]
}
Updates license access for the given users
Facts POST /v1/licenses/assignments/actions/update
Rate limit required | Tier 2 (100 requests per minute) |
Header Parameters POST /v1/licenses/assignments/actions/update
authorization string<bearer> | Authentication token |
Request Body POST /v1/licenses/assignments/actions/update
application/json | List of assignments to update. |
Responses POST /v1/licenses/assignments/actions/update
207 application/json | Processed. (The status of the individual assignments is found in the response body) |
400 application/json | Body is invalid or missing. |
401 application/json | Unauthorized (invalid token). |
403 application/json | Insufficient access |
POST/v1/licenses/assignments/actions/update
curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/assignments/actions/update" \
-X POST \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"update":[{"type":"professional","subject":"qlik\\malik","sourceType":"analyzer"}]}'
Request POST /v1/licenses/assignments/actions/update
{
"update": [
{
"type": "professional",
"subject": "qlik\\malik",
"sourceType": "analyzer"
}
]
}
Response POST /v1/licenses/assignments/actions/update
{
"data": [
{
"type": "professional",
"status": 200,
"subject": "qlik\\malik",
"sourceType": "analyzer"
},
{
"code": "LICENSES-016",
"title": "Assignment not found.",
"status": 404,
"subject": "qlik/sara",
"sourceType": "analyzer"
}
]
}
Retrieves license consumption for the current tenant
Facts GET /v1/licenses/consumption
Rate limit required | Tier 1 (1000 requests per minute) |
Header Parameters GET /v1/licenses/consumption
authorization string<bearer> | Authentication token |
Query Parameters GET /v1/licenses/consumption
filter string | The filter for finding entries. |
limit default=200, minimum=1, maximum=200 integer<int32> | The preferred number of entries to return. |
page string | The requested page. |
sort string | The field to sort on; can be prefixed with +/- for ascending/descending sort order. |
Responses GET /v1/licenses/consumption
200 application/json | Successful |
400 application/json | Bad request, malformed query. |
401 application/json | Unauthorized (invalid token). |
403 application/json | Insufficient access |
GET/v1/licenses/consumption
curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/consumption" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/licenses/consumption
{
"data": [
{
"id": "string",
"appId": "string",
"userId": "string",
"endTime": "string",
"duration": "string",
"sessionId": "string",
"allotmentId": "string",
"minutesUsed": 0,
"capacityUsed": 0,
"licenseUsage": "string"
}
],
"links": {
"next": {
"href": "string"
},
"prev": {
"href": "string"
}
}
}
Gets the general information of the license applied to the current tenant
Facts GET /v1/licenses/overview
Rate limit required | Tier 1 (1000 requests per minute) |
Header Parameters GET /v1/licenses/overview
authorization string<bearer> | Authentication token. |
Responses GET /v1/licenses/overview
200 application/json | Licenses overview info. |
400 application/json | invalid tenant |
401 application/json | Unauthorized (invalid token). |
404 application/json | License not found. |
GET/v1/licenses/overview
curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/overview" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/licenses/overview
{
"trial": false,
"valid": "2018-01-01/2018-12-31",
"origin": "Internal",
"status": "Ok",
"product": "Qlik Sense Enterprise SaaS",
"allotments": [
{
"name": "analyzer_time",
"units": 300,
"overage": 100,
"unitsUsed": 242,
"usageClass": "time"
},
{
"name": "professional",
"units": 200,
"unitsUsed": 15,
"usageClass": "assigned"
}
],
"licenseKey": "hejhbGciOiJSUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6IktFWTEifQ.eyJqdGkiOiIxZjZkZTc0Zi04MDcyLTRjMTQtYjc1OS02ZjlkYmJmYWM5MjAiLCJsaWNlbnNlIjoiOTk5OTAwMDAwMDAwMTIzNCJ9.fwa6l6gY1MR_Ja2OMnV65V68fbzQYW5OAKUFnLfG9oZjNAbjhdDkZvS2S2zHaBnSrSva1ARh5iq_S0KTBOKKcJJDTb7jRVURyaAvbCuBDk_0ITrUudHaT9U_Mc9EKkfT8mR6vthhZxVzEhyYPFS7gDw7M6bav2ntpDsoJFPgous",
"parameters": [
{
"name": "qlikAlerting",
"valid": "./.",
"values": {
"saas_alerting": "FULL"
}
}
],
"licenseNumber": "9999000000001204",
"secondaryNumber": "12345"
}
Get auto assign settings for tenant.
Facts GET /v1/licenses/settings
Rate limit required | Tier 1 (1000 requests per minute) |
Header Parameters GET /v1/licenses/settings
authorization string<bearer> | Authentication token |
Responses GET /v1/licenses/settings
200 application/json | Auto assign settings. |
400 application/json | Missing or invalid tenant. |
401 application/json | Not allowed |
403 application/json | Insufficient access |
GET/v1/licenses/settings
curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/settings" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/licenses/settings
{
"autoAssignAnalyzer": true,
"autoAssignProfessional": false
}
Set auto assign settings for tenant
Facts PUT /v1/licenses/settings
Rate limit required | Tier 2 (100 requests per minute) |
Header Parameters PUT /v1/licenses/settings
authorization string<bearer> | Authentication token |
Request Body PUT /v1/licenses/settings
application/json | Dynamic assignment settings for professional and analyzer users. If professional users and analyzer users are both set, professional users will be automatically assigned, if available. Otherwise, analyzer users will be assigned. If neither of those users are available, analyzer capacity will be assigned, if available. |
Responses PUT /v1/licenses/settings
200 application/json | Auto assign settings. |
400 application/json | Missing or invalid tenant. |
401 application/json | Action not allowed. |
403 application/json | Insufficient access |
PUT/v1/licenses/settings
curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/settings" \
-X PUT \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"autoAssignAnalyzer":true,"autoAssignProfessional":false}'
Request PUT /v1/licenses/settings
{
"autoAssignAnalyzer": true,
"autoAssignProfessional": false
}
Response PUT /v1/licenses/settings
{
"autoAssignAnalyzer": true,
"autoAssignProfessional": false
}
Gets the license status information of the current tenant
Facts GET /v1/licenses/status
Rate limit required | Tier 1 (1000 requests per minute) |
Header Parameters GET /v1/licenses/status
authorization string<bearer> | Authentication token |
Responses GET /v1/licenses/status
200 application/json | License status info. |
400 application/json | invalid tenant |
401 application/json | Unauthorized (invalid token). |
GET/v1/licenses/status
curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/status" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/licenses/status
{
"type": "Signed",
"trial": false,
"valid": "2018-01-01/2018-12-31",
"origin": "Internal",
"status": "Ok",
"product": "Qlik Sense Business"
}
assignmentsActionsAddRequest
objectProperties
add required | No description |
assignmentsActionsAddResponse
objectProperties
data required | No description |
assignmentsActionsDeleteRequest
objectProperties
delete required | No description |
assignmentsActionsDeleteResponse
objectProperties
data required | No description |
assignmentsActionsUpdateRequest
objectProperties
update required | No description |
assignmentsActionsUpdateResponse
objectProperties
data required | No description |
assignmentsResponse
objectProperties
data required | No description |
links required | No description |
consumptionEventsResponse
objectProperties
data required | No description |
links required | No description |
errorResponse
objectProperties
error deprecated required string | Error type |
errors required | No description |
message deprecated required string | Error message |
href
objectProperties
href string | link |
licenseOverview
objectProperties
trial required boolean | Boolean indicating if it is a trial license. |
valid required string | Period that the license is currently set to be active. Represented as an ISO 8601 time interval with start and end. |
origin required string | Origin of license key. Enum: Internal External |
status required string | Enum with status of license. Only status Ok grants license. access. Enum: Ok Blacklisted Expired |
product required string | The product the license is valid for. |
updated required string | An ISO 8601 timestamp for when the license was last updated. |
allotments required | No description |
changeTime string | An ISO 8601 timestamp for when the license was last changed. |
licenseKey required string | No description |
parameters required | The license parameters. |
licenseType string | No description |
licenseNumber required string | No description |
latestValidTime string | An ISO 8601 timestamp for when the latest time the license has been known to be valid, a missing value indicates the indefinite future. |
secondaryNumber required string | The secondary number of a definition. |
licenseStatus
objectProperties
type required string | Type of license key. Enum: Signed Plain |
trial required boolean | Boolean indicating if it is a trial license. |
valid required string | Period that the license is currently set to be active. Represented as an ISO 8601 time interval with start and end. |
origin required string | Origin of license key. Enum: Internal External |
status required string | Enum with status of license. Only status Ok grants license. access. Enum: Ok Blacklisted Expired Missing |
product required string | The product the license is valid for. |
settingsBody
objectProperties
autoAssignAnalyzer boolean | If analyzer users are available, they will be automatically assigned. Otherwise, analyzer capacity will be assigned, if available. |
autoAssignProfessional boolean | If professional users are available, they will be automatically assigned. Otherwise, analyzer capacity will be assigned, if available. |