Policies

Get a policy.

Changed on

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

get/tyk/policies/{polID}

Request

  • Base URL
    https://localhost:8080
  • URL
    https://localhost:8080/tyk/policies/{polID}
  • Auth
    API key in header X-Tyk-Authorization

Path parameters

polIDstring required

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

Response

Get details of a single policy.

_idstring
access_rightsobject nullable
activeboolean
enable_http_signature_validationboolean
graphql_access_rightsobject nullable
hmac_enabledboolean
idstring
is_inactiveboolean
key_expires_ininteger
last_updatedstring
max_query_depthinteger
meta_dataobject nullable
namestring
org_idstring
pernumber double
post_expiry_action'retain' | 'delete'

Defines the action to take on a Session in Redis after it expires. Valid values are "retain" and "delete".

post_expiry_grace_periodinteger

Duration in seconds to retain a Session in Redis after it expires. Used with post_expiry_action "retain". Set to -1 to retain indefinitely.

quota_maxinteger
quota_renewal_rateinteger
ratenumber double
tagsstring[] nullable
throttle_intervalnumber double
throttle_retry_limitinteger

Example response

{
  "_id": "5ead7120575961000181867e",
  "active": true,
  "id": "5ead7120575961000181867e",
  "last_updated": "1655965189",
  "max_query_depth": -1,
  "name": "Swagger Petstore Policy",
  "org_id": "5e9d9544a1dcd60001d0ed20",
  "partitions": {
    "acl": true,
    "quota": true,
    "rate_limit": true
  },
  "per": 60,
  "post_expiry_action": "delete",
  "quota_max": -1,
  "quota_renewal_rate": 3600,
  "rate": 1000,
  "throttle_interval": -1,
  "throttle_retry_limit": -1
}

Changes

  • 62fd487c952dRevision changes
    • info

      added the optional property //// to the response with the status

  • dd3336b65081Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status