GET
/
tyk
/
policies
List policies.
curl --request GET \
  --url https://{tenant}/tyk/policies \
  --header 'X-Tyk-Authorization: <api-key>'
[
  {
    "_id": "",
    "access_rights": {
      "8ddd91f3cda9453442c477b06c4e2da4": {
        "allowance_scope": "",
        "allowed_types": [],
        "allowed_urls": [
          {
            "methods": [
              "GET"
            ],
            "url": "/users"
          }
        ],
        "api_id": "8ddd91f3cda9453442c477b06c4e2da4",
        "api_name": "Itachi api",
        "disable_introspection": false,
        "field_access_rights": [],
        "limit": {
          "max_query_depth": 0,
          "per": 0,
          "quota_max": 0,
          "quota_remaining": 0,
          "quota_renewal_rate": 0,
          "quota_renews": 0,
          "rate": 0,
          "smoothing": {
            "delay": 30,
            "enabled": false,
            "step": 100,
            "threshold": 500,
            "trigger": 0.8
          },
          "throttle_interval": 0,
          "throttle_retry_limit": 0
        },
        "restricted_types": [],
        "versions": [
          "Default"
        ]
      }
    },
    "active": true,
    "enable_http_signature_validation": false,
    "graphql_access_rights": null,
    "hmac_enabled": false,
    "id": "5ead7120575961000181867e",
    "is_inactive": false,
    "key_expires_in": 2592000,
    "last_updated": "1716980105",
    "max_query_depth": -1,
    "meta_data": {
      "user_type": "mobile_user"
    },
    "name": "Sample policy",
    "org_id": "664a14650619d40001f1f00f",
    "partitions": {
      "acl": true,
      "complexity": false,
      "per_api": false,
      "quota": true,
      "rate_limit": true
    },
    "per": 60,
    "quota_max": 10000,
    "quota_renewal_rate": 3600,
    "rate": 1000,
    "smoothing": {
      "delay": 30,
      "enabled": false,
      "step": 100,
      "threshold": 500,
      "trigger": 0.8
    },
    "tags": [
      "security"
    ],
    "throttle_interval": 10,
    "throttle_retry_limit": 10
  }
]

Authorizations

​
X-Tyk-Authorization
string
header
required

Api key

Response

List of all policies.

​
_id
string
Example:

"5ead7120575961000181867e"

​
access_rights
object | null
​
active
boolean
Example:

true

​
enable_http_signature_validation
boolean
Example:

false

​
graphql_access_rights
object | null
​
hmac_enabled
boolean
Example:

false

​
id
string
Example:

"5ead7120575961000181867e"

​
is_inactive
boolean
Example:

false

​
key_expires_in
integer
Example:

0

​
last_updated
string
Example:

"1655965189"

​
max_query_depth
integer
Example:

-1

​
meta_data
object | null
​
name
string
Example:

"Swagger Petstore Policy"

​
org_id
string
Example:

"5e9d9544a1dcd60001d0ed20"

​
partitions
object
​
per
number
Example:

60

​
quota_max
integer
Example:

-1

​
quota_renewal_rate
integer
Example:

3600

​
rate
number
Example:

1000

​
smoothing
object | null
​
tags
string[] | null
​
throttle_interval
number
Example:

-1

​
throttle_retry_limit
integer
Example:

-1