Brands

Brands allow you to apply tenant level branding across most user interfaces.

Download OpenAPI spec

Endpoints

GET

/api/v1/brands
POST

/api/v1/brands
GET

/api/v1/brands/{brand-id}
PATCH

/api/v1/brands/{brand-id}
DELETE

/api/v1/brands/{brand-id}
POST

/api/v1/brands/{brand-id}/actions/activate
POST

/api/v1/brands/{brand-id}/actions/deactivate
GET

/api/v1/brands/{brand-id}/files/{brand-file-id}
POST

/api/v1/brands/{brand-id}/files/{brand-file-id}
PUT

/api/v1/brands/{brand-id}/files/{brand-file-id}
DELETE

/api/v1/brands/{brand-id}/files/{brand-file-id}
GET

/api/v1/brands/active

Lists all brand entries for a tenant.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

endingBefore string

Cursor to previous.
limit integer

Maximum number of brands to retrieve.

minimum = 1, maximum = 100, default = 5, default = 5
sort string

Field to sort by, prefixed with -/+ to indicate the order.

Can be one of: "id""+id""-id""createdAt""+createdAt""-createdAt""updatedAt""+updatedAt""-updatedAt"
default = "-id"
startingAfter string

Cursor to the next page.

Responses

200

OK Response

application/json object

A collection of brands.
Show application/json properties
- data array of objects
  
  A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.
  
  Show data properties
  
  id string
  
  Required
  
  name string
  
  Required
  
  files array of objects
  
  Required
  
  Collection of resources that make up the brand.
  
  Show files properties
  
  id string
  
  Can be one of: "logo""favIcon""styles"
  
  eTag string
  
  path string
  
  contentType string
  
  active boolean
  
  createdAt string
  
  The UTC timestamp when the brand was created.
  
  format = "date-time"
  
  createdBy string
  
  ID of a user that created the brand.
  
  updatedAt string
  
  The UTC timestamp when the brand was last updated.
  
  format = "date-time"
  
  updatedBy string
  
  ID of a user that last updated the brand.
  
  description string
  
  Required
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  Required
  
  URL of a resource request.
  
  prev object
  
  Show prev properties
  
  href string
  
  Required
  
  URL of a resource request.
  
  self object
  
  Show self properties
  
  href string
  
  Required
  
  URL of a resource request.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/brands

import { createQlikApi } from '@qlik/api'

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

await qlik.brands.getBrands({})

qlik brand ls

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/brands" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "files": [
        {
          "id": "logo",
          "eTag": "string",
          "path": "string",
          "contentType": "string"
        }
      ],
      "active": true,
      "createdAt": "2024-01-01T00:00:00.000Z",
      "createdBy": "string",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "updatedBy": "string",
      "description": "string"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Creates a new brand.

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

multipart/form-data object
Show multipart/form-data properties
- logo string
  
  The path and name of a JPG or PNG file that will be adjusted to fit in a 'box' measuring 109px in width and 62 px in height while maintaining aspect ratio. Maximum size of 300 KB, but smaller is recommended.
  
  format = "binary"
- name string
  
  Required
  
  Name of the brand.
- styles string
  
  The path and name of a JSON file to define brand style settings. Maximum size is 100 KB. This property is not currently operational.
  
  format = "binary"
- favIcon string
  
  The path and name of a properly formatted ICO file. Maximum size is 100 KB.
  
  format = "binary"
- description string
  
  Description of the brand.

Responses

201

Created Response

application/json object

A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.
Show application/json properties
- id string
  
  Required
- name string
  
  Required
- files array of objects
  
  Required
  
  Collection of resources that make up the brand.
  
  Show files properties
  
  id string
  
  Can be one of: "logo""favIcon""styles"
  
  eTag string
  
  path string
  
  contentType string
- active boolean
- createdAt string
  
  The UTC timestamp when the brand was created.
  
  format = "date-time"
- createdBy string
  
  ID of a user that created the brand.
- updatedAt string
  
  The UTC timestamp when the brand was last updated.
  
  format = "date-time"
- updatedBy string
  
  ID of a user that last updated the brand.
- description string
  
  Required

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

424

Failed Dependency. Brand file storage is not available, so the brand file operation cannot be completed.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

POST /api/v1/brands

import { createQlikApi } from '@qlik/api'
import { readFileSync } from 'node:fs'

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

await qlik.brands.createBrand({
  description: 'string',
  favIcon: new Uint8Array(
    readFileSync('<file-path>'),
  ),
  logo: new Uint8Array(
    readFileSync('<file-path>'),
  ),
  name: 'string',
  styles: new Uint8Array(
    readFileSync('<file-path>'),
  ),
})

qlik brand create \
  --name 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/brands" \
-X POST \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <access_token>" \
-F "logo=@/path/to/file" \
-F "name=\"string\"" \
-F "styles=@/path/to/file" \
-F "favIcon=@/path/to/file" \
-F "description=\"string\""

Example Response

{
  "id": "string",
  "name": "string",
  "files": [
    {
      "id": "logo",
      "eTag": "string",
      "path": "string",
      "contentType": "string"
    }
  ],
  "active": true,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "createdBy": "string",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "updatedBy": "string",
  "description": "string"
}

Returns a specific brand.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

brand-id string

Required

The brand's unique identifier.

Responses

200

OK Response

application/json object

A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.
Show application/json properties
- id string
  
  Required
- name string
  
  Required
- files array of objects
  
  Required
  
  Collection of resources that make up the brand.
  
  Show files properties
  
  id string
  
  Can be one of: "logo""favIcon""styles"
  
  eTag string
  
  path string
  
  contentType string
- active boolean
- createdAt string
  
  The UTC timestamp when the brand was created.
  
  format = "date-time"
- createdBy string
  
  ID of a user that created the brand.
- updatedAt string
  
  The UTC timestamp when the brand was last updated.
  
  format = "date-time"
- updatedBy string
  
  ID of a user that last updated the brand.
- description string
  
  Required

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/brands/{brand-id}

import { createQlikApi } from '@qlik/api'

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

await qlik.brands.getBrand('string')

qlik brand get 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/brands/{brand-id}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "string",
  "name": "string",
  "files": [
    {
      "id": "logo",
      "eTag": "string",
      "path": "string",
      "contentType": "string"
    }
  ],
  "active": true,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "createdBy": "string",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "updatedBy": "string",
  "description": "string"
}

Patches a brand.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

brand-id string

Required

The brand's unique identifier.

Request Body

Required

application/json array of objects

A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
Show application/json properties
- op string
  
  Required
  
  The operation to be performed.
  
  Can be one of: "add""remove""replace"
- path string
  
  Required
  
  The path for the given resource field to patch.
  
  Can be one of: "/name""/description"
- value string
  
  The value to be used for this operation.

Responses

204

No Content Response.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

PATCH /api/v1/brands/{brand-id}

import { createQlikApi } from '@qlik/api'

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

await qlik.brands.patchBrand('string', [
  {
    op: 'add',
    path: '/description',
    value: 'string',
  },
])

qlik brand patch 'string' \
  --op 'add' \
  --path '/description'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/brands/{brand-id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"add","path":"/description","value":"string"}]'

Deletes a specific brand. If the active brand is deleted, the tenant will return to the Qlik default.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

brand-id string

Required

The brand's unique identifier.

Responses

204

No Content Response.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

424

Failed Dependency. Brand file storage is not available, so the brand file operation cannot be completed.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

DELETE /api/v1/brands/{brand-id}

import { createQlikApi } from '@qlik/api'

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

await qlik.brands.deleteBrand('string')

qlik brand rm 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/brands/{brand-id}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Sets the brand active and de-activates any other active brand. If the brand is already active, no action is taken.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

brand-id string

Required

The brand's unique identifier.

Request Body

Responses

200

Responds with the brand that was activated.

application/json object

A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.
Show application/json properties
- id string
  
  Required
- name string
  
  Required
- files array of objects
  
  Required
  
  Collection of resources that make up the brand.
  
  Show files properties
  
  id string
  
  Can be one of: "logo""favIcon""styles"
  
  eTag string
  
  path string
  
  contentType string
- active boolean
- createdAt string
  
  The UTC timestamp when the brand was created.
  
  format = "date-time"
- createdBy string
  
  ID of a user that created the brand.
- updatedAt string
  
  The UTC timestamp when the brand was last updated.
  
  format = "date-time"
- updatedBy string
  
  ID of a user that last updated the brand.
- description string
  
  Required

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

POST /api/v1/brands/{brand-id}/actions/activate

import { createQlikApi } from '@qlik/api'

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

await qlik.brands.activateBrand('string', {})

qlik brand activate 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/brands/{brand-id}/actions/activate" \
-X POST \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "string",
  "name": "string",
  "files": [
    {
      "id": "logo",
      "eTag": "string",
      "path": "string",
      "contentType": "string"
    }
  ],
  "active": true,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "createdBy": "string",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "updatedBy": "string",
  "description": "string"
}

Sets the brand so it is no longer active, returning the tenant the Qlik default brand. If the brand is already inactive, no action is taken.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

brand-id string

Required

The brand's unique identifier.

Request Body

Responses

200

Responds with the brand that was deactivated.

application/json object

A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.
Show application/json properties
- id string
  
  Required
- name string
  
  Required
- files array of objects
  
  Required
  
  Collection of resources that make up the brand.
  
  Show files properties
  
  id string
  
  Can be one of: "logo""favIcon""styles"
  
  eTag string
  
  path string
  
  contentType string
- active boolean
- createdAt string
  
  The UTC timestamp when the brand was created.
  
  format = "date-time"
- createdBy string
  
  ID of a user that created the brand.
- updatedAt string
  
  The UTC timestamp when the brand was last updated.
  
  format = "date-time"
- updatedBy string
  
  ID of a user that last updated the brand.
- description string
  
  Required

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

POST /api/v1/brands/{brand-id}/actions/deactivate

import { createQlikApi } from '@qlik/api'

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

await qlik.brands.deactivateBrand('string', {})

qlik brand deactivate 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/brands/{brand-id}/actions/deactivate" \
-X POST \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "string",
  "name": "string",
  "files": [
    {
      "id": "logo",
      "eTag": "string",
      "path": "string",
      "contentType": "string"
    }
  ],
  "active": true,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "createdBy": "string",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "updatedBy": "string",
  "description": "string"
}

Downloads the specified brand file.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Header Parameters

Accept string

Media type accepted for the downloaded brand file.

default = "*/*"

Path Parameters

brand-id string

Required

The brand's unique identifier.
brand-file-id string

Required

The unique identifier of a file within a brand.

Can be one of: "logo""favIcon""styles"

Responses

200

OK Response

*/* string

format = "binary"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

424

Failed Dependency. Brand file storage is not available, so the brand file operation cannot be completed.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

GET /api/v1/brands/{brand-id}/files/{brand-file-id}

import { createQlikApi } from '@qlik/api'

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

await qlik.brands.getBrandFile('string', 'logo')

qlik brand file get 'logo' \
  --brandId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/brands/{brand-id}/files/{brand-file-id}" \
-H "Authorization: Bearer <access_token>"

Example Response

"string"

Creates a brand file for the specified identifier.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

brand-id string

Required

The brand's unique identifier.
brand-file-id string

Required

The unique identifier of a file within a brand.

Can be one of: "logo""favIcon""styles"

Request Body

Required

multipart/form-data object
Show multipart/form-data properties
- file string
  
  The path and name of a file to upload.
  
  format = "binary"

Responses

201

Created Response

application/json object

Represents one of the assets used as part of the brand. These include logos, favicons, and some styles.
Show application/json properties
- id string
  
  Can be one of: "logo""favIcon""styles"
- eTag string
- path string
- contentType string

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

424

Failed Dependency. Brand file storage is not available, so the brand file operation cannot be completed.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

POST /api/v1/brands/{brand-id}/files/{brand-file-id}

import { createQlikApi } from '@qlik/api'
import { readFileSync } from 'node:fs'

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

await qlik.brands.createBrandFile(
  'string',
  'logo',
  {
    file: new Uint8Array(
      readFileSync('<file-path>'),
    ),
  },
)

qlik brand file create 'logo' \
  --brandId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/brands/{brand-id}/files/{brand-file-id}" \
-X POST \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <access_token>" \
-F "file=@/path/to/file"

Example Response

{
  "id": "logo",
  "eTag": "string",
  "path": "string",
  "contentType": "string"
}

Updates the specified brand file.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

brand-id string

Required

The brand's unique identifier.
brand-file-id string

Required

The unique identifier of a file within a brand.

Can be one of: "logo""favIcon""styles"

Request Body

Required

multipart/form-data object
Show multipart/form-data properties
- file string
  
  A file to upload.
  
  format = "binary"

Responses

200

OK Response - file updated

application/json object

Represents one of the assets used as part of the brand. These include logos, favicons, and some styles.
Show application/json properties
- id string
  
  Can be one of: "logo""favIcon""styles"
- eTag string
- path string
- contentType string

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

424

Failed Dependency. Brand file storage is not available, so the brand file operation cannot be completed.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

PUT /api/v1/brands/{brand-id}/files/{brand-file-id}

import { createQlikApi } from '@qlik/api'
import { readFileSync } from 'node:fs'

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

await qlik.brands.updateBrandFile(
  'string',
  'logo',
  {
    file: new Uint8Array(
      readFileSync('<file-path>'),
    ),
  },
)

qlik brand file update 'logo' \
  --brandId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/brands/{brand-id}/files/{brand-file-id}" \
-X PUT \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <access_token>" \
-F "file=@/path/to/file"

Example Response

{
  "id": "logo",
  "eTag": "string",
  "path": "string",
  "contentType": "string"
}

Deletes the specified brand file.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

brand-id string

Required

The brand's unique identifier.
brand-file-id string

Required

The unique identifier of a file within a brand.

Can be one of: "logo""favIcon""styles"

Responses

204

No content response.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

424

Failed Dependency. Brand file storage is not available, so the brand file operation cannot be completed.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  title string
  
  detail string
- traceId string

DELETE /api/v1/brands/{brand-id}/files/{brand-file-id}

import { createQlikApi } from '@qlik/api'

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

await qlik.brands.deleteBrandFile(
  'string',
  'logo',
)

qlik brand file rm 'logo' \
  --brandId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/brands/{brand-id}/files/{brand-file-id}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Returns the current active brand. If using the Qlik default brand, no value is returned.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Responses

200

No active brand, returns an empty response.

application/json object

Empty object inferring lack of active branding.

301

Successful redirect.

GET /api/v1/brands/active

import { createQlikApi } from '@qlik/api'

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

await qlik.brands.getActiveBrand()

qlik brand active

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/brands/active" \
-H "Authorization: Bearer <access_token>"

Example Response

{}

Brands

Endpoints

List brands

Facts

Query Parameters

Responses

200

400

401

403

500

Example Response

Create a new brand

Facts

Request Body

Responses

201

400

401

403

424

500

Example Response

Retrieve a brand

Facts

Path Parameters

Responses

200

400

401

403

404

500

Example Response

Update a brand

Facts

Path Parameters

Request Body

Responses

204

400

401

403

404

500

Delete a brand

Facts

Path Parameters

Responses

204

400

401

403

404

424

500

Activate a brand

Facts

Path Parameters

Request Body

Responses

200

400

401

403

404

500

Example Response

Deactivate a brand

Facts

Path Parameters

Request Body

Responses

200

400

401

403

404

500

Example Response