canonical: https://jentic.com/apis/rudder.example.local/rudder-example-local

# Rudder Example Rudder API

Download OpenAPI specification: [openapi.yml](openapi.yml) **Other documentation sources**: * [Main documentation](https://docs.rudder.io) * [Internal relay API](https://docs.rudder.io/api/relay/) Introduction Rudder exposes a REST API, enabling the user to interact with Rudder without using the webapp, for example, in scripts or cron jobs. Authentication The Rudder REST API uses simple API keys f. The API exposes 167 endpoints secured with apiKey authentication.

## For AI agents

Programmatically list all change requests, get a zip archive of the requested items and their dependencies. Covers 167 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for identity and authentication only.

## Capabilities

- List all change requests
- Get a ZIP archive of the requested items and their dependencies
- Import a ZIP archive of policies into Rudder
- Update web interface customization
- Reload branding file
- Save a campaign

## Use cases

### Identity and Authentication Operations

Use the Rudder API to perform identity auth operations programmatically. The API provides 167 endpoints covering core functionality including list all change requests, get a zip archive of the requested items and their dependencies, import a zip archive of policies into rudder.

Example prompt: Call GET `/api/changeRequests` to list all change requests

### Automated API Info Management

Automate API info operations by combining multiple Rudder API endpoints. Agents can get a zip archive of the requested items and their dependencies and then import a zip archive of policies into rudder in a single workflow.

Example prompt: Call GET `/archives/export` to get a zip archive of the requested items and their dependencies, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Rudder 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 apiKey tokens manually.

Example prompt: Search Jentic for 'list all change requests', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/changeRequests` | List all change requests |
| GET | `/archives/export` | Get a ZIP archive of the requested items and their dependencies |
| POST | `/archives/import` | Import a ZIP archive of policies into Rudder |
| POST | `/branding` | Update web interface customization |
| GET | `/branding` | Get branding configuration |
| POST | `/branding/reload` | Reload branding file |
| POST | `/campaigns` | Save a campaign |
| GET | `/campaigns` | Get all campaigns details |

## Key resources

- **API Info** — Information about API endpoints and versions
- **Status** — Is alive check
- **Compliance** — Access compliance data
- **Rules** — Rules management
- **Directives** — Directives management

## Why Jentic

- **Setup:** Wiring the Rudder API by hand means passing your key in the X-API-Token header and resolving the {rudderServer} host in the `/rudder/api/latest` base yourself for each request. Through Jentic you install once, import the Rudder API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Rudder puts resource ids in the URL path (for example a change request or an archive item), so a rule can pin your agent to specific resources: it can read change requests and export archives and nothing else. You choose the operations it may call, so importing a policy archive or updating branding is not included unless you add them.
- **Credential handling:** Your Rudder API token 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 'list change requests' or 'export items as a ZIP archive', and Jentic returns the matching Rudder operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Auth0** — Alternative identity auth API
- **Okta** — Alternative identity auth API

## FAQ

### What authentication does the Rudder API use?

The Rudder API uses an API key passed in the `X-API-Token` header. 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.

### Can I list all change requests with the Rudder API?

Yes. Use the GET `/api/changeRequests` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Rudder 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 list all change requests through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list all change requests'. Jentic returns the matching Rudder API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Rudder API have?

The Rudder API exposes 167 endpoints covering API info, status, compliance operations.

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

Yes. Jentic One is self-hosted, so you set the rules that decide which Rudder operations and credentials your agent may use. Because Rudder puts resource ids in the URL path, such as a change request or an archive item, you can pin the agent to specific resources and let it read change requests and export archives while nothing else is permitted. Operations like importing a policy archive or updating branding stay off limits unless you explicitly add them.