Tenants

Endpoints

GET

/api/core/tenants
GET

/api/core/tenants/{tenantId}
GET

/api/core/tenants/actions/count
POST

/api/core/tenants/actions/filter

Use this operation to retrieve a list of tenants across multiple organizations. Filter results using SCIM filter expressions and sort by supported fields. Returns paginated results with optional total count.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

filterstring
SCIM filter expression.

Supported attributes are subscriptionId (required), regionCode, countryCode, name, hostnames, createdAt, updatedAt, id, status, and originalId.

Supports logical operators (and, or, not) and comparison operators (eq, ne, gt, ge, lt, le, co).

Operator support varies by attribute. For example:
- regionCode, status: support eq, ne
- subscriptionId, name, hostnames, id, originalId: support eq only
limitinteger

Maximum number of results to return (0-100, default 20).

minimum = 0, maximum = 100, default = 20, default = 20
nextstring

Cursor for the next page of results (tenant ObjectId).
prevstring

Cursor for the previous page of results (tenant ObjectId).
sortstring

Comma-separated list of fields to sort by. Prefix with - for descending order, + or no prefix for ascending. Supported fields are name, regionCode, countryCode, hostnames, createdAt, updatedAt, status, subscriptionId.
totalResultsstring

When set to true, includes the total count of matching tenants in the response. Default is false.

Can be one of: "true""false"

Responses

200

Tenants retrieved successfully.

application/jsonobject

A paginated list of Qlik Cloud tenants. Includes cursor-based pagination and an optional total count.
Show application/json properties
- dataarray of objects
  
  A tenant resource representing a Qlik Cloud tenant.
  
  Show data properties
  
  idstring
  Required
  
  The unique identifier of the tenant (originalId).
  
  namestring
  
  The display name of the tenant.
  
  linksobject
  
  Show links properties
  
  selfobject
  
  A link to this tenant.
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  statusstring
  Required
  
  The status of the tenant.
  
  Can be one of: "active""disabled""deleted""deactivated"
  
  createdAtstring
  Required
  
  The timestamp for when the tenant was created.
  
  format = "date-time"
  
  createdBystring
  
  The identifier of the user who created the tenant.
  
  hostnamesarray of strings
  Required
  
  List of case-insensitive hostnames mapped to the tenant.
  
  updatedAtstring
  Required
  
  The timestamp for when the tenant was last updated.
  
  format = "date-time"
  
  regionCodestring
  Required
  
  The region code where the tenant is located.
  
  Can be one of: "us-east-1""us-east-2""us-west-1""us-west-2""eu-west-1""eu-west-2""eu-west-3""eu-north-1""eu-central-1""ap-southeast-1""ap-southeast-2""ap-northeast-1""ap-south-1""il-central-1""me-central-1""sa-east-1""ca-central-1"
  
  countryCodestring
  Required
  
  The country code for the tenant.
  
  Can be one of: "US""IE""GB""DE""SG""AU""JP""IN""IL""AE""BR""FR""SE""CA"
  
  licenseEndsAtstring
  
  The date when the license ends.
  
  format = "date"
  
  licenseNumberstring
  
  The license number associated with the tenant.
  
  subscriptionIdstring
  
  The parent subscription ID (license number) for the tenant.
  
  licenseStartsAtstring
  
  The date when the license starts.
  
  format = "date"
  
  deletionStartsAtstring
  
  The scheduled date for tenant deletion.
  
  format = "date-time"
- linksobject
  
  Show links properties
  
  selfobject
  
  Show self properties
  
  hrefstring
  
  The URL of the current request.
- pagingobject
  
  Pagination information for navigating through results.
  
  Show paging properties
  
  nextstring
  
  Query string for the next page of results.
  
  prevstring
  
  Query string for the previous page of results.
- totalResultsinteger
  
  Total number of tenants matching the query. Only included when the totalResults query parameter is set to true.

400

Bad request. The request contains invalid query parameters or an invalid SCIM filter expression.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
  
  An array of errors related to the operation.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to this occurrence of the error.
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON Pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  statusstring
  Required
  
  The HTTP status code.
- traceIdstring
  
  A unique identifier for tracing the error.

403

Forbidden. The user does not have permission to access tenants, or the feature is not enabled.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
  
  An array of errors related to the operation.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to this occurrence of the error.
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON Pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  statusstring
  Required
  
  The HTTP status code.
- traceIdstring
  
  A unique identifier for tracing the error.

default

Unexpected error.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
  
  An array of errors related to the operation.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to this occurrence of the error.
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON Pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  statusstring
  Required
  
  The HTTP status code.
- traceIdstring
  
  A unique identifier for tracing the error.

GET /api/core/tenants

This API is not included yet in qlik-cli

curl "https://console.qlikcloud.com/api/core/tenants" \
-H "Authorization: Bearer <access_token>"

const https = require('https')

const options = {
  hostname: 'console.qlikcloud.com',
  port: 443,
  path: '/api/core/tenants',
  method: 'GET',
  headers: {
    Authorization: 'Bearer <access_token>',
  },
}

const req = https.request(options)

Example Response

{
  "data": [
    {
      "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "name": "QlikTenant",
      "links": {
        "self": {
          "href": "http://foo.example/api/v1/tenants/TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
        }
      },
      "status": "active",
      "createdAt": "2023-01-15T10:30:00.000Z",
      "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy7A",
      "hostnames": [
        "example-tenant.us.qlikcloud.com",
        "example-tenant.example.com"
      ],
      "updatedAt": "2023-06-20T14:45:00.000Z",
      "regionCode": "us-east-1",
      "countryCode": "US",
      "licenseEndsAt": "2024-12-31",
      "licenseNumber": "1234567890123456",
      "subscriptionId": "9876543210987654",
      "licenseStartsAt": "2023-01-01",
      "deletionStartsAt": "2024-06-30T00:00:00.000Z"
    }
  ],
  "links": {
    "self": {
      "href": "https://api.qlikcloud.com/core/tenants"
    }
  },
  "paging": {
    "next": "limit=20&next=507f191e810c19729de860ea",
    "prev": "limit=20&prev=507f1f77bcf86cd799439011"
  },
  "totalResults": 150
}

Use this operation to retrieve a specific Qlik Cloud tenant by its identifier.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

tenantIdstring
Required

The identifier of the tenant to retrieve.

Responses

200

Tenant retrieved successfully.

application/jsonobject

A paginated list of Qlik Cloud tenants. Includes cursor-based pagination and an optional total count.
Show application/json properties
- dataarray of objects
  
  A tenant resource representing a Qlik Cloud tenant.
  
  Show data properties
  
  idstring
  Required
  
  The unique identifier of the tenant (originalId).
  
  namestring
  
  The display name of the tenant.
  
  linksobject
  
  Show links properties
  
  selfobject
  
  A link to this tenant.
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  statusstring
  Required
  
  The status of the tenant.
  
  Can be one of: "active""disabled""deleted""deactivated"
  
  createdAtstring
  Required
  
  The timestamp for when the tenant was created.
  
  format = "date-time"
  
  createdBystring
  
  The identifier of the user who created the tenant.
  
  hostnamesarray of strings
  Required
  
  List of case-insensitive hostnames mapped to the tenant.
  
  updatedAtstring
  Required
  
  The timestamp for when the tenant was last updated.
  
  format = "date-time"
  
  regionCodestring
  Required
  
  The region code where the tenant is located.
  
  Can be one of: "us-east-1""us-east-2""us-west-1""us-west-2""eu-west-1""eu-west-2""eu-west-3""eu-north-1""eu-central-1""ap-southeast-1""ap-southeast-2""ap-northeast-1""ap-south-1""il-central-1""me-central-1""sa-east-1""ca-central-1"
  
  countryCodestring
  Required
  
  The country code for the tenant.
  
  Can be one of: "US""IE""GB""DE""SG""AU""JP""IN""IL""AE""BR""FR""SE""CA"
  
  licenseEndsAtstring
  
  The date when the license ends.
  
  format = "date"
  
  licenseNumberstring
  
  The license number associated with the tenant.
  
  subscriptionIdstring
  
  The parent subscription ID (license number) for the tenant.
  
  licenseStartsAtstring
  
  The date when the license starts.
  
  format = "date"
  
  deletionStartsAtstring
  
  The scheduled date for tenant deletion.
  
  format = "date-time"
- linksobject
  
  Show links properties
  
  selfobject
  
  Show self properties
  
  hrefstring
  
  The URL of the current request.
- pagingobject
  
  Pagination information for navigating through results.
  
  Show paging properties
  
  nextstring
  
  Query string for the next page of results.
  
  prevstring
  
  Query string for the previous page of results.
- totalResultsinteger
  
  Total number of tenants matching the query. Only included when the totalResults query parameter is set to true.

400

Bad request. The request contains an invalid tenant identifier.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
  
  An array of errors related to the operation.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to this occurrence of the error.
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON Pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  statusstring
  Required
  
  The HTTP status code.
- traceIdstring
  
  A unique identifier for tracing the error.

403

Forbidden. The user does not have permission to access this tenant, or the feature is not enabled.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
  
  An array of errors related to the operation.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to this occurrence of the error.
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON Pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  statusstring
  Required
  
  The HTTP status code.
- traceIdstring
  
  A unique identifier for tracing the error.

404

The requested tenant was not found.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
  
  An array of errors related to the operation.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to this occurrence of the error.
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON Pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  statusstring
  Required
  
  The HTTP status code.
- traceIdstring
  
  A unique identifier for tracing the error.

default

Unexpected error.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
  
  An array of errors related to the operation.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to this occurrence of the error.
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON Pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  statusstring
  Required
  
  The HTTP status code.
- traceIdstring
  
  A unique identifier for tracing the error.

GET /api/core/tenants/{tenantId}

This API is not included yet in qlik-cli

curl "https://console.qlikcloud.com/api/core/tenants/{tenantId}" \
-H "Authorization: Bearer <access_token>"

const https = require('https')

const options = {
  hostname: 'console.qlikcloud.com',
  port: 443,
  path: '/api/core/tenants/{tenantId}',
  method: 'GET',
  headers: {
    Authorization: 'Bearer <access_token>',
  },
}

const req = https.request(options)

Example Response

{
  "data": [
    {
      "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "name": "QlikTenant",
      "links": {
        "self": {
          "href": "http://foo.example/api/v1/tenants/TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
        }
      },
      "status": "active",
      "createdAt": "2023-01-15T10:30:00.000Z",
      "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy7A",
      "hostnames": [
        "example-tenant.us.qlikcloud.com",
        "example-tenant.example.com"
      ],
      "updatedAt": "2023-06-20T14:45:00.000Z",
      "regionCode": "us-east-1",
      "countryCode": "US",
      "licenseEndsAt": "2024-12-31",
      "licenseNumber": "1234567890123456",
      "subscriptionId": "9876543210987654",
      "licenseStartsAt": "2023-01-01",
      "deletionStartsAt": "2024-06-30T00:00:00.000Z"
    }
  ],
  "links": {
    "self": {
      "href": "https://api.qlikcloud.com/core/tenants"
    }
  },
  "paging": {
    "next": "limit=20&next=507f191e810c19729de860ea",
    "prev": "limit=20&prev=507f1f77bcf86cd799439011"
  },
  "totalResults": 150
}

Use this operation to count Qlik Cloud tenants matching a SCIM filter expression. Primarily used for subscription-based queries. The subscriptionId attribute is required in the filter expression.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

filterstring
Required

SCIM filter query string. Must include the subscriptionId attribute.

Responses

200

Tenant count retrieved successfully.

application/jsonobject

Response containing the total count of tenants matching a filter.
Show application/json properties
- totalinteger
  Required
  
  The total number of tenants matching the filter criteria.

400

Bad request. The request contains an invalid filter expression or is missing the required subscriptionId attribute.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
  
  An array of errors related to the operation.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to this occurrence of the error.
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON Pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  statusstring
  Required
  
  The HTTP status code.
- traceIdstring
  
  A unique identifier for tracing the error.

403

Forbidden. The user does not have permission to count tenants.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
  
  An array of errors related to the operation.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to this occurrence of the error.
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON Pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  statusstring
  Required
  
  The HTTP status code.
- traceIdstring
  
  A unique identifier for tracing the error.

default

Unexpected error.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
  
  An array of errors related to the operation.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to this occurrence of the error.
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON Pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  statusstring
  Required
  
  The HTTP status code.
- traceIdstring
  
  A unique identifier for tracing the error.

GET /api/core/tenants/actions/count

This API is not included yet in qlik-cli

curl "https://console.qlikcloud.com/api/core/tenants/actions/count" \
-H "Authorization: Bearer <access_token>"

const https = require('https')

const options = {
  hostname: 'console.qlikcloud.com',
  port: 443,
  path: '/api/core/tenants/actions/count',
  method: 'GET',
  headers: {
    Authorization: 'Bearer <access_token>',
  },
}

const req = https.request(options)

Example Response

{
  "total": 42
}

Use this operation to search and filter Qlik Cloud tenants using a SCIM filter expression provided in the request body. Supports complex queries with logical and comparison operators.

Facts

Rate limit

Tier 2 (100 requests per minute)

Query Parameters

limitinteger

Maximum number of results to return (0-100, default 20).

minimum = 0, maximum = 100, default = 20, default = 20
nextstring

Cursor for the next page of results (tenant ObjectId).
prevstring

Cursor for the previous page of results (tenant ObjectId).
sortstring

Comma-separated list of fields to sort by. Prefix with - for descending order, + or no prefix for ascending. Supported fields are name, regionCode, countryCode, hostnames, createdAt, updatedAt, status, subscriptionId.
totalResultsstring

When set to true, includes the total count of matching tenants in the response. Default is false.

Can be one of: "true""false"

Request Body

Required

Request body containing the SCIM filter expression used to select tenants.

application/jsonobject

Request body for filtering tenants using SCIM filter expressions.
Show application/json properties
- filterstring
  
  SCIM filter expression.
  
  Supported attributes are subscriptionId (required), regionCode, countryCode, name, hostnames, createdAt, updatedAt, id, status, and originalId.
  
  Supports logical operators (and, or, not) and comparison operators (eq, ne, gt, ge, lt, le, co).
  
  Operator support varies by attribute. For example:
  
  regionCode, status: support eq, ne
  
  subscriptionId, name, hostnames, id, originalId: support eq only

Responses

200

Tenants filtered successfully.

application/jsonobject

A paginated list of Qlik Cloud tenants returned by the filter operation. Includes cursor-based pagination and an optional total count.
Show application/json properties
- dataarray of objects
  
  A tenant resource representing a Qlik Cloud tenant.
  
  Show data properties
  
  idstring
  Required
  
  The unique identifier of the tenant (originalId).
  
  namestring
  
  The display name of the tenant.
  
  linksobject
  
  Show links properties
  
  selfobject
  
  A link to this tenant.
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  statusstring
  Required
  
  The status of the tenant.
  
  Can be one of: "active""disabled""deleted""deactivated"
  
  createdAtstring
  Required
  
  The timestamp for when the tenant was created.
  
  format = "date-time"
  
  createdBystring
  
  The identifier of the user who created the tenant.
  
  hostnamesarray of strings
  Required
  
  List of case-insensitive hostnames mapped to the tenant.
  
  updatedAtstring
  Required
  
  The timestamp for when the tenant was last updated.
  
  format = "date-time"
  
  regionCodestring
  Required
  
  The region code where the tenant is located.
  
  Can be one of: "us-east-1""us-east-2""us-west-1""us-west-2""eu-west-1""eu-west-2""eu-west-3""eu-north-1""eu-central-1""ap-southeast-1""ap-southeast-2""ap-northeast-1""ap-south-1""il-central-1""me-central-1""sa-east-1""ca-central-1"
  
  countryCodestring
  Required
  
  The country code for the tenant.
  
  Can be one of: "US""IE""GB""DE""SG""AU""JP""IN""IL""AE""BR""FR""SE""CA"
  
  licenseEndsAtstring
  
  The date when the license ends.
  
  format = "date"
  
  licenseNumberstring
  
  The license number associated with the tenant.
  
  subscriptionIdstring
  
  The parent subscription ID (license number) for the tenant.
  
  licenseStartsAtstring
  
  The date when the license starts.
  
  format = "date"
  
  deletionStartsAtstring
  
  The scheduled date for tenant deletion.
  
  format = "date-time"
- linksobject
  
  Show links properties
  
  selfobject
  
  Show self properties
  
  hrefstring
  
  The URL of the current request.
- pagingobject
  
  Pagination information for navigating through results.
  
  Show paging properties
  
  nextstring
  
  Query string for the next page of results.
  
  prevstring
  
  Query string for the previous page of results.
- totalResultsinteger
  
  Total number of tenants matching the filter. Only included when the totalResults query parameter is set to true.

400

Bad request. The request contains an invalid SCIM filter or invalid query parameters.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
  
  An array of errors related to the operation.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to this occurrence of the error.
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON Pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  statusstring
  Required
  
  The HTTP status code.
- traceIdstring
  
  A unique identifier for tracing the error.

403

Forbidden. The user does not have permission to filter tenants, or the feature is not enabled.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
  
  An array of errors related to the operation.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to this occurrence of the error.
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON Pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  statusstring
  Required
  
  The HTTP status code.
- traceIdstring
  
  A unique identifier for tracing the error.

default

Unexpected error.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
  
  An array of errors related to the operation.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to this occurrence of the error.
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON Pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  statusstring
  Required
  
  The HTTP status code.
- traceIdstring
  
  A unique identifier for tracing the error.

POST /api/core/tenants/actions/filter

This API is not included yet in qlik-cli

curl "https://console.qlikcloud.com/api/core/tenants/actions/filter" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"filter":"subscriptionId eq \"9876543210987654\" and status eq \"active\""}'

const https = require('https')

const data = JSON.stringify({
  filter:
    'subscriptionId eq "9876543210987654" and status eq "active"',
})
const options = {
  hostname: 'console.qlikcloud.com',
  port: 443,
  path: '/api/core/tenants/actions/filter',
  method: 'POST',
  headers: {
    'Content-type': 'application/json',
    Authorization: 'Bearer <access_token>',
  },
}

const req = https.request(options)
req.write(data)

Example Response

{
  "data": [
    {
      "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "name": "QlikTenant",
      "links": {
        "self": {
          "href": "http://foo.example/api/v1/tenants/TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
        }
      },
      "status": "active",
      "createdAt": "2023-01-15T10:30:00.000Z",
      "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy7A",
      "hostnames": [
        "example-tenant.us.qlikcloud.com",
        "example-tenant.example.com"
      ],
      "updatedAt": "2023-06-20T14:45:00.000Z",
      "regionCode": "us-east-1",
      "countryCode": "US",
      "licenseEndsAt": "2024-12-31",
      "licenseNumber": "1234567890123456",
      "subscriptionId": "9876543210987654",
      "licenseStartsAt": "2023-01-01",
      "deletionStartsAt": "2024-06-30T00:00:00.000Z"
    }
  ],
  "links": {
    "self": {
      "href": "https://api.qlikcloud.com/core/tenants/actions/filter"
    }
  },
  "paging": {
    "next": "limit=20&next=507f191e810c19729de860ea",
    "prev": "limit=20&prev=507f1f77bcf86cd799439011"
  },
  "totalResults": 42
}

Tenants

Endpoints

List tenants

Facts

Query Parameters

Responses

200

400

403

default

Example Response

Get a tenant

Facts

Path Parameters

Responses

200

400

403

404

default

Example Response

Count tenants

Facts

Query Parameters

Responses

200

400

403

default

Example Response

Filter tenants

Facts

Query Parameters

Request Body

Responses

200

400

403

default

Example Response