canonical: https://jentic.com/apis/tyk.com/tyk

# Tyk Gateway REST API

tyk.com/main version 1.9. The API exposes 18 endpoints.

## For AI agents

Programmatically access Gateway REST API resources. Covers 18 operations.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Access Gateway REST API resources via REST API
- Manage developer tools data programmatically
- Integrate Gateway REST API into automated workflows
- Query and filter Gateway REST API records by parameters
- Monitor Gateway REST API operational status and events

## Use cases

### Developer Tools Operations

The API provides 18 endpoints for developer tools operations.

Example prompt: Execute a primary operation against the Gateway REST API

### Data Retrieval and Monitoring

Query Gateway REST API resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.

Example prompt: Poll the primary Gateway REST API endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call Gateway REST API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.

Example prompt: Search Jentic for 'gateway rest API', load the operation schema, and execute with Jentic-managed credentials

## Key resources

- **Tyk** — Operations for tyk

## Why Jentic

- **Setup:** Wiring the Tyk Gateway REST API by hand means resolving the gateway host for your deployment, matching each management operation to its request shape, and handling responses yourself. Through Jentic you install once, import the Gateway REST API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Scope your agent to the operations it needs from the Gateway REST API and nothing else. You choose the operations it may call, so management writes are not included unless you add them.
- **Credential handling:** Your Tyk gateway credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'manage the API gateway', and Jentic returns the matching Gateway REST API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Gateway REST API use?

The Gateway REST API uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### What are the rate limits for the Gateway REST API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I use gateway rest API through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'use gateway rest API'. Jentic returns the matching Gateway REST API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Gateway REST API have?

The Gateway REST API exposes 18 endpoints covering tyk operations.

### Does the Gateway REST API support pagination?

Pagination support depends on the specific endpoint. Check the endpoint parameters for page, limit, or offset fields. Through Jentic, the operation schema exposes all available parameters so agents can paginate automatically.

### Can I limit what my agent is allowed to do with the Gateway REST API?

Yes. Because you run Jentic One yourself, you decide which of the Gateway REST API operations your agent may call, and it can reach nothing else. You can grant only the read and query operations it needs while withholding management writes, so the agent never touches gateway configuration unless you explicitly add those operations. The stored Tyk gateway credential is injected at execution time and stays out of the agent's context, so scope is set by your rules rather than by the agent.
