Get a single policy by ID.

Get a policy by ID.

GET /api/portal/policies/{id}

Try it

Get a single policy by ID.

cURL

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

200

{
  "_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
}

Authorizations

Authorization · string · header · required

The Tyk Dashboard API Access Credentials

Path Parameters

id · string · required

ID of policy to get.

Response

200

application/json

Policy fetched.

_id · string

access_rights · object

Show child attributes

access_rights. {key} · object

Show child attributes

access_rights.{key}. allowance_scope · string

access_rights.{key}. allowed_types · object[] | null

Show child attributes

access_rights.{key}.allowed_types. fields · string[] | null

access_rights.{key}.allowed_types. name · string

access_rights.{key}. allowed_urls · object[] | null

Show child attributes

access_rights.{key}.allowed_urls. methods · string[] | null

Example:

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

access_rights.{key}.allowed_urls. url · string

Example:

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

access_rights.{key}. api_id · string

Example:

"d1dfc6a927a046c54c0ed470f19757cc"

access_rights.{key}. api_name · string

Example:

"Rate Limit Proxy API"

access_rights.{key}. disable_introspection · boolean

Example:

false

access_rights.{key}. endpoints · object[]

Show child attributes

access_rights.{key}.endpoints. methods · object[]

Show child attributes

access_rights.{key}.endpoints.methods. limit · object

Show child attributes

access_rights.{key}.endpoints.methods.limit. per · integer<int64>

access_rights.{key}.endpoints.methods.limit. rate · integer<int64>

access_rights.{key}.endpoints.methods. name · string

access_rights.{key}.endpoints. path · string

access_rights.{key}. field_access_rights · object[] | null

Show child attributes

access_rights.{key}.field_access_rights. field_name · string

access_rights.{key}.field_access_rights. limits · object

Show child attributes

access_rights.{key}.field_access_rights.limits. max_query_depth · integer

access_rights.{key}.field_access_rights. type_name · string

access_rights.{key}. limit · object

Show child attributes

access_rights.{key}.limit. max_query_depth · integer

access_rights.{key}.limit. per · number<double>

access_rights.{key}.limit. quota_max · integer<int64>

access_rights.{key}.limit. quota_remaining · integer<int64>

access_rights.{key}.limit. quota_renewal_rate · integer<int64>

access_rights.{key}.limit. quota_renews · integer<int64>

access_rights.{key}.limit. rate · number<double>

access_rights.{key}.limit. set_by_policy · boolean

access_rights.{key}.limit. smoothing · object

Show child attributes

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

access_rights.{key}.limit.smoothing. enabled · boolean

Enabled indicates if rate limit smoothing is active.

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

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

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

access_rights.{key}.limit. throttle_interval · number<double>

access_rights.{key}.limit. throttle_retry_limit · integer

access_rights.{key}. restricted_types · object[] | null

Show child attributes

access_rights.{key}.restricted_types. fields · string[] | null

access_rights.{key}.restricted_types. name · string

access_rights.{key}. versions · string[] | null

Example:

["Default", "v2"]

active · boolean

date_created · string<date-time>

hmac_enabled · boolean

id · string

is_inactive · boolean

key_expires_in · integer<int64>

last_updated · string

max_query_depth · integer

meta_data · object

Show child attributes

meta_data. {key} · any

name · string

org_id · string

partitions · object

Show child attributes

partitions. acl · boolean

partitions. complexity · boolean

partitions. per_api · boolean

partitions. quota · boolean

partitions. rate_limit · boolean

per · number<double>

quota_max · integer<int64>

quota_renewal_rate · integer<int64>

rate · number<double>

smoothing · object

Show child attributes

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

smoothing. enabled · boolean

Enabled indicates if rate limit smoothing is active.

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

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

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

tags · string[] | null

throttle_interval · number<double>

throttle_retry_limit · integer