Search list of policies.

curl --request GET \
  --url https://{tenant}/api/portal/policies/search \
  --header 'Authorization: Bearer <token>'

{
  "Data": [
    {
      "_id": "363635373039383964393864643030303031646131376631",
      "access_rights": {
        "8ddd91f3cda9453442c477b06c4e2da4": {
          "allowance_scope": "",
          "allowed_types": [],
          "allowed_urls": [
            {
              "methods": [
                "GET"
              ],
              "url": "/users"
            }
          ],
          "api_id": "8ddd91f3cda9453442c477b06c4e2da4",
          "api_name": "Itachi API",
          "disable_introspection": false,
          "field_access_rights": [],
          "limit": {
            "max_query_depth": 0,
            "per": 0,
            "quota_max": 0,
            "quota_remaining": 0,
            "quota_renewal_rate": 0,
            "quota_renews": 0,
            "rate": 0,
            "set_by_policy": false,
            "smoothing": {
              "delay": 30,
              "enabled": false,
              "step": 100,
              "threshold": 500,
              "trigger": 0.8
            },
            "throttle_interval": 0,
            "throttle_retry_limit": 0
          },
          "restricted_types": [],
          "versions": [
            "Default"
          ]
        }
      },
      "active": true,
      "date_created": "2024-05-27T10:24:31.099Z",
      "hmac_enabled": false,
      "id": "",
      "is_inactive": false,
      "key_expires_in": 2592000,
      "last_updated": "1716980105",
      "max_query_depth": -1,
      "meta_data": {
        "user_type": "mobile_user"
      },
      "name": "Sample policy",
      "org_id": "664a14650619d40001f1f00f",
      "partitions": {
        "acl": true,
        "complexity": false,
        "per_api": false,
        "quota": true,
        "rate_limit": true
      },
      "per": 60,
      "quota_max": 10000,
      "quota_renewal_rate": 3600,
      "rate": 1000,
      "smoothing": {
        "delay": 30,
        "enabled": false,
        "step": 100,
        "threshold": 500,
        "trigger": 0.8
      },
      "tags": [
        "security"
      ],
      "throttle_interval": 10,
      "throttle_retry_limit": 10
    }
  ],
  "Pages": 1
}

GET

api

portal

policies

Search list of policies.

curl --request GET \
  --url https://{tenant}/api/portal/policies/search \
  --header 'Authorization: Bearer <token>'

{
  "Data": [
    {
      "_id": "363635373039383964393864643030303031646131376631",
      "access_rights": {
        "8ddd91f3cda9453442c477b06c4e2da4": {
          "allowance_scope": "",
          "allowed_types": [],
          "allowed_urls": [
            {
              "methods": [
                "GET"
              ],
              "url": "/users"
            }
          ],
          "api_id": "8ddd91f3cda9453442c477b06c4e2da4",
          "api_name": "Itachi API",
          "disable_introspection": false,
          "field_access_rights": [],
          "limit": {
            "max_query_depth": 0,
            "per": 0,
            "quota_max": 0,
            "quota_remaining": 0,
            "quota_renewal_rate": 0,
            "quota_renews": 0,
            "rate": 0,
            "set_by_policy": false,
            "smoothing": {
              "delay": 30,
              "enabled": false,
              "step": 100,
              "threshold": 500,
              "trigger": 0.8
            },
            "throttle_interval": 0,
            "throttle_retry_limit": 0
          },
          "restricted_types": [],
          "versions": [
            "Default"
          ]
        }
      },
      "active": true,
      "date_created": "2024-05-27T10:24:31.099Z",
      "hmac_enabled": false,
      "id": "",
      "is_inactive": false,
      "key_expires_in": 2592000,
      "last_updated": "1716980105",
      "max_query_depth": -1,
      "meta_data": {
        "user_type": "mobile_user"
      },
      "name": "Sample policy",
      "org_id": "664a14650619d40001f1f00f",
      "partitions": {
        "acl": true,
        "complexity": false,
        "per_api": false,
        "quota": true,
        "rate_limit": true
      },
      "per": 60,
      "quota_max": 10000,
      "quota_renewal_rate": 3600,
      "rate": 1000,
      "smoothing": {
        "delay": 30,
        "enabled": false,
        "step": 100,
        "threshold": 500,
        "trigger": 0.8
      },
      "tags": [
        "security"
      ],
      "throttle_interval": 10,
      "throttle_retry_limit": 10
    }
  ],
  "Pages": 1
}

Authorizations

Authorization

string

header

required

The Tyk Dashboard API Access Credentials

Query Parameters

string

Search for policy using policy ID or name.

policy_ids

string

A list of comma separated policy IDs that you want to search for.

active

string

Send any value in this query parameter to return only the active policies.

state

enum<string>

Return policies whose state field matches the sent value e.g if you send state as deny policies returned are those whose state filed value is set as deny.

Available options:

deny,

active,

draft

sort

enum<string>

Field you want to use to sort the returned policies.

Available options:

date_created,

name,

state

api_id

string

Comma separate list of API IDs. Return only policy that that have the given API IDs in their access_right.

auth_type

string

Return policy whose auth_type field has the given value.

integer

Use p query parameter to say which page you want returned. Send number less than 0 to return all items.

Response

List of policies.

Data

object[] | null

Show child attributes

Data._id

string

Data.access_rights

object

Show child attributes

Data.access_rights.{key}

object

Show child attributes

Data.access_rights.{key}.allowance_scope

string

Data.access_rights.{key}.allowed_types

object[] | null

Show child attributes

Data.access_rights.{key}.allowed_types.fields

string[] | null

Data.access_rights.{key}.allowed_types.name

string

Data.access_rights.{key}.allowed_urls

object[] | null

Show child attributes

Data.access_rights.{key}.allowed_urls.methods

string[] | null

Example:

["GET", "PATCH", "HEAD", "PUT", "DELETE"]

Data.access_rights.{key}.allowed_urls.url

string

Example:

"anything/rate-limit-1-per-5"

Data.access_rights.{key}.api_id

string

Example:

"d1dfc6a927a046c54c0ed470f19757cc"

Data.access_rights.{key}.api_name

string

Example:

"Rate Limit Proxy API"

Data.access_rights.{key}.disable_introspection

boolean

Example:

false

Data.access_rights.{key}.endpoints

object[]

Show child attributes

Data.access_rights.{key}.endpoints.methods

object[]

Show child attributes

Data.access_rights.{key}.endpoints.methods.limit

object

Show child attributes

Data.access_rights.{key}.endpoints.methods.limit.per

integer<int64>

Data.access_rights.{key}.endpoints.methods.limit.rate

integer<int64>

Data.access_rights.{key}.endpoints.methods.name

string

Data.access_rights.{key}.endpoints.path

string

Data.access_rights.{key}.field_access_rights

object[] | null

Show child attributes

Data.access_rights.{key}.field_access_rights.field_name

string

Data.access_rights.{key}.field_access_rights.limits

object

Show child attributes

Data.access_rights.{key}.field_access_rights.limits.max_query_depth

integer

Data.access_rights.{key}.field_access_rights.type_name

string

Data.access_rights.{key}.limit

object

Show child attributes

Data.access_rights.{key}.limit.max_query_depth

integer

Data.access_rights.{key}.limit.per

number<double>

Data.access_rights.{key}.limit.quota_max

integer<int64>

Data.access_rights.{key}.limit.quota_remaining

integer<int64>

Data.access_rights.{key}.limit.quota_renewal_rate

integer<int64>

Data.access_rights.{key}.limit.quota_renews

integer<int64>

Data.access_rights.{key}.limit.rate

number<double>

Data.access_rights.{key}.limit.set_by_policy

boolean

Data.access_rights.{key}.limit.smoothing

object

Show child attributes

Data.access_rights.{key}.limit.smoothing.delay

integer<int64>

Delay is a hold-off between smoothing events and controls how frequently the current allowance will step up or down (in seconds).

Required range: x >= 1

Data.access_rights.{key}.limit.smoothing.enabled

boolean

Enabled indicates if rate limit smoothing is active.

Data.access_rights.{key}.limit.smoothing.step

integer<int64>

Step is the increment by which the current allowance will be increased or decreased each time a smoothing event is emitted.

Required range: x >= 1

Data.access_rights.{key}.limit.smoothing.threshold

integer<int64>

Threshold is the initial rate limit beyond which smoothing will be applied. It is a count of requests during the per interval and should be less than the maximum configured rate.

Required range: x >= 1

Data.access_rights.{key}.limit.smoothing.trigger

number<double>

Trigger is a fraction (typically in the range 0.1-1.0) of the step at which point a smoothing event will be emitted as the request rate approaches the current allowance.

Required range: x >= 0Must be a multiple of 0.01

Data.access_rights.{key}.limit.throttle_interval

number<double>

Data.access_rights.{key}.limit.throttle_retry_limit

integer

Data.access_rights.{key}.restricted_types

object[] | null

Show child attributes

Data.access_rights.{key}.restricted_types.fields

string[] | null

Data.access_rights.{key}.restricted_types.name

string

Data.access_rights.{key}.versions

string[] | null

Example:

["Default", "v2"]

Data.active

boolean

Data.date_created

string<date-time>

Data.hmac_enabled

boolean

Data.id

string

Data.is_inactive

boolean

Data.key_expires_in

integer<int64>

Data.last_updated

string

Data.max_query_depth

integer

Data.meta_data

object

Show child attributes

Data.meta_data.{key}

any

Data.name

string

Data.org_id

string

Data.partitions

object

Show child attributes

Data.partitions.acl

boolean

Data.partitions.complexity

boolean

Data.partitions.per_api

boolean

Data.partitions.quota

boolean

Data.partitions.rate_limit

boolean

Data.per

number<double>

Data.quota_max

integer<int64>

Data.quota_renewal_rate

integer<int64>

Data.rate

number<double>

Data.smoothing

object

Show child attributes

Data.smoothing.delay

integer<int64>

Delay is a hold-off between smoothing events and controls how frequently the current allowance will step up or down (in seconds).

Required range: x >= 1

Data.smoothing.enabled

boolean

Enabled indicates if rate limit smoothing is active.

Data.smoothing.step

integer<int64>

Step is the increment by which the current allowance will be increased or decreased each time a smoothing event is emitted.

Required range: x >= 1

Data.smoothing.threshold

integer<int64>

Threshold is the initial rate limit beyond which smoothing will be applied. It is a count of requests during the per interval and should be less than the maximum configured rate.

Required range: x >= 1

Data.smoothing.trigger

number<double>

Trigger is a fraction (typically in the range 0.1-1.0) of the step at which point a smoothing event will be emitted as the request rate approaches the current allowance.

Required range: x >= 0Must be a multiple of 0.01

Data.tags

string[] | null

Data.throttle_interval

number<double>

Data.throttle_retry_limit

integer

Pages

integer

Delete a single policy by ID.Get API definition OAS schema.

⌘I

Overview

Getting Started

Deploy Tyk

Managing APIs

Security in Tyk

Reference

Developer Support

Search list of policies.

Authorizations

Query Parameters

Response