Extensions

Visualization extensions is a capability in Qlik Sense which allows third-party visualizations and other presentation objects to be used in the Qlik Sense client.

Download specification

List all extensions

Lists all imported extensions in the tenant.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories extend

Responses

200

OK. Lists all extensions.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Required

      The extension model.

      Show data properties
      • idstring
      • fileobject

        The file that was uploaded with the extension.

      • iconstring

        Icon to show in the client.

      • namestring

        The display name of this extension.

      • tagsarray of strings

        List of tags.

      • typestring

        The type of this extension (visualization, etc.).

      • authorstring

        Author of the extension.

      • bundleobject

        Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.

        Show bundle properties
        • idstring

          Unique identifier of the bundle.

        • namestring

          Name of the bundle.

        • descriptionstring

          Description of the bundle.
      • userIdstring
      • bundledboolean

        If the extension is part of an extension bundle.

      • licensestring

        Under which license this extension is published.

      • previewstring

        Path to an image that enables users to preview the extension.

      • versionstring

        Version of the extension.

      • checksumstring

        Checksum of the extension contents.

      • homepagestring

        Home page of the extension.

      • keywordsstring

        Keywords for the extension.

      • loadpathstring

        Relative path to the extension's entry file, defaults to filename from the qext file.

      • supplierstring

        Supplier of the extension.

      • tenantIdstring
      • updateAtstring

        format = "date"

      • createdAtstring

        format = "date"

      • supernovaboolean

        If the extension is a supernova extension or not.

      • deprecatedstring

        A date noting when the extension was deprecated.

        format = "date"

      • repositorystring

        Link to the extension source code.

      • descriptionstring

        Description of the extension.

      • qextVersionstring

        The version from the qext file that was uploaded with this extension.

      • dependenciesobject

        Map of dependencies describing version of the component it requires.

      • qextFilenamestring

        The name of the qext file that was uploaded with this extension.
GET /api/v1/extensions 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.extensions.getExtensions()
qlik extension ls
curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "string",
      "file": {},
      "icon": "string",
      "name": "string",
      "tags": [
        "string"
      ],
      "type": "string",
      "author": "string",
      "bundle": {
        "id": "string",
        "name": "string",
        "description": "string"
      },
      "userId": "string",
      "bundled": true,
      "license": "string",
      "preview": "string",
      "version": "string",
      "checksum": "string",
      "homepage": "string",
      "keywords": "string",
      "loadpath": "string",
      "supplier": "string",
      "tenantId": "string",
      "updateAt": "string",
      "createdAt": "string",
      "supernova": true,
      "deprecated": "string",
      "repository": "string",
      "description": "string",
      "qextVersion": "string",
      "dependencies": {},
      "qextFilename": "string"
    }
  ]
}

Create a new extension

Creates a new extension. Accepts either provided file or data object. The name of the new extension must be different to any existing extensions.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories extend

Request Body

Required
  • multipart/form-dataobject
    Show multipart/form-data properties
    • dataobject

      The extension model.

      Show data properties
      • fileobject

        The file that was uploaded with the extension.

      • iconstring

        Icon to show in the client.

      • namestring

        The display name of this extension.

      • tagsarray of strings

        List of tags.

      • typestring

        The type of this extension (visualization, etc.).

      • authorstring

        Author of the extension.

      • bundleobject

        Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.

        Show bundle properties
        • idstring

          Unique identifier of the bundle.

        • namestring

          Name of the bundle.

        • descriptionstring

          Description of the bundle.
      • bundledboolean

        If the extension is part of an extension bundle.

      • licensestring

        Under which license this extension is published.

      • previewstring

        Path to an image that enables users to preview the extension.

      • versionstring

        Version of the extension.

      • checksumstring

        Checksum of the extension contents.

      • homepagestring

        Home page of the extension.

      • keywordsstring

        Keywords for the extension.

      • loadpathstring

        Relative path to the extension's entry file, defaults to filename from the qext file.

      • supplierstring

        Supplier of the extension.

      • supernovaboolean

        If the extension is a supernova extension or not.

      • deprecatedstring

        A date noting when the extension was deprecated.

        format = "date"

      • repositorystring

        Link to the extension source code.

      • descriptionstring

        Description of the extension.

      • qextVersionstring

        The version from the qext file that was uploaded with this extension.

      • dependenciesobject

        Map of dependencies describing version of the component it requires.

      • qextFilenamestring

        The name of the qext file that was uploaded with this extension.
    • filestring

      Extension archive.

      format = "binary"

Responses

201

Created. Creates a new extension and returns it.

  • application/jsonobject

    The extension model.

    Show application/json properties
    • idstring
    • fileobject

      The file that was uploaded with the extension.

    • iconstring

      Icon to show in the client.

    • namestring

      The display name of this extension.

    • tagsarray of strings

      List of tags.

    • typestring

      The type of this extension (visualization, etc.).

    • authorstring

      Author of the extension.

    • bundleobject

      Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.

      Show bundle properties
      • idstring

        Unique identifier of the bundle.

      • namestring

        Name of the bundle.

      • descriptionstring

        Description of the bundle.
    • userIdstring
    • bundledboolean

      If the extension is part of an extension bundle.

    • licensestring

      Under which license this extension is published.

    • previewstring

      Path to an image that enables users to preview the extension.

    • versionstring

      Version of the extension.

    • checksumstring

      Checksum of the extension contents.

    • homepagestring

      Home page of the extension.

    • keywordsstring

      Keywords for the extension.

    • loadpathstring

      Relative path to the extension's entry file, defaults to filename from the qext file.

    • supplierstring

      Supplier of the extension.

    • tenantIdstring
    • updateAtstring

      format = "date"

    • createdAtstring

      format = "date"

    • supernovaboolean

      If the extension is a supernova extension or not.

    • deprecatedstring

      A date noting when the extension was deprecated.

      format = "date"

    • repositorystring

      Link to the extension source code.

    • descriptionstring

      Description of the extension.

    • qextVersionstring

      The version from the qext file that was uploaded with this extension.

    • dependenciesobject

      Map of dependencies describing version of the component it requires.

    • qextFilenamestring

      The name of the qext file that was uploaded with this extension.

409

Conflict. Resource with same unique identity already exists.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.

415

Unsupported media type. Body of the payload is not a valid JSON object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.

422

Unprocessable entity. Validation error.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.

default

Unexpected error.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.
POST /api/v1/extensions 
import { createQlikApi } from '@qlik/api'
import { readFileSync } from 'node:fs'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.extensions.uploadExtension({
  data: {
    author: 'string',
    bundle: {
      description: 'string',
      id: 'string',
      name: 'string',
    },
    bundled: true,
    checksum: 'string',
    dependencies: {},
    deprecated: 'string',
    description: 'string',
    file: {},
    homepage: 'string',
    icon: 'string',
    keywords: 'string',
    license: 'string',
    loadpath: 'string',
    name: 'string',
    preview: 'string',
    qextFilename: 'string',
    qextVersion: 'string',
    repository: 'string',
    supernova: true,
    supplier: 'string',
    tags: ['string'],
    type: 'string',
    version: 'string',
  },
  file: new Uint8Array(
    readFileSync('<file-path>'),
  ),
})
qlik extension create \
--file="string"
curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions" \
-X POST \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <access_token>" \
-F "data={\"id\":\"string\",\"file\":{},\"icon\":\"string\",\"name\":\"string\",\"tags\":[\"string\"],\"type\":\"string\",\"author\":\"string\",\"bundle\":{\"id\":\"string\",\"name\":\"string\",\"description\":\"string\"},\"userId\":\"string\",\"bundled\":true,\"license\":\"string\",\"preview\":\"string\",\"version\":\"string\",\"checksum\":\"string\",\"homepage\":\"string\",\"keywords\":\"string\",\"loadpath\":\"string\",\"supplier\":\"string\",\"tenantId\":\"string\",\"updateAt\":\"string\",\"createdAt\":\"string\",\"supernova\":true,\"deprecated\":\"string\",\"repository\":\"string\",\"description\":\"string\",\"qextVersion\":\"string\",\"dependencies\":{},\"qextFilename\":\"string\"}" \
-F "file=@/path/to/file"

Example Response

{
  "id": "string",
  "file": {},
  "icon": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "string",
  "author": "string",
  "bundle": {
    "id": "string",
    "name": "string",
    "description": "string"
  },
  "userId": "string",
  "bundled": true,
  "license": "string",
  "preview": "string",
  "version": "string",
  "checksum": "string",
  "homepage": "string",
  "keywords": "string",
  "loadpath": "string",
  "supplier": "string",
  "tenantId": "string",
  "updateAt": "string",
  "createdAt": "string",
  "supernova": true,
  "deprecated": "string",
  "repository": "string",
  "description": "string",
  "qextVersion": "string",
  "dependencies": {},
  "qextFilename": "string"
}

Get a specific extension

Returns a specific extension matching either extension ID or extension name.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories extend

Path Parameters

  • idstring
    Required

    Extension identifier or its qextFilename.

Responses

200

OK. Returns extension with {id}.

  • application/jsonobject

    The extension model.

    Show application/json properties
    • idstring
    • fileobject

      The file that was uploaded with the extension.

    • iconstring

      Icon to show in the client.

    • namestring

      The display name of this extension.

    • tagsarray of strings

      List of tags.

    • typestring

      The type of this extension (visualization, etc.).

    • authorstring

      Author of the extension.

    • bundleobject

      Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.

      Show bundle properties
      • idstring

        Unique identifier of the bundle.

      • namestring

        Name of the bundle.

      • descriptionstring

        Description of the bundle.
    • userIdstring
    • bundledboolean

      If the extension is part of an extension bundle.

    • licensestring

      Under which license this extension is published.

    • previewstring

      Path to an image that enables users to preview the extension.

    • versionstring

      Version of the extension.

    • checksumstring

      Checksum of the extension contents.

    • homepagestring

      Home page of the extension.

    • keywordsstring

      Keywords for the extension.

    • loadpathstring

      Relative path to the extension's entry file, defaults to filename from the qext file.

    • supplierstring

      Supplier of the extension.

    • tenantIdstring
    • updateAtstring

      format = "date"

    • createdAtstring

      format = "date"

    • supernovaboolean

      If the extension is a supernova extension or not.

    • deprecatedstring

      A date noting when the extension was deprecated.

      format = "date"

    • repositorystring

      Link to the extension source code.

    • descriptionstring

      Description of the extension.

    • qextVersionstring

      The version from the qext file that was uploaded with this extension.

    • dependenciesobject

      Map of dependencies describing version of the component it requires.

    • qextFilenamestring

      The name of the qext file that was uploaded with this extension.

403

Forbidden. User is not authorized to read extension with {id}.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.

404

Not found. Could not find the extension with {id}.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.

410

Gone. Extension with {id} has been deleted.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.
GET /api/v1/extensions/{id} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.extensions.getExtension('string')
qlik extension get <extensionId>
curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions/{id}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "string",
  "file": {},
  "icon": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "string",
  "author": "string",
  "bundle": {
    "id": "string",
    "name": "string",
    "description": "string"
  },
  "userId": "string",
  "bundled": true,
  "license": "string",
  "preview": "string",
  "version": "string",
  "checksum": "string",
  "homepage": "string",
  "keywords": "string",
  "loadpath": "string",
  "supplier": "string",
  "tenantId": "string",
  "updateAt": "string",
  "createdAt": "string",
  "supernova": true,
  "deprecated": "string",
  "repository": "string",
  "description": "string",
  "qextVersion": "string",
  "dependencies": {},
  "qextFilename": "string"
}

Update a specific extension

Updates a specific extension matching either extension ID or extension name. Accepts either provided file or data object.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories extend

Path Parameters

  • idstring
    Required

    Extension identifier or its qextFilename.

Request Body

Required
  • multipart/form-dataobject
    Show multipart/form-data properties
    • dataobject

      The extension model.

      Show data properties
      • fileobject

        The file that was uploaded with the extension.

      • iconstring

        Icon to show in the client.

      • namestring

        The display name of this extension.

      • tagsarray of strings

        List of tags.

      • typestring

        The type of this extension (visualization, etc.).

      • authorstring

        Author of the extension.

      • bundleobject

        Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.

        Show bundle properties
        • idstring

          Unique identifier of the bundle.

        • namestring

          Name of the bundle.

        • descriptionstring

          Description of the bundle.
      • bundledboolean

        If the extension is part of an extension bundle.

      • licensestring

        Under which license this extension is published.

      • previewstring

        Path to an image that enables users to preview the extension.

      • versionstring

        Version of the extension.

      • checksumstring

        Checksum of the extension contents.

      • homepagestring

        Home page of the extension.

      • keywordsstring

        Keywords for the extension.

      • loadpathstring

        Relative path to the extension's entry file, defaults to filename from the qext file.

      • supplierstring

        Supplier of the extension.

      • supernovaboolean

        If the extension is a supernova extension or not.

      • deprecatedstring

        A date noting when the extension was deprecated.

        format = "date"

      • repositorystring

        Link to the extension source code.

      • descriptionstring

        Description of the extension.

      • qextVersionstring

        The version from the qext file that was uploaded with this extension.

      • dependenciesobject

        Map of dependencies describing version of the component it requires.

      • qextFilenamestring

        The name of the qext file that was uploaded with this extension.
    • filestring

      Extension archive.

      format = "binary"

Responses

200

OK. Extension has been updated.

  • application/jsonobject

    The extension model.

    Show application/json properties
    • idstring
    • fileobject

      The file that was uploaded with the extension.

    • iconstring

      Icon to show in the client.

    • namestring

      The display name of this extension.

    • tagsarray of strings

      List of tags.

    • typestring

      The type of this extension (visualization, etc.).

    • authorstring

      Author of the extension.

    • bundleobject

      Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.

      Show bundle properties
      • idstring

        Unique identifier of the bundle.

      • namestring

        Name of the bundle.

      • descriptionstring

        Description of the bundle.
    • userIdstring
    • bundledboolean

      If the extension is part of an extension bundle.

    • licensestring

      Under which license this extension is published.

    • previewstring

      Path to an image that enables users to preview the extension.

    • versionstring

      Version of the extension.

    • checksumstring

      Checksum of the extension contents.

    • homepagestring

      Home page of the extension.

    • keywordsstring

      Keywords for the extension.

    • loadpathstring

      Relative path to the extension's entry file, defaults to filename from the qext file.

    • supplierstring

      Supplier of the extension.

    • tenantIdstring
    • updateAtstring

      format = "date"

    • createdAtstring

      format = "date"

    • supernovaboolean

      If the extension is a supernova extension or not.

    • deprecatedstring

      A date noting when the extension was deprecated.

      format = "date"

    • repositorystring

      Link to the extension source code.

    • descriptionstring

      Description of the extension.

    • qextVersionstring

      The version from the qext file that was uploaded with this extension.

    • dependenciesobject

      Map of dependencies describing version of the component it requires.

    • qextFilenamestring

      The name of the qext file that was uploaded with this extension.

403

Forbidden. User is not authorized to update extension with {id}.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.

404

Not found. Could not find the extension with {id}.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.

409

Conflict. Resource with same unique identity already exists.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.

415

Unsupported media type. Body of the payload is not a valid JSON object.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.

422

Unprocessable entity. Validation error.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.

default

Unexpected error.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.
PATCH /api/v1/extensions/{id} 
import { createQlikApi } from '@qlik/api'
import { readFileSync } from 'node:fs'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.extensions.patchExtension('string', {
  data: {
    author: 'string',
    bundle: {
      description: 'string',
      id: 'string',
      name: 'string',
    },
    bundled: true,
    checksum: 'string',
    dependencies: {},
    deprecated: 'string',
    description: 'string',
    file: {},
    homepage: 'string',
    icon: 'string',
    keywords: 'string',
    license: 'string',
    loadpath: 'string',
    name: 'string',
    preview: 'string',
    qextFilename: 'string',
    qextVersion: 'string',
    repository: 'string',
    supernova: true,
    supplier: 'string',
    tags: ['string'],
    type: 'string',
    version: 'string',
  },
  file: new Uint8Array(
    readFileSync('<file-path>'),
  ),
})
qlik extension patch <extensionId> \
--file="string"
curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions/{id}" \
-X PATCH \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <access_token>" \
-F "data={\"id\":\"string\",\"file\":{},\"icon\":\"string\",\"name\":\"string\",\"tags\":[\"string\"],\"type\":\"string\",\"author\":\"string\",\"bundle\":{\"id\":\"string\",\"name\":\"string\",\"description\":\"string\"},\"userId\":\"string\",\"bundled\":true,\"license\":\"string\",\"preview\":\"string\",\"version\":\"string\",\"checksum\":\"string\",\"homepage\":\"string\",\"keywords\":\"string\",\"loadpath\":\"string\",\"supplier\":\"string\",\"tenantId\":\"string\",\"updateAt\":\"string\",\"createdAt\":\"string\",\"supernova\":true,\"deprecated\":\"string\",\"repository\":\"string\",\"description\":\"string\",\"qextVersion\":\"string\",\"dependencies\":{},\"qextFilename\":\"string\"}" \
-F "file=@/path/to/file"

Example Response

{
  "id": "string",
  "file": {},
  "icon": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "string",
  "author": "string",
  "bundle": {
    "id": "string",
    "name": "string",
    "description": "string"
  },
  "userId": "string",
  "bundled": true,
  "license": "string",
  "preview": "string",
  "version": "string",
  "checksum": "string",
  "homepage": "string",
  "keywords": "string",
  "loadpath": "string",
  "supplier": "string",
  "tenantId": "string",
  "updateAt": "string",
  "createdAt": "string",
  "supernova": true,
  "deprecated": "string",
  "repository": "string",
  "description": "string",
  "qextVersion": "string",
  "dependencies": {},
  "qextFilename": "string"
}

Delete a specific extension

Deletes a specific extension matching either extension ID or extension name.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories extend

Path Parameters

  • idstring
    Required

    Extension identifier or its qextFilename.

Responses

204

No content. Soft deletes the extension.

403

Forbidden. User is not authorized to delete extension with {id}.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.

404

Not found. Could not find the extension with {id}.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.

410

Gone. Extension with {id} has been deleted.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.
DELETE /api/v1/extensions/{id} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.extensions.deleteExtension('string')
qlik extension rm <extensionId>
curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions/{id}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Download extension as an archive

Downloads all files in the extension matching either extension ID or extension name as a .zip archive.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories extend

Path Parameters

  • idstring
    Required

    Extension identifier or its qextFilename.

Responses

200

OK. Extension exists. Returns the extension archive.

403

Forbidden. User is not authorized to read extension with {id}.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.

404

Not found. Could not find the extension with {id}.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.

410

Gone. Extension with {id} has been deleted.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.
GET /api/v1/extensions/{id}/file 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.extensions.downloadExtension('string')
qlik extension file ls
curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions/{id}/file" \
-H "Authorization: Bearer <access_token>"

Download file from extension archive.

Downloads a specific file from the extension matching either extension ID or extension name, identified by the file path within the imported extension.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories extend

Path Parameters

  • filepathstring
    Required

    Path to the file location within the specified extension archive. Folders separated with forward slashes.

  • idstring
    Required

    Extension identifier or its qextFilename.

Responses

200

OK. Extension exists and the file specified exists. Returns the specific file.

403

Forbidden. User is not authorized to read extension with {id}.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.

404

Not found. Could not find the extension with {id} or the file does not exist in the archive.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.

410

Gone. Extension with {id} has been deleted.

  • application/jsonobject

    An error object.

    Show application/json properties
    • metaobject

      Object containing meta data regarding an error. It does not necessarily contain all the properties.

      Show meta properties
      • stackstring

        Full stack trace of the error that was raised.

      • messagestring

        A more detailed message explaining the error.

      • resourceNamestring

        Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created.
    • titlestring
      Required

      Title of the HTTP status code.

    • sourceobject

      Optional JSON patch object pointing to an invalid property.

    • statusnumber

      The HTTP status code.
GET /api/v1/extensions/{id}/file/{filepath} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.extensions.downloadFileFromExtension(
  'string',
  'css/styles.css',
)
qlik extension file get <filepath>
curl "https://your-tenant.us.qlikcloud.com/api/v1/extensions/{id}/file/{filepath}" \
-H "Authorization: Bearer <access_token>"