Skip to main content
GET
Get a single policy by ID.

Authorizations

Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Path Parameters

id
string
required

ID of policy to get.

Response

Policy fetched.

_id
string
access_rights
object | null
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 | null
name
string
org_id
string
partitions
object
per
number<double>
post_expiry_action
enum<string>

Defines the action to take on a Session in Redis after it expires. Valid values are "retain" and "delete", leave empty for legacy session lifetime controls.

Available options:
,
retain,
delete
Example:

"delete"

post_expiry_grace_period
integer<int64>

Duration in seconds to retain a Session in Redis after it expires. Used with post_expiry_action "retain". Set to -1 to retain indefinitely. Set to 0 to use legacy session lifetime controls.

Example:

0

quota_max
integer<int64>
quota_renewal_rate
integer<int64>
rate
number<double>
smoothing
object | null
tags
string[] | null
throttle_interval
number<double>
throttle_retry_limit
integer