quotas

Quotas is the resource representing tenant quotas originating from the license.

Endpoints

Skip to section
GET/quotas
GET/quotas/{id}

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

Query Parameters GET /quotas

reportUsage
optional
boolean

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

Responses GET /quotas

200
application/json

OK Response

401
application/json

Unauthorized

500
application/json

Internal Server Error

GET/quotas

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

Response GET /quotas

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

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

Path Parameters GET /quotas/{id}

id
string

The quota item's unique identifier. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces".

Query Parameters GET /quotas/{id}

reportUsage
optional
boolean

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

Responses GET /quotas/{id}

200
application/json

OK Response

401
application/json

Unauthorized

404
application/json

Not Found

500
application/json

Internal Server Error

GET/quotas/{id}

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

Response GET /quotas/{id}

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

ErrorResponse

object

Properties

errors

No description

Error

object

An specific error.

Properties

code
string

The error code.

title
string

Summary of the problem.

GetQuotasResult

object

Result containing an array of quota items.

Properties

data

Array of quotas items.

GetQuotaByIdResult

object

Result containing an array with a single quota item.

Properties

data

Quota item.

Quota

object

One single quota with attributes.

Properties

type
string

The quota item's resource type. Is always equal to "quotas".

id
string

The quota item's unique identifier. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces".

attributes

The attributes of the quota.

v1.0.0
Was this page helpful?