Search list of policies.

Search list of policies. If query parameter q is a policy ID it will look for policies that have the given ID. However if q is not a policy ID it will return policies with whose name matches the patten based via q query parameter. If you send a policy ID in query parameter q and also send query parameter policy_ids,only policy_ids will be used for searching.

GET /api/portal/policies/search

Try it

Search list of policies.

cURL

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

200

{
  "Data": [
    {
      "_id": "<string>",
      "access_rights": {},
      "active": true,
      "date_created": "2023-11-07T05:31:56Z",
      "hmac_enabled": true,
      "id": "<string>",
      "is_inactive": true,
      "key_expires_in": 123,
      "last_updated": "<string>",
      "max_query_depth": 123,
      "meta_data": {},
      "name": "<string>",
      "org_id": "<string>",
      "partitions": {
        "acl": true,
        "complexity": true,
        "per_api": true,
        "quota": true,
        "rate_limit": true
      },
      "per": 123,
      "quota_max": 123,
      "quota_renewal_rate": 123,
      "rate": 123,
      "smoothing": {
        "delay": 2,
        "enabled": true,
        "step": 2,
        "threshold": 2,
        "trigger": 1
      },
      "tags": [
        "<string>"
      ],
      "throttle_interval": 123,
      "throttle_retry_limit": 123
    }
  ],
  "Pages": 123
}

Authorizations

Authorization · string · header · required

The Tyk Dashboard API Access Credentials

Query Parameters

q · 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.

p · integer

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

Response

200

application/json

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