Learn how to create and manage proxies that connect your applications to target APIs

Proxies

A Proxy in RequestRocket is a service that sits between your application and a target API service. It manages the routing, authentication, and transformation of requests between your application and the target API.

Understanding Proxies

Each proxy configuration requires three main components:

Proxy Credential: The credential your application uses to authenticate with the proxy
Target: The destination API service you want to connect to
Target Credential: The credential used to authenticate with the target service

Using Your Proxy

Once your proxy is configured, you can start making requests:

Ensure Proxy is Active

Set the proxy status to "Active" in the dashboard.

Copy the Base URL

The Base URL is provided in the proxy details after creation.

Make Requests

Make requests to the Base URL using your proxy credential to authenticate.

Request Flow

The proxy will:

Authenticate your request using the proxy credential
Apply any authorization rules
Forward the request to the target using the target credential
Return the target's response to your application

The format of your proxy Base URL varies based on the region and proxy credential type. It will look something like: https://{region}.requestrocket.io/api/{proxyId}

Creating Proxies

To create a new proxy:

Navigate to Proxies

Go to the Proxies section in the RequestRocket dashboard.

Create New Proxy

Click the "Create" button.

Configure General Settings

Proxy Name: Choose a descriptive name for your proxy.

Examples:

customer-api-production
payment-gateway-staging
internal-auth-dev

Active Status: Toggle to enable or disable the proxy.

Active: The proxy will process requests
Inactive: The proxy will not process requests (useful for maintenance)

Configure Fixed Settings

Region: Select the region where the proxy will be deployed.

Once set, the region cannot be changed. All components (credentials and target) must be in the same region.

After creation, you'll receive a Base URL that your application will use to make requests.

Configure Proxy Settings

Proxy Credential: Select the credential your application will use to authenticate with the proxy.

Must be a proxy-type credential
Must be in the same region as the proxy
Click "New" to create a new proxy credential if needed

Target: Select the target API service.

Must be configured in the same region as the proxy
Click "New" to create a new target if needed

Target Credential: Select the credential for authenticating with the target.

Must be a target-type credential
Must be in the same region as the proxy
Click "New" to create a new target credential if needed

Save Proxy

Click "Save" to create the proxy and generate your Base URL.

Making Requests to Your Proxy

Proxy API (Synchronous)

For immediate, synchronous responses:

curl -X GET "https://{Your_Proxy_Base_URL}/{target_path}" \
  -H "Content-Type: application/json" \
  -H "Authorization: {Your_Proxy_Credential}"

Async API

For asynchronous processing with retry:

curl -X POST "https://{Your_Async_Base_URL}/{target_path}" \
  -H "Content-Type: application/json" \
  -H "Authorization: {Your_Proxy_Credential}" \
  -d '{"your": "payload"}'

Learn more about API endpoints →

Understanding Response Headers

RequestRocket adds these headers to all proxy responses:

requestrocket-proxy-code

Values:

proxy-access-granted: Proxy authentication successful
proxy-access-denied: Proxy authentication failed

requestrocket-proxy-message

Provides a description of the proxy code.

If you see proxy-access-granted but still get an error response, the problem is NOT with the proxy credential. Check:

The target URL is correct
Your request format is valid for the target API
Your target credential is correct

Error Response Analysis

proxy-access-denied + Error Response:

Issue: Proxy credential is invalid or incorrect proxyId
Solution: Verify your proxy credential and proxy URL

proxy-access-granted + Error Response:

Issue: Target URL, request format, or target credential
Solution: Check target configuration and credentials

500 Error without headers:

Issue: Internal RequestRocket error
Solution: Contact support immediately

Important Notes

Regional Constraints

All components of a proxy must be in the same region:

Proxy credential
Target credential
Target
Proxy itself

Consider your application's geographic requirements when selecting a region. Create multiple proxies in different regions if needed for global coverage.