Skip to content

Brands

Endpoints

Skip to section
GET/v1/brands
POST/v1/brands
GET/v1/brands/{brand-id}
PATCH/v1/brands/{brand-id}
DELETE/v1/brands/{brand-id}
POST/v1/brands/{brand-id}/actions/activate
POST/v1/brands/{brand-id}/actions/deactivate
GET/v1/brands/{brand-id}/files/{brand-file-id}
POST/v1/brands/{brand-id}/files/{brand-file-id}
PUT/v1/brands/{brand-id}/files/{brand-file-id}
DELETE/v1/brands/{brand-id}/files/{brand-file-id}
GET/v1/brands/active

Lists all brand entries for a tenant

manage

Facts GET /v1/brands

Rate limit
required
Tier 1 (1000 requests per minute)

Query Parameters GET /v1/brands

endingBefore
string

Cursor to previous.

limit
default=5, minimum=1, maximum=100
integer

Maximum number of brands to retrieve.

sort
default='-id'
string

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

Enum:

id

+id

-id

createdAt

+createdAt

-createdAt

updatedAt

+updatedAt

-updatedAt

startingAfter
string

Cursor to the next page.

Responses GET /v1/brands

200
application/json

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

500
application/json

Internal Server Error

GET/v1/brands

curl "https://your-tenant.us.qlikcloud.com/api/v1/brands" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/brands

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

Creates a new brand

manage

Facts POST /v1/brands

Rate limit
required
Tier 2 (100 requests per minute)

Request Body POST /v1/brands

logo
multipart/form-data
string<binary>

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.

name
multipart/form-data
string

Name of the brand.

styles
multipart/form-data
string<binary>

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

favIcon
multipart/form-data
string<binary>

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

description
multipart/form-data
string

Description of the brand.

Responses POST /v1/brands

201
application/json

Created Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

500
application/json

Internal Server Error

POST/v1/brands

curl "https://your-tenant.us.qlikcloud.com/api/v1/brands" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: multipart/form-data" \
 -F "logo=@/path/to/file" \
 -F "styles=@/path/to/file" \
 -F "favIcon=@/path/to/file"

Response POST /v1/brands

{
  "id": "string",
  "name": "string",
  "files": [
    {
      "id": "logo",
      "eTag": "string",
      "path": "string",
      "contentType": "string"
    }
  ],
  "active": true,
  "createdAt": "2023-05-30T12:22:35.034Z",
  "createdBy": "string",
  "updatedAt": "2023-05-30T12:22:35.034Z",
  "updatedBy": "string",
  "description": "string"
}

Retrieves a specific brand

manage

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

Rate limit
required
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/brands/{brand-id}

brand-id
required

The brand's unique identifier.

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

200
application/json

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

GET/v1/brands/{brand-id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/brands/{brand-id}" \
 -H "Authorization: Bearer <API-key>"

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

{
  "id": "string",
  "name": "string",
  "files": [
    {
      "id": "logo",
      "eTag": "string",
      "path": "string",
      "contentType": "string"
    }
  ],
  "active": true,
  "createdAt": "2023-05-30T12:22:35.034Z",
  "createdBy": "string",
  "updatedAt": "2023-05-30T12:22:35.034Z",
  "updatedBy": "string",
  "description": "string"
}

Patches a brand

manage

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

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters PATCH /v1/brands/{brand-id}

brand-id
required

The brand's unique identifier.

Request Body PATCH /v1/brands/{brand-id}

application/json

No description

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

204
object

No Content Response.

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

PATCH/v1/brands/{brand-id}

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

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

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

Deletes a specific brand

manage

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

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/brands/{brand-id}

brand-id
required

The brand's unique identifier.

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

204
object

No Content Response.

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

DELETE/v1/brands/{brand-id}

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

Activates a brand

manage

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

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

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters POST /v1/brands/{brand-id}/actions/activate

brand-id
required

The brand's unique identifier.

Request Body POST /v1/brands/{brand-id}/actions/activate

application/json

No description

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

200
application/json

Responds with the brand that was activated.

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

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>" \
 -H "Content-type: application/json"

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

{
  "id": "string",
  "name": "string",
  "files": [
    {
      "id": "logo",
      "eTag": "string",
      "path": "string",
      "contentType": "string"
    }
  ],
  "active": true,
  "createdAt": "2023-05-30T12:22:35.034Z",
  "createdBy": "string",
  "updatedAt": "2023-05-30T12:22:35.034Z",
  "updatedBy": "string",
  "description": "string"
}

Deactivates a brand

manage

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

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

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters POST /v1/brands/{brand-id}/actions/deactivate

brand-id
required

The brand's unique identifier.

Request Body POST /v1/brands/{brand-id}/actions/deactivate

application/json

No description

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

200
application/json

Responds with the brand that was deactivated.

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

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>" \
 -H "Content-type: application/json"

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

{
  "id": "string",
  "name": "string",
  "files": [
    {
      "id": "logo",
      "eTag": "string",
      "path": "string",
      "contentType": "string"
    }
  ],
  "active": true,
  "createdAt": "2023-05-30T12:22:35.034Z",
  "createdBy": "string",
  "updatedAt": "2023-05-30T12:22:35.034Z",
  "updatedBy": "string",
  "description": "string"
}

Downloads the brand file

manage

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

Rate limit
required
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/brands/{brand-id}/files/{brand-file-id}

brand-id
required

The brand's unique identifier.

brand-file-id

The unique identifier of a file within a brand.

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

200
*/*
string<binary>

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

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>"

Creates a brand file

manage

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

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters POST /v1/brands/{brand-id}/files/{brand-file-id}

brand-id
required

The brand's unique identifier.

brand-file-id

The unique identifier of a file within a brand.

Request Body POST /v1/brands/{brand-id}/files/{brand-file-id}

file
multipart/form-data
string<binary>

The path and name of a file to upload.

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

201
application/json

Created Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

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 "Authorization: Bearer <API-key>" \
 -H "Content-type: multipart/form-data" \
 -F "file=@/path/to/file"

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

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

Updates existing file

manage

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

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters PUT /v1/brands/{brand-id}/files/{brand-file-id}

brand-id
required

The brand's unique identifier.

brand-file-id

The unique identifier of a file within a brand.

Request Body PUT /v1/brands/{brand-id}/files/{brand-file-id}

file
multipart/form-data
string<binary>

A file to upload.

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

200
application/json

OK Response - file updated

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

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 "Authorization: Bearer <API-key>" \
 -H "Content-type: multipart/form-data" \
 -F "file=@/path/to/file"

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

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

Deletes a specific brand file

manage

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

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/brands/{brand-id}/files/{brand-file-id}

brand-id
required

The brand's unique identifier.

brand-file-id

The unique identifier of a file within a brand.

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

204
object

No content response.

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

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>"

Retrieves the current active brand

manage

Facts GET /v1/brands/active

Rate limit
required
Tier 1 (1000 requests per minute)

Responses GET /v1/brands/active

200
object

No active brand, returns an empty response.

301
object

Successful redirect.

GET/v1/brands/active

curl "https://your-tenant.us.qlikcloud.com/api/v1/brands/active" \
 -H "Authorization: Bearer <API-key>"

brand-file-id

string

The unique identifier of a file within a brand.

Enum:

logo

favIcon

styles

brand-id

string

The brand's unique identifier.

BadRequest

Bad Request

Forbidden

Forbidden

InternalServerError

Internal Server Error

NotFound

Not found

Unauthorized

Unauthorized

Brand

object

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

Properties

id
required
string

No description

name
required
string

No description

files
required

Collection of resources that make up the brand.

active
boolean

No description

createdAt
string<date-time>

The UTC timestamp when the brand was created.

createdBy
string

ID of a user that created the brand.

updatedAt
string<date-time>

The UTC timestamp when the brand was last updated.

updatedBy
string

ID of a user that last updated the brand.

description
required
string

No description

BrandFile

object

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

Properties

id
string

No description

Enum:

logo

favIcon

styles

eTag
string

No description

path
string

No description

contentType
string

No description

BrandPatch

object

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

Properties

op
required
string

The operation to be performed.

Enum:

add

remove

replace

path
required
string

The path for the given resource field to patch.

Enum:

/name

/description

value
string

The value to be used for this operation.

BrandsList

object

A collection of brands.

Properties

data

No description

links

No description

ErrorResponse400

object

Properties

errors

No description

traceId
string

No description

ErrorResponse401

object

Properties

errors

No description

traceId
string

No description

ErrorResponse403

object

Properties

errors

No description

traceId
string

No description

ErrorResponse404

object

Properties

errors

No description

traceId
string

No description

ErrorResponse500

object

Properties

errors

No description

traceId
string

No description

Properties

href
required
string

URL of a resource request.

v0.690.0
Was this page helpful?