Pinned links

Pinned links are administrator-defined URLs which appear for all users under the More button in the global navigation menu.

Download specification

Retrieves a list of all pinned links. All users can list pinned links. This endpoint does not support pagination as a tenant can have a maximum of 50 pinned links at one time.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories

Responses

200

application/json

Pinned links retrieval was successful.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Show data properties
      • idstring
        Required
      • linkstring
        Required
      • namestring
        Required
      • typestring
        Required

        Can be one of: "custom-link"

      • scopestring
        Required

        Can be one of: "user""tenant"

      • tenantIdstring
        Required
      • createdAtstring
        Required

        Date string

      • createdBystring
        Required
      • updatedAtstring

        Date string

      • updatedBystring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • codeinteger

      Error code.

    • messagestring

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

Response

{
  "data": [
    {
      "id": "string",
      "link": "string",
      "name": "string",
      "type": "custom-link",
      "scope": "user",
      "tenantId": "string",
      "createdAt": "string",
      "createdBy": "string",
      "updatedAt": "string",
      "updatedBy": "string"
    }
  ]
}

Create pinned link

Creates a pinned link, which will appear below any existing pinned links in the tenant. Requires calling user to be assigned the TenantAdmin role. A tenant can have a maximum of 50 pinned links.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Request Body

Required

application/json

  • application/jsonobject
    Show application/json properties
    • linkstring

      The URL the user will be taken to when they click on the custom link. Must be https.

    • namestring

      The title of the link, which will be shown in the navigation bar. Max length 50 characters.

    • typestring
      Required

      Specifies the type of the link. Only supports custom-link.

      Can be one of: "custom-link"

    • scopestring
      Required

      Specifies the scope of the link. Only supports tenant.

      Can be one of: "tenant"

Responses

201

application/json

Successfully created pinned link

  • application/jsonobject
    Show application/json properties
    • idstring
      Required
    • linkstring
      Required
    • namestring
      Required
    • typestring
      Required

      Can be one of: "custom-link"

    • scopestring
      Required

      Can be one of: "user""tenant"

    • tenantIdstring
      Required
    • createdAtstring
      Required

      Date string

    • createdBystring
      Required
    • updatedAtstring

      Date string

    • updatedBystring

403

application/json

Forbidden error response.

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

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • codeinteger

      Error code.

    • messagestring

      Error cause.
POST /v1/ui-config/pinned-links 
curl "https://your-tenant.us.qlikcloud.com/api/v1/ui-config/pinned-links" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"link":"string","name":"string","type":"custom-link","scope":"tenant"}'
const https = require('https')
  const data = JSON.stringify({"link":"string","name":"string","type":"custom-link","scope":"tenant"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/ui-config/pinned-links',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)
This API is not included yet in qlik-cli

Request

{
  "link": "string",
  "name": "string",
  "type": "custom-link",
  "scope": "tenant"
}

Response

{
  "id": "string",
  "link": "string",
  "name": "string",
  "type": "custom-link",
  "scope": "user",
  "tenantId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}

Retrieves a specific pinned link.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories

Path Parameters

  • idstring
    Required

    The pinned link identifier.

    format = "uid"

Responses

200

application/json

Pinned link retrieval was successful.

  • application/jsonobject
    Show application/json properties
    • idstring
      Required
    • linkstring
      Required
    • namestring
      Required
    • typestring
      Required

      Can be one of: "custom-link"

    • scopestring
      Required

      Can be one of: "user""tenant"

    • tenantIdstring
      Required
    • createdAtstring
      Required

      Date string

    • createdBystring
      Required
    • updatedAtstring

      Date string

    • updatedBystring

403

application/json

Forbidden error response.

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

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • codeinteger

      Error code.

    • messagestring

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

Response

{
  "id": "string",
  "link": "string",
  "name": "string",
  "type": "custom-link",
  "scope": "user",
  "tenantId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}

Updates a specific pinned link with an array of JSON patches. Requires calling user to be assigned the TenantAdmin role.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • idstring
    Required

    The pinned link identifier.

    format = "uid"

Request Body

application/json

  • application/jsonarray of objects
    Show application/json properties
    • opstring
      Required

      Can be one of: "replace"

    • pathstring
      Required

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

    • valuestring
      Required

      The value to be used for this operation.

Responses

200

application/json

Successfully updated pinned link

  • application/jsonobject
    Show application/json properties
    • idstring
      Required
    • linkstring
      Required
    • namestring
      Required
    • typestring
      Required

      Can be one of: "custom-link"

    • scopestring
      Required

      Can be one of: "user""tenant"

    • tenantIdstring
      Required
    • createdAtstring
      Required

      Date string

    • createdBystring
      Required
    • updatedAtstring

      Date string

    • updatedBystring

403

application/json

Forbidden error response.

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

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • codeinteger

      Error code.

    • messagestring

      Error cause.
PATCH /v1/ui-config/pinned-links/{id} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/ui-config/pinned-links/{id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"https://updatedlink.com"}]'
const https = require('https')
  const data = JSON.stringify([{"op":"replace","path":"/name","value":"https://updatedlink.com"}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/ui-config/pinned-links/{id}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)
This API is not included yet in qlik-cli

Request

[
  {
    "op": "replace",
    "path": "/name",
    "value": "https://updatedlink.com"
  }
]

Response

{
  "id": "string",
  "link": "string",
  "name": "string",
  "type": "custom-link",
  "scope": "user",
  "tenantId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}

Deletes a specific pinned link. Requires calling user to be assigned the TenantAdmin role.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • idstring
    Required

    The pinned link identifier.

    format = "uid"

Responses

204

Successfully deleted pinned links

403

application/json

Forbidden error response.

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

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • codeinteger

      Error code.

    • messagestring

      Error cause.
DELETE /v1/ui-config/pinned-links/{id} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/ui-config/pinned-links/{id}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/ui-config/pinned-links/{id}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
This API is not included yet in qlik-cli

Create multiple pinned links

Creates one or more pinned links for navigation, an alternative method to multiple calls to /ui-config/pinned-links. Links are displayed below any existing pinned links, and will be added in the order sent in the request. Requires calling user to be assigned the TenantAdmin role. A tenant can have a maximum of 50 pinned links.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Request Body

Required

application/json

  • application/jsonobject
    Show application/json properties
    • typestring

      Specifies the type of the link. Only supports custom-link.

      Can be one of: "custom-link"

    • scopestring

      Specifies the scope of the link. Only supports tenant.

      Can be one of: "tenant"

    • linksarray of objects
      Required
      Show links properties
      • linkstring
        Required

        The URL the user will be taken to when they click on the custom link. Must be https.

      • namestring
        Required

        The title of the link, which will be shown in the navigation bar. Max length 50 characters.

Responses

200

application/json

Successfully created pinned links

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Show data properties
      • idstring
        Required
      • linkstring
        Required
      • namestring
        Required
      • typestring
        Required

        Can be one of: "custom-link"

      • scopestring
        Required

        Can be one of: "user""tenant"

      • tenantIdstring
        Required
      • createdAtstring
        Required

        Date string

      • createdBystring
        Required
      • updatedAtstring

        Date string

      • updatedBystring

403

application/json

Forbidden error response.

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

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • codeinteger

      Error code.

    • messagestring

      Error cause.
POST /v1/ui-config/pinned-links/actions/bulk-create-pinned-links 
curl "https://your-tenant.us.qlikcloud.com/api/v1/ui-config/pinned-links/actions/bulk-create-pinned-links" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"type":"custom-link","scope":"tenant","links":[{"link":"string","name":"string"}]}'
const https = require('https')
  const data = JSON.stringify({"type":"custom-link","scope":"tenant","links":[{"link":"string","name":"string"}]})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/ui-config/pinned-links/actions/bulk-create-pinned-links',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)
This API is not included yet in qlik-cli

Request

{
  "type": "custom-link",
  "scope": "tenant",
  "links": [
    {
      "link": "string",
      "name": "string"
    }
  ]
}

Response

{
  "data": [
    {
      "id": "string",
      "link": "string",
      "name": "string",
      "type": "custom-link",
      "scope": "user",
      "tenantId": "string",
      "createdAt": "string",
      "createdBy": "string",
      "updatedAt": "string",
      "updatedBy": "string"
    }
  ]
}

Delete all pinned links

Deletes all pinned links in the tenant. Requires calling user to be assigned the TenantAdmin role.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Responses

204

Successfully deleted all pinned links

403

application/json

Forbidden error response.

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

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • codeinteger

      Error code.

    • messagestring

      Error cause.
POST /v1/ui-config/pinned-links/actions/delete-all-pinned-links 
curl "https://your-tenant.us.qlikcloud.com/api/v1/ui-config/pinned-links/actions/delete-all-pinned-links" \
-X POST \
-H "Authorization: Bearer <access_token>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/ui-config/pinned-links/actions/delete-all-pinned-links',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
This API is not included yet in qlik-cli