Get a policy.

You can retrieve details of a single policy by ID in your Tyk instance.

GET /tyk/policies/{polID}

Try it

Get a policy.

cURL

curl --request GET \
  --url https://{tenant}/tyk/policies/{polID} \
  --header 'X-Tyk-Authorization: <api-key>'

200

{
  "_id": "5ead7120575961000181867e",
  "access_rights": {},
  "active": true,
  "enable_http_signature_validation": false,
  "graphql_access_rights": {},
  "hmac_enabled": false,
  "id": "5ead7120575961000181867e",
  "is_inactive": false,
  "key_expires_in": 0,
  "last_updated": "1655965189",
  "max_query_depth": -1,
  "meta_data": {},
  "name": "Swagger Petstore Policy",
  "org_id": "5e9d9544a1dcd60001d0ed20",
  "partitions": {
    "acl": true,
    "complexity": false,
    "per_api": false,
    "quota": true,
    "rate_limit": true
  },
  "per": 60,
  "quota_max": -1,
  "quota_renewal_rate": 3600,
  "rate": 1000,
  "smoothing": {
    "delay": 123,
    "enabled": true,
    "step": 123,
    "threshold": 123,
    "trigger": 123
  },
  "tags": [
    "<string>"
  ],
  "throttle_interval": -1,
  "throttle_retry_limit": -1
}

Authorizations

X-Tyk-Authorization · string · header · required

Api key

Path Parameters

polID · string · required

You can retrieve details of a single policy by ID in your Tyk instance.

Response

200

application/json

Get details of a single policy.

_id · string

Example:

"5ead7120575961000181867e"

access_rights · object

Show child attributes

access_rights. {key} · object

Show child attributes

access_rights.{key}. allowance_scope · string

Example:

"d371b83b249845a2497ab9a947fd6210"

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", "POST", "DELETE", "PUT"]

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 · number

access_rights.{key}.endpoints.methods.limit. rate · number

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

Show child attributes

access_rights.{key}.endpoints.methods.limit.smoothing. delay · integer

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

access_rights.{key}.endpoints.methods.limit.smoothing. step · integer

access_rights.{key}.endpoints.methods.limit.smoothing. threshold · integer

access_rights.{key}.endpoints.methods.limit.smoothing. trigger · number

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

access_rights.{key}.limit. quota_max · integer

access_rights.{key}.limit. quota_remaining · integer

access_rights.{key}.limit. quota_renewal_rate · integer

access_rights.{key}.limit. quota_renews · integer

access_rights.{key}.limit. rate · number

access_rights.{key}.limit. smoothing · object

Show child attributes

access_rights.{key}.limit.smoothing. delay · integer

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

access_rights.{key}.limit.smoothing. step · integer

access_rights.{key}.limit.smoothing. threshold · integer

access_rights.{key}.limit.smoothing. trigger · number

access_rights.{key}.limit. throttle_interval · number

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

Example:

true

enable_http_signature_validation · boolean

Example:

false

graphql_access_rights · object

Show child attributes

graphql_access_rights. {key} · object

hmac_enabled · boolean

Example:

false

id · string

Example:

"5ead7120575961000181867e"

is_inactive · boolean

Example:

false

key_expires_in · integer<int64>

Example:

0

last_updated · string

Example:

"1655965189"

max_query_depth · integer

Example:

-1

meta_data · object

Show child attributes

meta_data. {key} · any

name · string

Example:

"Swagger Petstore Policy"

org_id · string

Example:

"5e9d9544a1dcd60001d0ed20"

partitions · object

Show child attributes

partitions. acl · boolean

Example:

true

partitions. complexity · boolean

Example:

false

partitions. per_api · boolean

Example:

false

partitions. quota · boolean

Example:

true

partitions. rate_limit · boolean

Example:

true

per · number<double>

Example:

60

quota_max · integer<int64>

Example:

-1

quota_renewal_rate · integer<int64>

Example:

3600

rate · number<double>

Example:

1000

smoothing · object

Show child attributes

smoothing. delay · integer

smoothing. enabled · boolean

smoothing. step · integer

smoothing. threshold · integer

smoothing. trigger · number

tags · string[] | null

throttle_interval · number<double>

Example:

-1

throttle_retry_limit · integer

Example:

-1