canonical: https://jentic.com/apis/rudder.io/rudder

# Rudder API

Rudder is an IT infrastructure automation and compliance platform. This API provides endpoints for managing nodes, rules, directives, groups, compliance, and system settings. The API exposes 28 endpoints secured with apiKey authentication.

## For AI agents

Programmatically list all available API endpoints, check if rudder is running. Covers 28 operations with apiKey authentication.

## Scope

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

## Capabilities

- List all available API endpoints
- Check if Rudder is running
- Create a new rule
- Update a rule
- Get rule details
- Delete a rule

## Use cases

### Security Operations

Use the Rudder API to perform security operations programmatically. The API provides 28 endpoints covering core functionality including list all available API endpoints, check if rudder is running, list all rules.

Example prompt: Call GET /info to list all available API endpoints

### Automated Compliance Management

Automate compliance operations by combining multiple Rudder API endpoints. Agents can check if rudder is running and then list all rules in a single workflow.

Example prompt: Call GET /status to check if rudder is running, 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 available API endpoints', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/info` | List all available API endpoints |
| GET | `/status` | Check if Rudder is running |
| GET | `/rules` | List all rules |
| PUT | `/rules` | Create a new rule |
| POST | `/rules/{id}` | Update a rule |
| GET | `/rules/{id}` | Get rule details |
| DELETE | `/rules/{id}` | Delete a rule |
| GET | `/directives` | List all directives |

## Key resources

- **Compliance** — Operations for compliance
- **Directives** — Operations for directives
- **Groups** — Operations for groups
- **Info** — Operations for info
- **Nodes** — Operations for nodes

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 64 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 85 / 100
  - Developer Experience & Jentic Compatibility: 62 / 100
  - AI-Readiness & Agent Experience: 52 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 57 / 100
- **View full report:** https://jentic.com/apis/rudder.io/rudder/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## 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 rules and directives call. 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 the rule id in the URL path (`/rules/{id}`), so a rule can pin your agent to one rule: it can read and update that rule and nothing else. You choose the operations it may call, so rule deletion is not included unless you add it.
- **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 all rules' or 'check if Rudder is running', 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

- **Snyk** — Alternative security API
- **Crowdstrike** — Alternative security 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 available API endpoints with the Rudder API?

Yes. Use the GET /info 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 available API endpoints through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list all available API endpoints'. 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 28 endpoints covering compliance, directives, groups operations.

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

Yes. Because Jentic One is self-hosted, your own rules decide which Rudder operations the agent may call and which credentials it may use. Since Rudder puts the rule id in the URL path (`/rules/{id}`), you can pin the agent to a single rule so it only reads and updates that one rule and touches nothing else. You choose the operations it can run, so a destructive call like DELETE `/rules/{id}` is excluded unless you explicitly add it.