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 section
GET/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

embed

Retrieves web integrations matching the query.

Query Parameters GET /v1/web-integrations

endingBefore
optional
string

The target web integration ID to start looking before for web integrations. Cannot be used in conjunction with startingAfter.

limit
optional, default=10, maximum=100
number

The number of web integration entries to retrieve.

sort
optional, default='+name'
string

The field to sort by. Prefix with +/- to indicate ascending/descending order.

Enum:

name

+name

-name

startingAfter
optional
string

The target web integration ID to start looking after for web integrations. Cannot be used in conjunction with endingBefore.

tenantId
optional
string

The tenantId to filter by.

Responses GET /v1/web-integrations

200
optional, application/json

An array of web integration objects

default
optional, 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": "2022-09-23T14:08:54.419Z",
      "tenantId": "string",
      "createdBy": "string",
      "lastUpdated": "2022-09-23T14:08:54.419Z",
      "validOrigins": []
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Create web integration

embed

Creates a web integration.

Request Body POST /v1/web-integrations

application/json

No description

Responses POST /v1/web-integrations

201
optional, application/json

Web integration created successfully.

400
optional, application/json

Invalid request was made.

403
optional, 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": "2022-09-23T14:08:54.419Z",
  "tenantId": "string",
  "createdBy": "string",
  "lastUpdated": "2022-09-23T14:08:54.419Z",
  "validOrigins": [
    "https://thirdPartyApp.com"
  ]
}

Get web integration by ID

embed

Retrieves a single web integration by ID.

Path Parameters GET /v1/web-integrations/{id}

id
string<uid>

The ID of the web integration to retrieve

Responses GET /v1/web-integrations/{id}

200
optional, application/json

Web integration found.

404
optional, 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": "2022-09-23T14:08:54.419Z",
  "tenantId": "string",
  "createdBy": "string",
  "lastUpdated": "2022-09-23T14:08:54.419Z",
  "validOrigins": []
}

Update web integration by ID

embed

Updates a single web integration by ID.

Path Parameters PATCH /v1/web-integrations/{id}

id
string<uid>

The ID of the web integration to update.

Request Body PATCH /v1/web-integrations/{id}

optional, application/json

No description

Responses PATCH /v1/web-integrations/{id}

204
optional
object

Web integration updated successfully.

400
optional, application/json

Invalid request was made.

404
optional, 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

embed

Deletes a single web integration by ID.

Path Parameters DELETE /v1/web-integrations/{id}

id
string<uid>

The ID of the web integration to delete.

Responses DELETE /v1/web-integrations/{id}

204
optional
object

Web integration deleted successfully.

404
optional, 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

object

An error object describing the error.

Properties

code
string

The error code.

meta
optional
object

Additional properties relating to the error.

title
string

Summary of the problem.

detail
optional
string

A human-readable explanation specific to this occurrence of the error.

source
optional

References to the source of the error.

status
string

The HTTP status code.

Errors

object

The error response object describing the error from the handling of an HTTP request.

Properties

errors
optional

An array of errors related to the operation.

traceId
optional
string

A unique identifier for tracing the error.

WebIntegration

A web integration object.

Properties

id
optional
string<uid>

The unique web integration identifier.

name
optional
string

The name of the web integration.

created
optional
string<date-time>

The time the web integration was created at.

tenantId
optional
string<uid>

The tenant that the web integration belongs too.

createdBy
optional
string<uid>

The user that created the web integration.

lastUpdated
optional
string<date-time>

The time the web integration was last updated at.

validOrigins
optional
Array<string<uri>>

The origins who are allowed to make requests to the tenant.

WebIntegrationPatch

A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.

Properties

op
string

The operation to be performed.

Enum:

replace

path
string

A JSON Pointer.

Enum:

/name

/validOrigins

value
string

New value to be used for this operation.

WebIntegrationPatchSchema

Array<WebIntegrationPatch>

Properties

op
string

The operation to be performed.

Enum:

replace

path
string

A JSON Pointer.

Enum:

/name

/validOrigins

value
string

New value to be used for this operation.

WebIntegrationPost

The creation of a web integration response.

Properties

id
optional
string<uid>

The unique web integration identifier.

name
optional
string

The name of the newly created web integration.

links
optional

Pagination links

created
optional
string<date-time>

The time the web integration was created at.

tenantId
optional
string<uid>

The tenant that the web integration belongs too.

createdBy
optional
string<uid>

The user that created the web integration.

lastUpdated
optional
string<date-time>

The time the web integration was last updated at.

validOrigins
optional
Array<string<uri>>

The origins who are allowed to make requests to the tenant.

WebIntegrationPostSchema

Properties

name
string

The name of the web integration to create.

validOrigins
optional
Array<string<uri>>

The origins who are allowed to make requests to the tenant.

WebIntegrations

An array of web integration objects.

Properties

data
optional

No description

links
optional

Pagination links

v0.448.13
Was this page helpful?