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 Policies API

Policies are a template that enable you to create access rules, usage quota and rate limits that can be applied to multiple keys. They are a useful way to manage large groups of users, and to enforce quota changes on a global scale across any number of keys that are using a policy. When used in conjunction with the portal, developers that enroll for API access will be given a key that is attached to a specific policy. The policy settings are refreshed every time a key attempts access, meaning that updating a policy will have an effect across any keys that are attached to it.

Tyk Policies 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 Policies. 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 11 operations across 5 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version 5.7.1.

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

11 operations 5 paths 31 schemas 2 DELETE5 GET2 POST2 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 Policies 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 11

Across 5 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Policies 11

Policies are a template that enable you to create access rules, usage quota and rate limits that can be applied to multiple keys. They are a useful way to manage large groups of u…

GET
/api/portal/policies
Get list portal policies.
getPolicies 2 params → 200401403404500
POST
/api/portal/policies
Create policy definition.
postPolicies body → 200400401403500
DELETE
/api/portal/policies/{id}
Delete a single policy by ID.
deletePolicy 1 param → 200400401403404500
GET
/api/portal/policies/{id}
Get a single policy by ID.
getPolicy 1 param → 200400401403404500
PUT
/api/portal/policies/{id}
Update policy definition.
putPolicies 1 param body → 200400401403404500
GET
/api/portal/policies/search
Search list of policies.
searchPolicies 8 params → 200400401403404500
GET
/tyk/policies
Tyk List Policies.
listPolicies → 200403
POST
/tyk/policies
Tyk Create a Policy.
addPolicy body → 200400403500
DELETE
/tyk/policies/{polID}
Tyk Delete a Policy.
deletePolicy 1 param → 200400403500
GET
/tyk/policies/{polID}
Tyk Get a Policy.
getPolicy 1 param → 200403404
PUT
/tyk/policies/{polID}
Tyk Update a Policy.
updatePolicy 1 param body → 200400403500

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are Policy_2 (23 properties), Policy (22 properties), AccessDefinition (11 properties), AccessDefinition_2 (11 properties). Each schema is shown below with its type and property counts.

APILimit
objectnull
11 properties
FieldAccessDefinition
object
3 properties
ReturnDataStruct
object
2 properties
SessionEndpointMethod
object
2 properties
SessionEndpointRateLimit
object
2 properties
AccessDefinition
object
11 properties
Policy
object
22 properties
RateLimitSmoothing
objectnull
5 properties
SessionEndpoint
object
2 properties
GraphqlType
object
2 properties
PolicyList
arraynull
ApiResponse
object
4 properties
FieldLimits
object
1 property
AccessSpec
object
2 properties
APILimit_2
object
10 properties
GraphAccessDefinition
object
EndpointMethods
array
Endpoint
object
2 properties
RateLimitType2
object
3 properties
FieldAccessDefinition_2
object
3 properties
Policy_2
object
23 properties
AccessDefinition_2
object
11 properties
RateLimitSmoothing_2
object
5 properties
ApiModifyKeySuccess
object
4 properties
PolicyPartitions
object
5 properties
GraphqlType_2
object
2 properties
Endpoints
array
ApiStatusMessage
object
2 properties
FieldLimits_2
object
1 property
AccessSpec_2
object
2 properties
EndpointMethod
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tyk-policies-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 Policies 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.