Skip to main content
POST
/
api
/
keys
/
preview
This will validate a key definition.
curl --request POST \
  --url https://{tenant}/api/keys/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "alias": "portal-key",
  "allowance": 1000,
  "apply_policies": [
    "62a0ec9092faf50001395817"
  ],
  "enable_detailed_recording": true,
  "expires": 1718439136,
  "hmac_enabled": false,
  "is_inactive": false,
  "meta_data": {
    "tyk_developer_id": "62b3fb9a1d5e4f00017226f5"
  },
  "org_id": "5e9d9544a1dcd60001d0ed20",
  "per": 60,
  "quota_max": -1,
  "quota_remaining": 0,
  "quota_renewal_rate": -1,
  "quota_renews": 1715847135,
  "rate": 1000,
  "tags": [
    "edge-eu",
    "edge"
  ],
  "throttle_interval": 0,
  "throttle_retry_limit": 0
}'
{
  "api_model": {},
  "data": {
    "access_rights": {},
    "alias": "portal-developer@example.org",
    "allowance": 1000,
    "apply_policies": [
      "641c15dd0fffb800010197bf",
      "615d2e528bf3980001c7c6c2"
    ],
    "apply_policy_id": "641c15dd0fffb800010197bf",
    "basic_auth_data": {
      "hash_type": "bcrypt",
      "password": "testuse1",
      "user": "admin-user@example.org"
    },
    "certificate": "<string>",
    "data_expires": 0,
    "date_created": "2024-05-14T13:15:46.560506+03:00",
    "enable_detailed_recording": true,
    "expires": 1716895221,
    "hmac_enabled": false,
    "hmac_string": "<string>",
    "id_extractor_deadline": 0,
    "is_inactive": true,
    "jwt_data": {
      "secret": "<string>"
    },
    "key_id": "<string>",
    "last_check": 0,
    "last_updated": "1715681746",
    "max_query_depth": 5,
    "meta_data": "<any>",
    "monitor": {
      "trigger_limits": [
        80,
        60,
        50
      ]
    },
    "oauth_client_id": "<string>",
    "oauth_keys": {},
    "org_id": "5e9d9544a1dcd60001d0ed20",
    "per": 60,
    "quota_max": 1710302205,
    "quota_remaining": 20000,
    "quota_renewal_rate": -1,
    "quota_renews": 1715681745,
    "rate": 1000,
    "session_lifetime": 0,
    "smoothing": {
      "delay": 2,
      "enabled": true,
      "step": 2,
      "threshold": 2,
      "trigger": 1
    },
    "tags": [
      "edge",
      "edge-eu"
    ],
    "throttle_interval": 10,
    "throttle_retry_limit": -1
  },
  "key_hash": "41c5cb1e",
  "key_id": "5e9d9544a1dcd60001d0ed20e7f75f9e03534825b7aef9df749582e5"
}

Authorizations

​
Authorization
string
header
required

Body

application/json
​
access_rights
object | null
​
alias
string
Example:
​
allowance
number
Example:
​
apply_policies
string[] | null
Example:
​
apply_policy_id
string
deprecated
Example:
​
basic_auth_data
object
​
certificate
string
​
data_expires
integer
Example:
​
date_created
string<date-time>
Example:
​
enable_detailed_recording
boolean
Example:
​
expires
integer
Example:
​
hmac_enabled
boolean
Example:
​
hmac_string
string
​
id_extractor_deadline
integer
Example:
​
is_inactive
boolean
​
jwt_data
object
​
key_id
string
​
last_check
integer
Example:
​
last_updated
string
Example:
​
max_query_depth
integer
Example:
​
meta_data
any
​
monitor
object
​
oauth_client_id
string
​
oauth_keys
object | null
​
org_id
string
Example:
​
per
number
Example:
​
quota_max
integer
Example:
​
quota_remaining
integer
Example:
​
quota_renewal_rate
integer
Example:
​
quota_renews
integer
Example:
​
rate
number
Example:
​
session_lifetime
integer
Example:
​
smoothing
object | null
​
tags
string[] | null
Example:
​
throttle_interval
number
Example:
​
throttle_retry_limit
integer
Example:

Response

​
api_model
object
​
data
object
​
key_hash
string
Example:
​
key_id
string
Example: