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 Open Policy Agent API

The Tyk Dashboard permission system can be extended by writing custom rules using an Open Policy Agent (OPA). The rules engine works on top of your Dashboard API, which means you can control not only access rules, but also behaviour of all Dashboard APIs (except your public developer portal) By default the Dashboard OPA engine is turned off, and you need to explicitly enable it via your Dashboard tyk_analytics.conf file. You can use OPA rule to accomplish tasks like: 1. Prevent users from creating keyless APIs.2. Assign specific categories to APIs created to certain user groups or users.3. Control access for individual fields. For example, do not allow changing the API active status (e.g. deploy), unless you have a specific permission set.4. And many more [Read more about Tyk Open Policy Agent here](https://tyk.io/docs/tyk-dashboard/open-policy-agent/)

Tyk Open Policy Agent 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 Open Policy Agent. 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 2 operations across 1 path, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version 5.7.1.

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

2 operations 1 paths 2 schemas 1 GET1 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
Resource Areas
1

Authentication & Security 1

Tyk Open Policy Agent API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — The Tyk Dashboard API Access Credentials

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Open Policy Agent 2

The Tyk Dashboard permission system can be extended by writing custom rules using an Open Policy Agent (OPA). The rules engine works on top of your Dashboard API, which means you…

GET
/api/org/opa
List OPA rules.
getOPARules → 200401403500
PUT
/api/org/opa
Update OPA rules.
updateOrgOPARules body → 200400401403500

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ApiResponse (4 properties), NewOPARules (1 property). Each schema is shown below with its type and property counts.

NewOPARules
object
1 property
ApiResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tyk-open-policy-agent-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 Open Policy Agent 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.