Brands

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

Download specification

List brands

Lists all brand entries for a tenant.

Facts

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

Query Parameters

  • endingBeforestring

    Cursor to previous.

  • limitinteger

    Maximum number of brands to retrieve.

  • sortstring

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

    Can be one of: "id""+id""-id""createdAt""+createdAt""-createdAt""updatedAt""+updatedAt""-updatedAt"

  • startingAfterstring

    Cursor to the next page.

Responses

200

application/json

OK Response

A collection of brands.

  • application/jsonobject

    A collection of brands.

    Show application/json properties
    • dataarray 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
      • idstring
        Required
      • namestring
        Required
      • filesarray of objects
        Required

        Collection of resources that make up the brand.

        Show files properties
        • idstring

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

        • eTagstring
        • pathstring
        • contentTypestring
      • activeboolean
      • createdAtstring

        The UTC timestamp when the brand was created.

      • createdBystring

        ID of a user that created the brand.

      • updatedAtstring

        The UTC timestamp when the brand was last updated.

      • updatedBystring

        ID of a user that last updated the brand.

      • descriptionstring
        Required
    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring
          Required

          URL of a resource request.

      • prevobject
        Show prev properties
        • hrefstring
          Required

          URL of a resource request.

      • selfobject
        Show self properties
        • hrefstring
          Required

          URL of a resource request.

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

500

application/json

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
GET /v1/brands
curl "https://your-tenant.us.qlikcloud.com/api/v1/brands" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/brands',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

Response

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "files": [
        {
          "id": "logo",
          "eTag": "string",
          "path": "string",
          "contentType": "string"
        }
      ],
      "active": true,
      "createdAt": "2018-10-30T07:06:22Z",
      "createdBy": "string",
      "updatedAt": "2018-10-30T07:06:22Z",
      "updatedBy": "string",
      "description": "string"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Create a new brand

Creates a new brand.

Facts

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

Request Body

multipart/form-data

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

      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.

    • namestring
      Required

      Name of the brand.

    • stylesstring

      The path and name of a JSON file to define brand style settings. Maximum size is 100 KB. This property is not currently operational.

    • favIconstring

      The path and name of a properly formatted ICO file. Maximum size is 100 KB.

    • descriptionstring

      Description of the brand.

Responses

201

application/json

Created Response

A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.

  • application/jsonobject

    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
    • idstring
      Required
    • namestring
      Required
    • filesarray of objects
      Required
    • activeboolean
    • createdAtstring

      The UTC timestamp when the brand was created.

    • createdBystring

      ID of a user that created the brand.

    • updatedAtstring

      The UTC timestamp when the brand was last updated.

    • updatedBystring

      ID of a user that last updated the brand.

    • descriptionstring
      Required

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

500

application/json

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
POST /v1/brands
curl "https://your-tenant.us.qlikcloud.com/api/v1/brands" \
-X POST \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <API-key>" \
-F "logo=@/path/to/file" \
-F "name=\"string\"" \
-F "styles=@/path/to/file" \
-F "favIcon=@/path/to/file" \
-F "description=\"string\""
const https = require('https')
  const data = JSON.stringify({"logo":"string","name":"string","styles":"string","favIcon":"string","description":"string"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/brands',
    'method': 'POST',
    'headers': {
      'Content-type': 'multipart/form-data',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(formData)
  
This API is not included yet in qlik-cli

Request

{
  "logo": "string",
  "name": "string",
  "styles": "string",
  "favIcon": "string",
  "description": "string"
}

Response

{
  "id": "string",
  "name": "string",
  "files": [
    {}
  ],
  "active": true,
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "string",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "string",
  "description": "string"
}

Retrieve a brand

Returns a specific brand.

Facts

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

Path Parameters

  • brand-idstring
    Required

    The brand's unique identifier.

Responses

200

application/json

OK Response

A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.

  • application/jsonobject

    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
    • idstring
      Required
    • namestring
      Required
    • filesarray of objects
      Required
    • activeboolean
    • createdAtstring

      The UTC timestamp when the brand was created.

    • createdBystring

      ID of a user that created the brand.

    • updatedAtstring

      The UTC timestamp when the brand was last updated.

    • updatedBystring

      ID of a user that last updated the brand.

    • descriptionstring
      Required

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

500

application/json

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
GET /v1/brands/{brand-id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/brands/{brand-id}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/brands/{brand-id}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

Response

{
  "id": "string",
  "name": "string",
  "files": [
    {}
  ],
  "active": true,
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "string",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "string",
  "description": "string"
}

Update a brand

Patches a brand.

Facts

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

Path Parameters

  • brand-idstring
    Required

    The brand's unique identifier.

Request Body

Required

application/json

A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.

  • application/jsonarray of objects

    A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.

    Show application/json properties
    • opstring
      Required

      The operation to be performed.

      Can be one of: "add""remove""replace"

    • pathstring
      Required

      The path for the given resource field to patch.

      Can be one of: "/name""/description"

    • valuestring

      The value to be used for this operation.

Responses

204

No Content Response.

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

500

application/json

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
PATCH /v1/brands/{brand-id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/brands/{brand-id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '[{"op":"add","path":"/description","value":"string"}]'
const https = require('https')
  const data = JSON.stringify([{"op":"add","path":"/description","value":"string"}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/brands/{brand-id}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)
  
This API is not included yet in qlik-cli

Request

[
  {
    "op": "add",
    "path": "/description",
    "value": "string"
  }
]

Delete a brand

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)
Categories manage

Path Parameters

  • brand-idstring
    Required

    The brand's unique identifier.

Responses

204

No Content Response.

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

500

application/json

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
DELETE /v1/brands/{brand-id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/brands/{brand-id}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/brands/{brand-id}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

Activate a brand

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)
Categories manage

Path Parameters

  • brand-idstring
    Required

    The brand's unique identifier.

Request Body

Responses

200

application/json

Responds with the brand that was activated.

A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.

  • application/jsonobject

    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
    • idstring
      Required
    • namestring
      Required
    • filesarray of objects
      Required
    • activeboolean
    • createdAtstring

      The UTC timestamp when the brand was created.

    • createdBystring

      ID of a user that created the brand.

    • updatedAtstring

      The UTC timestamp when the brand was last updated.

    • updatedBystring

      ID of a user that last updated the brand.

    • descriptionstring
      Required

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

500

application/json

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
POST /v1/brands/{brand-id}/actions/activate
curl "https://your-tenant.us.qlikcloud.com/api/v1/brands/{brand-id}/actions/activate" \
-X POST \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/brands/{brand-id}/actions/activate',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

Response

{
  "id": "string",
  "name": "string",
  "files": [
    {}
  ],
  "active": true,
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "string",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "string",
  "description": "string"
}

Deactivate a brand

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)
Categories manage

Path Parameters

  • brand-idstring
    Required

    The brand's unique identifier.

Request Body

Responses

200

application/json

Responds with the brand that was deactivated.

A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.

  • application/jsonobject

    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
    • idstring
      Required
    • namestring
      Required
    • filesarray of objects
      Required
    • activeboolean
    • createdAtstring

      The UTC timestamp when the brand was created.

    • createdBystring

      ID of a user that created the brand.

    • updatedAtstring

      The UTC timestamp when the brand was last updated.

    • updatedBystring

      ID of a user that last updated the brand.

    • descriptionstring
      Required

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

500

application/json

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
POST /v1/brands/{brand-id}/actions/deactivate
curl "https://your-tenant.us.qlikcloud.com/api/v1/brands/{brand-id}/actions/deactivate" \
-X POST \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/brands/{brand-id}/actions/deactivate',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

Response

{
  "id": "string",
  "name": "string",
  "files": [
    {}
  ],
  "active": true,
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "string",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "string",
  "description": "string"
}

Download brand file

Downloads the specified brand file.

Facts

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

Path Parameters

  • brand-idstring
    Required

    The brand's unique identifier.

  • brand-file-idstring
    Required

    The unique identifier of a file within a brand.

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

Responses

200

*/*

OK Response

  • */*string

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

500

application/json

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
GET /v1/brands/{brand-id}/files/{brand-file-id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/brands/{brand-id}/files/{brand-file-id}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/brands/{brand-id}/files/{brand-file-id}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

Response

"string"

Creates a brand file

Creates a brand file for the specified identifier.

Facts

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

Path Parameters

  • brand-idstring
    Required

    The brand's unique identifier.

  • brand-file-idstring
    Required

    The unique identifier of a file within a brand.

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

Request Body

Required

multipart/form-data

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

      The path and name of a file to upload.

Responses

201

application/json

Created Response

Represents one of the assets used as part of the brand. These include logos, favicons, and some styles.

  • application/jsonobject

    Represents one of the assets used as part of the brand. These include logos, favicons, and some styles.

    Show application/json properties
    • idstring

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

    • eTagstring
    • pathstring
    • contentTypestring

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

500

application/json

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
POST /v1/brands/{brand-id}/files/{brand-file-id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/brands/{brand-id}/files/{brand-file-id}" \
-X POST \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <API-key>" \
-F "file=@/path/to/file"
const https = require('https')
  const data = JSON.stringify({"file":"string"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/brands/{brand-id}/files/{brand-file-id}',
    'method': 'POST',
    'headers': {
      'Content-type': 'multipart/form-data',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(formData)
  
This API is not included yet in qlik-cli

Request

{
  "file": "string"
}

Response

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

Update a brand file

Updates the specified brand file.

Facts

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

Path Parameters

  • brand-idstring
    Required

    The brand's unique identifier.

  • brand-file-idstring
    Required

    The unique identifier of a file within a brand.

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

Request Body

Required

multipart/form-data

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

      A file to upload.

Responses

200

application/json

OK Response - file updated

Represents one of the assets used as part of the brand. These include logos, favicons, and some styles.

  • application/jsonobject

    Represents one of the assets used as part of the brand. These include logos, favicons, and some styles.

    Show application/json properties
    • idstring

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

    • eTagstring
    • pathstring
    • contentTypestring

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

500

application/json

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
PUT /v1/brands/{brand-id}/files/{brand-file-id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/brands/{brand-id}/files/{brand-file-id}" \
-X PUT \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <API-key>" \
-F "file=@/path/to/file"
const https = require('https')
  const data = JSON.stringify({"file":"string"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/brands/{brand-id}/files/{brand-file-id}',
    'method': 'PUT',
    'headers': {
      'Content-type': 'multipart/form-data',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(formData)
  
This API is not included yet in qlik-cli

Request

{
  "file": "string"
}

Response

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

Delete a brand file

Deletes the specified brand file.

Facts

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

Path Parameters

  • brand-idstring
    Required

    The brand's unique identifier.

  • brand-file-idstring
    Required

    The unique identifier of a file within a brand.

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

Responses

204

No content response.

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

404

application/json

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring

500

application/json

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
    • traceIdstring
DELETE /v1/brands/{brand-id}/files/{brand-file-id}
curl "https://your-tenant.us.qlikcloud.com/api/v1/brands/{brand-id}/files/{brand-file-id}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/brands/{brand-id}/files/{brand-file-id}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

Retrieve active brand

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

Facts

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

Responses

200

application/json

No active brand, returns an empty response.

Empty object inferring lack of active branding.

  • application/jsonobject

    Empty object inferring lack of active branding.

301

Successful redirect.

GET /v1/brands/active
curl "https://your-tenant.us.qlikcloud.com/api/v1/brands/active" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/brands/active',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

Response

{}