Quotas

Quotas returns entitled attributes based on your license.

Download OpenAPI spec

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

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • reportUsage boolean

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

Responses

200

OK Response

  • application/json object
    Show application/json properties
    • data array of objects
      Required

      Array of quota items.

      Show data properties
      • id string
        Required

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

      • type string
        Required

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

      • attributes object
        Required

        The attributes of the quota.

        Show attributes properties
        • unit string
          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".

        • quota number
          Required

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

          format = double

        • usage number

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

          format = double

        • warningThresholds array 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

Unauthorized

  • application/json object
    Show application/json properties
    • errors array of objects

      A specific error.

      Show errors properties
      • code string
        Required

        The error code.

      • title string
        Required

        Summary of the problem.

500

Internal Server Error

  • application/json object
    Show application/json properties
    • errors array of objects

      A specific error.

      Show errors properties
      • code string
        Required

        The error code.

      • title string
        Required

        Summary of the problem.
GET /api/v1/quotas 
import { createQlikApi } from '@qlik/api'


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


await qlik.quotas.getQuotas({})
qlik quota ls
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/quotas" \
-H "Authorization: Bearer <access_token>"

Example 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)

Query Parameters

  • reportUsage boolean

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

Path Parameters

  • id string
    Required

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

Responses

200

OK Response

  • application/json object
    Show application/json properties
    • data array of objects
      Required

      Quota item.

      Show data properties
      • id string
        Required

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

      • type string
        Required

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

      • attributes object
        Required

        The attributes of the quota.

        Show attributes properties
        • unit string
          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".

        • quota number
          Required

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

          format = double

        • usage number

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

          format = double

        • warningThresholds array 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

Unauthorized

  • application/json object
    Show application/json properties
    • errors array of objects

      A specific error.

      Show errors properties
      • code string
        Required

        The error code.

      • title string
        Required

        Summary of the problem.

404

Not Found

  • application/json object
    Show application/json properties
    • errors array of objects

      A specific error.

      Show errors properties
      • code string
        Required

        The error code.

      • title string
        Required

        Summary of the problem.

500

Internal Server Error

  • application/json object
    Show application/json properties
    • errors array of objects

      A specific error.

      Show errors properties
      • code string
        Required

        The error code.

      • title string
        Required

        Summary of the problem.
GET /api/v1/quotas/{id} 
import { createQlikApi } from '@qlik/api'


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


await qlik.quotas.getQuota('string', {})
qlik quota get 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/quotas/{id}" \
-H "Authorization: Bearer <access_token>"

Example Response

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