The Requestly 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 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 account for analytics and reporting.
Custom Workflows: Build custom solutions leveraging the API's endpoints to suit unique business requirements.
Getting Started
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 simple form. Our team will review your request and provide access shortly.
Authentication
Use your API key to authenticate API requests. Include the key in the header of every request:
x-api-key: <API-KEY>
Explore the Playground
The API Playground 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 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:
-
Create Rules: Add rules for Redirects, Replace Operations, Headers Modifications, Query Parameters, User-Agent Changes, Delays, and more.
-
Update Rules: Modify existing rules to reflect new requirements or changes.
-
-
Fetch all rules in your workspace.
-
Retrieve specific rules using unique identifiers.
-
-
Delete Rules: 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: Define new groups to categorize rules.
-
Retrieve Groups: Fetch a list of all groups in your workspace.
-
Update Group Details: Modify the properties of an existing group.
-
Delete a Group: Remove groups that are no longer needed.