Quotas

Quotas returns entitled attributes based on your license.

Download specification

Returns all quota items for the tenant (provided in JWT).

Facts

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

Query Parameters

  • reportUsageboolean

    The Boolean flag indicating whether quota usage shall be part of the response. The default value is false (only limits returned).

Responses

200

application/json

OK Response

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

      Array of quota items.

      Show data properties
      • idstring
        Required

        The unique identifier of the quota item. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces".

      • typestring
        Required

        The resource type of the quota item. Always equal to "quotas".

      • attributesobject
        Required

        The attributes of the quota.

        Show attributes properties
        • unitstring
          Required

          The unit of the quota limit. For memory quotas, the unit is always "bytes". For other discrete units, the item counted is used as unit, for example "spaces".

        • quotanumber
          Required

          The quota limit. If there is no quota limit, -1 is returned.

          format = double

        • usagenumber

          The current quota usage, if applicable. This attribute is only present if it is requested using the reportUsage query parameter.

          format = double

        • warningThresholdsarray of numbers

          The warning thresholds at which "close to quota" warnings can be issued when exceeded. If omitted, no warning threshold shall be used. Currently, the array will contain only one threshold value. In the future, this may be extended. The threshold is a number between 0 and 1, relating to the quota limit. For example, a value of 0.9 means that a warning should be issued when exceeding 90% of the quota limit.

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      A specific error.

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Summary of the problem.

500

application/json

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      A specific error.

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Summary of the problem.
GET /v1/quotas 
curl "https://your-tenant.us.qlikcloud.com/api/v1/quotas" \
-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/quotas',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  

qlik quota ls

Response

{
  "data": [
    {
      "id": "string",
      "type": "string",
      "attributes": {
        "unit": "string",
        "quota": 42,
        "usage": 42,
        "warningThresholds": [
          0.9
        ]
      }
    }
  ]
}

Returns a specific quota item for the tenant (provided in JWT).

Facts

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

Query Parameters

  • reportUsageboolean

    The Boolean flag indicating whether quota usage shall be part of the response. The default value is false (usage not included).

Path Parameters

  • idstring
    Required

    The unique identifier of the quota item. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces".

Responses

200

application/json

OK Response

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

      Quota item.

      Show data properties
      • idstring
        Required

        The unique identifier of the quota item. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces".

      • typestring
        Required

        The resource type of the quota item. Always equal to "quotas".

      • attributesobject
        Required

        The attributes of the quota.

        Show attributes properties
        • unitstring
          Required

          The unit of the quota limit. For memory quotas, the unit is always "bytes". For other discrete units, the item counted is used as unit, for example "spaces".

        • quotanumber
          Required

          The quota limit. If there is no quota limit, -1 is returned.

          format = double

        • usagenumber

          The current quota usage, if applicable. This attribute is only present if it is requested using the reportUsage query parameter.

          format = double

        • warningThresholdsarray of numbers

          The warning thresholds at which "close to quota" warnings can be issued when exceeded. If omitted, no warning threshold shall be used. Currently, the array will contain only one threshold value. In the future, this may be extended. The threshold is a number between 0 and 1, relating to the quota limit. For example, a value of 0.9 means that a warning should be issued when exceeding 90% of the quota limit.

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      A specific error.

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Summary of the problem.

404

application/json

Not Found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      A specific error.

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Summary of the problem.

500

application/json

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      A specific error.

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Summary of the problem.
GET /v1/quotas/{id} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/quotas/{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/quotas/{id}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  

qlik quota get <quotaId>

Response

{
  "data": [
    {
      "id": "string",
      "type": "string",
      "attributes": {
        "unit": "string",
        "quota": 42,
        "usage": 42,
        "warningThresholds": [
          0.9
        ]
      }
    }
  ]
}