> ## Documentation Index
> Fetch the complete documentation index at: https://docs.requestly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Welcome to the Requestly Interceptor API documentation! 

***

The Requestly Interceptor API empowers you to automate and streamline rule management and integrations within your workflows. Whether you're enhancing CI/CD pipelines or programmatically managing rules, the API offers robust capabilities to meet your needs.

## What Can You Do with the Requestly Interceptor API?

**Rule Management**: Create, update, delete, and retrieve rules such as Redirects, Replace Rules, Modify Headers, and more.

**CI/CD Integration**: Seamlessly integrate rule management into your CI/CD pipelines for automated deployments and updates.

**Data Access**: Fetch and utilize data stored in your Requestly Interceptor account for analytics and reporting.

**Custom Workflows**: Build custom solutions leveraging the API's endpoints to suit unique business requirements.

***

## Getting Started

<Steps>
  <Step title="Request an API Key">
    The API is currently in **BETA**. To access it, you need an API key:

    * Each API key is linked to a specific workspace.

    * API keys cannot access rules or data outside the associated workspace.

    Request your API key by filling out a <a target="_blank" href="https://app.formbricks.com/s/clryn62s316gjdeho9j03t7oa">simple form</a>. Our team will review your request and provide access shortly.
  </Step>

  <Step title="Authentication">
    Use your API key to authenticate API requests. Include the key in the header of every request:

    ```jsx theme={null}
    x-api-key: <API-KEY>
    ```
  </Step>
</Steps>

### Explore the Playground

The <a target="_blank" href="https://requestly.readme.io/reference/intro/getting-started">API Playground</a> allows you to interact with different endpoints while gaining a deeper understanding of API behavior through real-time feedback.

***

## API Structure and Usage

The Requestly Interceptor API is designed with simplicity and scalability, offering a structured rule and group management approach. Here’s a detailed breakdown of its organization and capabilities

### **Rule Management**

The core functionality of the API revolves around rule management. With these endpoints, you can programmatically manage every aspect of your rules:

* <a target="_blank" href="/http-interception/public-apis/create-rule">**Create Rules**</a>: Add rules for Redirects, Replace Operations, Headers Modifications, Query Parameters, User-Agent Changes, Delays, and more.

* <a target="_blank" href="/http-interception/public-apis/update-rule">**Update Rules**</a>: Modify existing rules to reflect new requirements or changes.

* [**Retrieve Rules**](/http-interception/public-apis/get-rule) :

  * Fetch all rules in your workspace.

  * Retrieve specific rules using unique identifiers.

* [**Delete Rules**](/http-interception/public-apis/delete-rule): Remove outdated or unused rules to keep your workspace organized.

### **Groups Management**

Efficiently organize your rules by creating and managing groups. The following endpoints are available:

* [**Create a Group**](/http-interception/public-apis/create-group): Define new groups to categorize rules.

* [**Retrieve Groups**](/http-interception/public-apis/get-group): Fetch a list of all groups in your workspace.

* [**Update Group Details**](/http-interception/public-apis/update-existing-groups): Modify the properties of an existing group.

* [**Delete a Group**](/http-interception/public-apis/delete-group): Remove groups that are no longer needed.