IP Policies

IP policies let you control which IP addresses can access your Qlik Cloud tenant. Use this API to manage allowlisting rules by creating, listing, updating, and deleting IP policies. When allowlisting is enabled, only users connecting from allowed IPv4 addresses or ranges can access the tenant.

Download specification

List IP policies

Returns a list of IP policies present in the tenant. The user must be assigned the TenantAdmin role.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories

Query Parameters

  • fieldsstring

    A comma-separated list of fields to limit in the response.

  • filterstring

    The advanced filtering to use for the query. Refer to RFC 7644 for the syntax. All conditional statements within this query parameter are case insensitive.

    field "enabled" supports following operators: eq

    field "id" supports following operators: eq, ne

    field "name" supports following operators: eq, co

    field "tenantId" supports following operators: eq

  • limitnumber

    The number of IP policies to retrieve.

    minimum = 1, maximum = 100, default = 20, default = 20

  • pagestring

    The page cursor. Takes precedence over other parameters.

  • sortstring

    Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending.

    Can be one of: "enabled""+enabled""-enabled""createdAt""+createdAt""-createdAt""updatedAt""+updatedAt""-updatedAt""name""+name""-name"

  • totalResultsboolean

    Determines whether to return a count of the total records matched in the query. Defaults to false.

    default = false

Responses

200

IP policies retrieved successfully. The response includes an array of IP policies and pagination links.

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

      An array of IP policies.

      Show data properties
      • idstring
        RequiredFilterable

        The unique identifier for the IP policy.

        format = "uid"

      • namestring

        The descriptive name for the IP policy.

      • enabledboolean

        Indicates whether the IP policy is enabled.

      • editableboolean

        Indicates whether the IP policy can be updated.

      • tenantIdstring

        The tenant unique identifier associated with the given IP policy.

        format = "uid"

      • createdAtstring

        The timestamp for when the resource was created.

        format = "date-time"

      • createdBystring

        The user ID of the user who created the IP policy.

      • deletableboolean

        Indicates whether the IP policy can be deleted.

      • updatedAtstring

        The timestamp for when the resource was last updated.

        format = "date-time"

      • updatedBystring

        The user ID of the user who last updated the IP policy.

      • allowedIpsarray of strings

        An array of allowed IP addresses.

      • toggleableboolean

        Indicates whether the IP policy can be enabled/disabled.
    • linksobject
      Required

      Contains pagination links. self is a link to the current results page, next is a link to the next results page and prev is a link to the previous results page

      Show links properties
      • nextobject

        A link

        Show next properties
        • hrefstring
          Required

          format = "uri"

      • prevobject

        A link

        Show prev properties
        • hrefstring
          Required

          format = "uri"

      • selfobject
        Required

        A link

        Show self properties
        • hrefstring
          Required

          format = "uri"

    • totalResultsinteger

      Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true.

400

Invalid request parameters for querying IP policies.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

401

Unauthorized, JWT is invalid or not provided.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

500

Internal server 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.
GET /api/core/ip-policies 
// qlik-api has not implemented support for `GET /api/core/ip-policies` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/core/ip-policies',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
This API is not included yet in qlik-cli
curl "https://{tenant}.{region}.qlikcloud.com/api/core/ip-policies" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Allow access from office IP addresses.",
      "enabled": true,
      "editable": true,
      "tenantId": "644fd58b846d649c82eba436",
      "createdAt": "2021-03-21T17:32:28Z",
      "createdBy": "507f191e810c19729de860ea",
      "deletable": true,
      "updatedAt": "2021-03-22T10:01:02Z",
      "updatedBy": "507f191e810c19729de860ea",
      "allowedIps": [
        "61.254.213.0/24",
        "22.46.216.142"
      ],
      "toggleable": true
    }
  ],
  "links": {
    "next": {
      "href": "http://mytenant.us.qlikcloud.com/api/core/ip-policies?page=QaFdFYW6pImZvRgFaDyB1UffNgfs4mRd"
    },
    "prev": {
      "href": "http://mytenant.us.qlikcloud.com/api/core/ip-policies?page=QaFdFYW6pImZvRgFaDyB1UffNgfs4mRd"
    },
    "self": {
      "href": "http://mytenant.us.qlikcloud.com/api/core/ip-policies?page=QaFdFYW6pImZvRgFaDyB1UffNgfs4mRd"
    }
  },
  "totalResults": 42
}

Create an IP policy

Creates a new IPv4 IP policy in the tenant. If this is the first enabled policy, IP allowlisting will be enabled and access via other IP addresses will be blocked. The user's IP address must be present in at least one policy if allowlisting is enabled. The user must be assigned the TenantAdmin role. IPv6 IP addresses are not currently supported.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Request Body

Required
  • application/jsonobject
    Show application/json properties
    • namestring

      The descriptive name for the IP policy.

    • enabledboolean

      Indicates whether the IP policy is enabled.

      default = false

    • allowedIpsarray of strings
      Required

      An array of allowed IP IPv4 addresses, either as plain IP addresses, or as CIDR ranges.

Responses

201

Request successfully completed.

  • application/jsonobject
    Show application/json properties
    • idstring
      RequiredFilterable

      The unique identifier for the IP policy.

      format = "uid"

    • namestring
      RequiredFilterable

      The descriptive name for the IP policy.

    • enabledboolean
      Required

      Indicates whether the IP policy is enabled.

    • editableboolean
      Required

      Indicates whether the IP policy can be updated.

    • tenantIdstring
      RequiredFilterable

      The tenant unique identifier associated with the given IP policy.

      format = "uid"

    • createdAtstring
      RequiredFilterable

      The timestamp for when the IP policy was created.

      format = "date-time"

    • createdBystring
      Required

      The user ID of the user who created the IP policy.

    • deletableboolean
      Required

      Indicates whether the IP policy can be deleted.

    • updatedAtstring
      RequiredFilterable

      The timestamp for when the IP policy was last updated.

      format = "date-time"

    • updatedBystring
      Required

      The user ID of the user who last updated the IP policy.

    • allowedIpsarray of strings
      Required

      An array of allowed public IPv4 addresses.

    • toggleableboolean
      Required

      Indicates whether the IP policy can be enabled/disabled..

400

Invalid request body.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

404

IP Policy ID not found or Invalid format.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

500

Internal Server 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.
POST /api/core/ip-policies 
// qlik-api has not implemented support for `POST /api/core/ip-policies` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/core/ip-policies',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'Allow access from office IP addresses.',
      enabled: false,
      allowedIps: [
        '61.254.213.0/24',
        '22.46.216.142',
      ],
    }),
  },
)
This API is not included yet in qlik-cli
curl "https://{tenant}.{region}.qlikcloud.com/api/core/ip-policies" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"Allow access from office IP addresses.","enabled":false,"allowedIps":["61.254.213.0/24","22.46.216.142"]}'

Example Response

{
  "id": "507f191e810c19729de860ea",
  "name": "Allow access from office IP addresses.",
  "enabled": true,
  "editable": true,
  "tenantId": "644fd58b846d649c82eba436",
  "createdAt": "2021-03-21T17:32:28Z",
  "createdBy": "507f191e810c19729de860ea",
  "deletable": true,
  "updatedAt": "2021-03-22T10:01:02Z",
  "updatedBy": "507f191e810c19729de860ea",
  "allowedIps": [
    "61.254.213.0/24",
    "22.46.216.142"
  ],
  "toggleable": true
}

Get an IP policy

Retrieves details for a specific IP policy by policy ID.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories

Path Parameters

  • idstring
    Required

    The IP policy unique identifier

Responses

200

Request successfully completed.

  • application/jsonobject
    Show application/json properties
    • idstring
      RequiredFilterable

      The unique identifier for the IP policy.

      format = "uid"

    • namestring
      RequiredFilterable

      The descriptive name for the IP policy.

    • enabledboolean
      Required

      Indicates whether the IP policy is enabled.

    • editableboolean
      Required

      Indicates whether the IP policy can be updated.

    • tenantIdstring
      RequiredFilterable

      The tenant unique identifier associated with the given IP policy.

      format = "uid"

    • createdAtstring
      RequiredFilterable

      The timestamp for when the IP policy was created.

      format = "date-time"

    • createdBystring
      Required

      The user ID of the user who created the IP policy.

    • deletableboolean
      Required

      Indicates whether the IP policy can be deleted.

    • updatedAtstring
      RequiredFilterable

      The timestamp for when the IP policy was last updated.

      format = "date-time"

    • updatedBystring
      Required

      The user ID of the user who last updated the IP policy.

    • allowedIpsarray of strings
      Required

      An array of allowed public IPv4 addresses.

    • toggleableboolean
      Required

      Indicates whether the IP policy can be enabled/disabled..

401

Unauthorized, JWT is invalid or not provided.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

404

IP Policy ID not found or Invalid format.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

500

Internal Server 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.
GET /api/core/ip-policies/{id} 
// qlik-api has not implemented support for `GET /api/core/ip-policies/{id}` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/core/ip-policies/{id}',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
This API is not included yet in qlik-cli
curl "https://{tenant}.{region}.qlikcloud.com/api/core/ip-policies/{id}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "507f191e810c19729de860ea",
  "name": "Allow access from office IP addresses.",
  "enabled": true,
  "editable": true,
  "tenantId": "644fd58b846d649c82eba436",
  "createdAt": "2021-03-21T17:32:28Z",
  "createdBy": "507f191e810c19729de860ea",
  "deletable": true,
  "updatedAt": "2021-03-22T10:01:02Z",
  "updatedBy": "507f191e810c19729de860ea",
  "allowedIps": [
    "61.254.213.0/24",
    "22.46.216.142"
  ],
  "toggleable": true
}

Update an IP policy

Updates the IP policy. If this is the first enabled policy in the tenant, IP allowlisting will be enabled and access via other IP addresses will be blocked. The user's IP address must be present in at least one policy if allowlisting is enabled. The user must be assigned the TenantAdmin role.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • idstring
    Required

    The unique identifier for the IP policy.

Request Body

Required
  • application/jsonarray of objects

    An array of JSON Patch documents

    Show application/json properties
    • opstring
      Required

      The operation to be performed.

      Can be one of: "replace"

    • pathstring
      Required

      A JSON Pointer.

      Can be one of: "/enabled""/name""/allowedIps"

    • valuestring|boolean|array
      Required

      The value to be used for this operation.

      One of:
      • string
      • boolean
      • array of strings

Responses

204

IP policy updated successfully.

400

Invalid request body.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

401

Unauthorized, JWT is invalid or not provided.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

403

Access Denied.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

404

IP policy ID not found or Invalid format.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

500

Internal server 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.
PATCH /api/core/ip-policies/{id} 
// qlik-api has not implemented support for `PATCH /api/core/ip-policies/{id}` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/core/ip-policies/{id}',
  {
    method: 'PATCH',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify([
      {
        op: 'replace',
        path: '/name',
        value: 'New name',
      },
      {
        op: 'replace',
        path: '/allowedIps',
        value: [
          '61.254.213.0/24',
          '22.46.216.142',
        ],
      },
      {
        op: 'replace',
        path: '/enabled',
        value: true,
      },
    ]),
  },
)
This API is not included yet in qlik-cli
curl "https://{tenant}.{region}.qlikcloud.com/api/core/ip-policies/{id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"New name"},{"op":"replace","path":"/allowedIps","value":["61.254.213.0/24","22.46.216.142"]},{"op":"replace","path":"/enabled","value":true}]'

Delete an IP policy

Deletes an IP policy by ID. If this is the last enabled policy in the tenant, IP allowlisting will be disabled and access will be permitted via all IP addresses. The user's IP address must be present in at least one other policy if allowlisting is enabled. The user must be assigned the TenantAdmin role.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Path Parameters

  • idstring
    Required

    The unique identifier for the IP policy.

Responses

204

IP policy deleted successfully.

401

Unauthorized, JWT is invalid or not provided.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

403

Access Denied.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

404

IP policy ID not found or Invalid format.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.

500

Internal server 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 problem.

      • 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.
    • traceIdstring

      A unique identifier for tracing the error.
DELETE /api/core/ip-policies/{id} 
// qlik-api has not implemented support for `DELETE /api/core/ip-policies/{id}` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/core/ip-policies/{id}',
  {
    method: 'DELETE',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
This API is not included yet in qlik-cli
curl "https://{tenant}.{region}.qlikcloud.com/api/core/ip-policies/{id}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"