Web integrations
A web integration is a resource representing a list of whitelisted origins that can make requests to a specified tenant. It is the implementation of the CORS mechanism within Qlik Sense SaaS.
Endpoints
Skip to sectionGET | /v1/web-integrations |
POST | /v1/web-integrations |
GET | /v1/web-integrations/{id} |
PATCH | /v1/web-integrations/{id} |
DELETE | /v1/web-integrations/{id} |
List web integrations
Retrieves web integrations matching the query.
Facts GET /v1/web-integrations
Rate limit required | Tier 1 (1000 requests per minute) |
Query Parameters GET /v1/web-integrations
endingBefore string | The target web integration ID to start looking before for web integrations. Cannot be used in conjunction with startingAfter. |
limit default=10, maximum=100 number | The number of web integration entries to retrieve. |
sort default='+name' string | The field to sort by. Prefix with +/- to indicate ascending/descending order. Enum: name +name -name |
startingAfter string | The target web integration ID to start looking after for web integrations. Cannot be used in conjunction with endingBefore. |
tenantId string | The tenant ID to filter by. |
Responses GET /v1/web-integrations
200 application/json | An array of web integration objects. |
default application/json | Unexpected error. |
GET/v1/web-integrations
curl "https://your-tenant.us.qlikcloud.com/api/v1/web-integrations" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/web-integrations
{
"data": [
{
"id": "string",
"name": "string",
"created": "2023-09-19T16:49:04.831Z",
"tenantId": "string",
"createdBy": "string",
"lastUpdated": "2023-09-19T16:49:04.831Z",
"validOrigins": []
}
],
"links": {
"next": {
"href": "string"
},
"prev": {
"href": "string"
},
"self": {
"href": "string"
}
}
}
Create web integration
Creates a web integration.
Facts POST /v1/web-integrations
Rate limit required | Tier 2 (100 requests per minute) |
Request Body POST /v1/web-integrations
application/json | Properties that the user wants to set for the web integration. |
Responses POST /v1/web-integrations
201 application/json | Web integration created successfully. |
400 application/json | Invalid request was made. |
403 application/json | Requestor not allowed to create a web integration. |
POST/v1/web-integrations
curl "https://your-tenant.us.qlikcloud.com/api/v1/web-integrations" \
-X POST \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"name":"My Web Integration","validOrigins":["https://thirdPartyApp.com"]}'
Request POST /v1/web-integrations
{
"name": "My Web Integration",
"validOrigins": [
"https://thirdPartyApp.com"
]
}
Response POST /v1/web-integrations
{
"id": "string",
"name": "My Web Integration",
"links": {
"self": {
"href": "http://mytenant.region.domain/api/v1/web-integrations/id"
}
},
"created": "2023-09-19T16:49:04.831Z",
"tenantId": "string",
"createdBy": "string",
"lastUpdated": "2023-09-19T16:49:04.831Z",
"validOrigins": [
"https://thirdPartyApp.com"
]
}
Get web integration by ID
Retrieves a single web integration by ID.
Facts GET /v1/web-integrations/{id}
Rate limit required | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/web-integrations/{id}
id required string<uid> | The ID of the web integration to retrieve. |
Responses GET /v1/web-integrations/{id}
200 application/json | Web integration found. |
404 application/json | Web integration not found. |
GET/v1/web-integrations/{id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/web-integrations/{id}" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/web-integrations/{id}
{
"id": "string",
"name": "string",
"created": "2023-09-19T16:49:04.832Z",
"tenantId": "string",
"createdBy": "string",
"lastUpdated": "2023-09-19T16:49:04.832Z",
"validOrigins": []
}
Update web integration by ID
Updates a single web integration by ID.
Facts PATCH /v1/web-integrations/{id}
Rate limit required | Tier 2 (100 requests per minute) |
Path Parameters PATCH /v1/web-integrations/{id}
id required string<uid> | The ID of the web integration to update. |
Request Body PATCH /v1/web-integrations/{id}
application/json | Properties that the user wants to update for the web integration. |
Responses PATCH /v1/web-integrations/{id}
204 object | Web integration updated successfully. |
400 application/json | Invalid request was made. |
404 application/json | Web integration not found. |
PATCH/v1/web-integrations/{id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/web-integrations/{id}" \
-X PATCH \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '[{"op":"replace","path":"/name","value":"New name"}]'
Request PATCH /v1/web-integrations/{id}
[
{
"op": "replace",
"path": "/name",
"value": "New name"
}
]
Delete web integration by ID
Deletes a single web integration by ID.
Facts DELETE /v1/web-integrations/{id}
Rate limit required | Tier 2 (100 requests per minute) |
Path Parameters DELETE /v1/web-integrations/{id}
id required string<uid> | The ID of the web integration to delete. |
Responses DELETE /v1/web-integrations/{id}
204 object | Web integration deleted successfully. |
404 application/json | Web integration not found. |
DELETE/v1/web-integrations/{id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/web-integrations/{id}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
Error
objectAn error object describing the error.
Properties
code required string | The error code. |
meta object | Additional properties relating to the error. |
title required string | Summary of the problem. |
detail string | A human-readable explanation specific to this occurrence of the error. |
source | References to the source of the error. |
status required string | The HTTP status code. |
Errors
objectThe error response object describing the error from the handling of an HTTP request.
Properties
errors | An array of errors related to the operation. |
traceId string | A unique identifier for tracing the error. |
WebIntegration
objectA web integration object.
Properties
id string<uid> | The unique web integration identifier. |
name string | The name of the web integration. |
created string<date-time> | The time the web integration was created. |
tenantId string<uid> | The tenant that the web integration belongs to. |
createdBy string<uid> | The user that created the web integration. |
lastUpdated string<date-time> | The time the web integration was last updated. |
validOrigins Array<string<uri>> | The origins that are allowed to make requests to the tenant. |
WebIntegrationPatch
objectA JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
Properties
op required string | The operation to be performed. Enum: replace |
path required string | A JSON Pointer. Enum: /name /validOrigins |
value required string | New value to be used for this operation. |
WebIntegrationPatchSchema
Array<WebIntegrationPatch>Properties
op required string | The operation to be performed. Enum: replace |
path required string | A JSON Pointer. Enum: /name /validOrigins |
value required string | New value to be used for this operation. |
WebIntegrationPost
objectThe creation of a web integration response.
Properties
id string<uid> | The unique web integration identifier. |
name string | The name of the newly created web integration. |
links | Pagination links |
created string<date-time> | The time the web integration was created. |
tenantId string<uid> | The tenant that the web integration belongs to. |
createdBy string<uid> | The user that created the web integration. |
lastUpdated string<date-time> | The time the web integration was last updated. |
validOrigins Array<string<uri>> | The origins that are allowed to make requests to the tenant. |
WebIntegrationPostSchema
Properties
name required string | The name of the web integration to create. |
validOrigins Array<string<uri>> | The origins that are allowed to make requests to the tenant. |
WebIntegrations
An array of web integration objects.
Properties
data | Properties of web integrations in a given tenant. |
links | Pagination links |