Skip to main content
GET
/
api
/
apis
/
{apiID}
/
keys
/
{keyID}
Get key details with API ID and key ID.
curl --request GET \
  --url https://{tenant}/api/apis/{apiID}/keys/{keyID} \
  --header 'Authorization: Bearer <token>'
{
  "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": "<unknown>",
    "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

The Tyk Dashboard API Access Credentials

Path Parameters

​
apiID
string
required

ID of API the keys grant access to. Can either be the internal or external API ID.

​
keyID
string
required

The Key ID.

Query Parameters

​
auto_guess
enum<boolean>
default:false

If you are not sure if a key is hashed you can send this as true.

Available options:
true,
false
​
hashed
string

Use the hash of the key as input instead of the full key.Any none empty string will be interpreted as to say you want to use hash input.

​
username
enum<boolean>

Set to true if the passed key ID is a username.

Available options:
true,
false

Response

Key data fetched.

​
api_model
object
​
data
object
​
key_hash
string
Example:

"41c5cb1e"

​
key_id
string
Example:

"5e9d9544a1dcd60001d0ed20e7f75f9e03534825b7aef9df749582e5"