📓

Introduction to Requestly API

Category
Public API

API Client
Overview
Make an API Request
Replay request from History
Import from cURL
FAQ
Security1 & Privacy1
Security & Privacy
File Server
Overview
Create New Mock File
Getting Started
Introduction
Create First Rule
Guides
Modifying response asynchronously
Debug HTTPs requests in iOS Simulator
Know if a rule executed on the page
HTTP Rules (Modify Traffic)
Overview
Redirect URL (Map Local, Map Remote)
Replace Strings (Switch Hosts, API Endpoints)
Modify Headers
Modify Request Body
Modify Response Body
Modify Query Params
Modify Cookies
Modify DOM/Inject scripts
Modify User Agents
Delay Request
Cancel Rule
Organizing Rule
Import/Export Rules from File
Pause/Resume Requestly
Rule Operators
Advance Targeting
Sharing Rules
Map Local
Map Remote
Pinning Rules
GraphQL Support
Edit and Replay
Import Setting from Charles Proxy
Test URL Condition
Test this Rule
Inspect Traffic
Overview
Filtering Traffic
Save Session
View Request/Response Details
Import/ Export Network Sessions
Create Rule while inspecting Traffic
Installation
Browser Extension
Desktop App
Test Path Plan
Mock Server
Overview
Create New Mock API
Test Mock API
Pre-Configured Mocks
New Section
📓
Overview
Public API
📓
Introduction to Requestly API
📓
Endpoints: Rules API
📓
Schema: Rules
Sessions Replay
📓
Configure Pages
📓
Record Session
📓
Save Session
📓
Share Session
📓
Replay Recording
Architecture
Setup
Desktop Browsers
Safari Browser
Android Apps
IOS Apps
NodeJs
Terminal
TroubleShooting
Troubleshooting Safari
Troubleshooting: Untrusted SSL certificate
System Wide Proxy Not Working (macOS)
Rules Not Working
Disable System Wide Proxy (MacOS)
Workspace
Overview
How to get started with Shared Workspace
User Roles
Managing Workspace
Getting Started
Introduction
Create First Rule
Installation
Browser Extension
Desktop App
Test Path Plan
Setup
Safari Browser
Android Apps
IOS Apps
NodeJs
Terminal
Desktop Browsers
Inspect Traffic
Overview
Filtering Traffic
Save Session
View Request/Response Details
Import/ Export Network Sessions
Create Rule while inspecting Traffic
API Client
Overview
Make an API Request
Replay request from History
Import from cURL
HTTP Rules (Modify Traffic)
Overview
Redirect URL (Map Local, Map Remote)
Replace Strings (Switch Hosts, API Endpoints)
Modify Headers
Modify Request Body
Modify Response Body
Modify Query Params
Modify Cookies
Modify DOM/Inject scripts
Modify User Agents
Delay Request
Cancel Rule
Organizing Rule
Import/Export Rules from File
Pause/Resume Requestly
Rule Operators
Advance Targeting
Sharing Rules
Map Local
Map Remote
Pinning Rules
GraphQL Support
Edit and Replay
Import Setting from Charles Proxy
Test URL Condition
Test this Rule
Mock Server
Overview
Create New Mock API
Test Mock API
Pre-Configured Mocks
File Server
Overview
Create New Mock File
Workspace
Overview
How to get started with Shared Workspace
User Roles
Managing Workspace
Public API
📓
Schema: Rules
📓
Endpoints: Rules API
📓
Introduction to Requestly API
Sessions Replay
📓
Configure Pages
📓
Record Session
📓
Save Session
📓
Share Session
📓
Replay Recording
Architecture
FAQ
Security1 & Privacy1
Security & Privacy
Guides
Modifying response asynchronously
Debug HTTPs requests in iOS Simulator
Know if a rule executed on the page
New Section
📓
Overview
TroubleShooting
Troubleshooting Safari
Troubleshooting: Untrusted SSL certificate
System Wide Proxy Not Working (macOS)
Rules Not Working
Disable System Wide Proxy (MacOS)
 

Introduction

The Requestly API endpoints let you integrate Requestly into your CI/CD Pipelines. It allows you to create and work with your rules.
  • You can add, update, delete, and read rules with the API.
  • Programmatically access data stored in your Requestly account
  • Integrate Requestly with your CI/CD workflow.

Example use case

Easily test changes related to a PR without needing a staging environment
Automatically create staging JS bundles on PR creation followed by creating a Requestly Rule programmatically using Requestly API in a team workspace. The user can then name the rule depending on their PR name.

Getting Started

You will need an API key for accessing the endpoints. Each api key is associated to a specific workspace and cannot be used to access the rules of another workspace.
🎁
Requestly API is currently in BETA. Fill this form to get your API key today.

API Playground

Once you have your API key, head over to the playground which makes it very easy to understand how the API works.