How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tyk Keys API

All keys that are used to access services via Tyk correspond to a session object that informs Tyk about the context of this particular token, like access rules and rate/quota allowance.

Tyk Keys API is one of 39 APIs that Tyk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Keys. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, a changelog, and 1 JSON Schema.

This API exposes 22 operations across 13 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 5.7.1.

Requests are made against a single base URL, https://{tenant}.

22 operations 13 paths 37 schemas 3 DELETE8 GET8 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
5.7.1
Base URL
https://tyk.io/
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Tyk Keys API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as X-Tyk-Authorization (api_key).

  • bearerAuth — The Tyk Dashboard API Access Credentials
  • api_key — Api key

Paths & Operations 22

Across 13 paths, the API surfaces 22 operations — 3 DELETE, 8 GET, 8 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Keys 22

All keys that are used to access services via Tyk correspond to a session object that informs Tyk about the context of this particular token, like access rules and rate/quota allo…

GET
/api/apis/{apiID}/keys
List keys by API.
listApiKeys 2 params → 200401403404500
DELETE
/api/apis/{apiID}/keys/{keyID}
Delete key with API ID and key ID.
deleteApiKeyDetail 5 params → 200400401403404500
GET
/api/apis/{apiID}/keys/{keyID}
Get key details with API ID and key ID.
getApiKeyDetail 5 params → 200400401403404
PUT
/api/apis/{apiID}/keys/{keyID}
With API ID and key ID.
updateApiKeyDetail 6 params body → 200400401403404500
GET
/api/apis/{apiId}/keys/search
Search keys by API.
SearchKeys 3 params → 200400401403500
GET
/api/apis/keys
List All the keys.
listKeys 1 param → 200401403500
POST
/api/keys
Create a key.
addKey 1 param body → 200401403500
DELETE
/api/keys/{keyId}
Delete key.
deleteKey 4 params → 200400401403404500
GET
/api/keys/{keyId}
Get key Details.
getKeyDetail 4 params → 200400401403404500
POST
/api/keys/{keyId}
Create custom key.
createCustomKey 1 param body → 200401403500
PUT
/api/keys/{keyId}
Update key.
updateKeyDetail 5 params body → 200400401403404500
GET
/api/keys/detailed
List All the Keys info.
getKeysDetailed 1 param → 200401403404500
POST
/api/keys/preview
This will validate a key definition.
validateAKeyDefinition body → 200400401403500
GET
/tyk/keys
Tyk List Keys.
listKeys → 200403404
POST
/tyk/keys
Tyk Create a Key.
addKey 1 param body → 200400403500
DELETE
/tyk/keys/{keyID}
Tyk Delete a Key.
deleteKey 2 params → 200400403404
GET
/tyk/keys/{keyID}
Tyk Get a Key With Id.
getKey 2 params → 200400403404
POST
/tyk/keys/{keyID}
Tyk Create Custom Key / Import Key
createCustomKey 3 params body → 200400403500
PUT
/tyk/keys/{keyID}
Tyk Update Key.
updateKey 3 params body → 200400403404500
POST
/tyk/keys/create
Tyk Create a Key.
createKey body → 200400403500
POST
/tyk/keys/policy/{keyID}
Tyk Set Policies for a Hashed Key.
setPoliciesToHashedKey 1 param body → 200400403404500
POST
/tyk/keys/preview
Tyk This Will Validate a Key Definition.
validateAKeyDefinition body → 200403500

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are SessionState_2 (38 properties), SessionState (36 properties), AccessDefinition_2 (11 properties), APILimit (11 properties). Each schema is shown below with its type and property counts.

KeysDetailed
object
2 properties
APILimit
objectnull
11 properties
FieldAccessDefinition
object
3 properties
Keys
object
2 properties
SessionState
object
36 properties
SessionEndpointMethod
object
2 properties
SessionEndpointRateLimit
object
2 properties
AccessDefinition
object
11 properties
ApiModel
object
RateLimitSmoothing
objectnull
5 properties
AllKeys
object
1 property
SessionEndpoint
object
2 properties
GraphqlType
object
2 properties
ApiResponse
object
4 properties
FieldLimits
object
1 property
AccessSpec
object
2 properties
KeyData
object
4 properties
APILimit_2
object
10 properties
FieldAccessDefinition_2
object
3 properties
SessionState_2
object
38 properties
ApiModifyKeySuccess
object
4 properties
Endpoint
object
2 properties
ApiAllKeys
object
1 property
AccessDefinition_2
object
11 properties
Monitor
object
1 property
JWTData
object
1 property
GraphqlType_2
object
2 properties
Endpoints
array
BasicAuthData
object
2 properties
ApiStatusMessage
object
2 properties
PolicyUpdateObj
object
2 properties
FieldLimits_2
object
1 property
EndpointMethod
object
2 properties
RateLimitSmoothing_2
object
5 properties
EndpointMethods
array
RateLimitType2
object
3 properties
AccessSpec_2
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tyk-keys-api-openapi.yml Raw ↑

Other APIs Tyk publishes across the network.

Tyk Additional Permissions API
Tyk Analytics API
Tyk APIs API
Tyk Assets API
Tyk AuditLogs API
Tyk Basic Authentication API
Tyk Batch Requests API
Tyk Cache Invalidation API
Tyk Certificates API
Tyk Certs API
Tyk CertsTag API
Tyk Config API
Where this information came from

This is an independent, third-party profile of Tyk Keys API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.