API Reference

RequestRocket provides three types of APIs to meet different integration needs:

API Types Overview

Quick Comparison

Proxy API

The Proxy API allows you to make authenticated requests to target APIs through your configured proxies. Each request is processed synchronously with immediate response.

Key Features

• Multiple Auth Methods: API Key, Bearer Token, JWT, Basic Auth, OAuth2
• Regional Endpoints: Deploy in multiple AWS regions
• Response Headers: Custom headers indicate proxy authentication status
• Real-time Processing: Immediate responses for interactive applications

Endpoint Format

https://{region_specific_baseURL}/api/{proxyId}/{your_target_path}

Example Request

curl -X GET "https://us-east-1.requestrocket.com/api/{proxyId}/users" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {your_proxy_credential}"

View detailed Proxy API documentation →

Async API

The Async API provides queue-based processing with intelligent retry logic. Submit requests and let RequestRocket handle retries automatically.

Key Features

• Intelligent Retry: Up to 10 retries over 15 minutes
• Exponential Backoff: Smart retry timing with jitter
• Request Tracking: Get request IDs to monitor status
• Error Handling: Automatic retry on transient errors

Endpoint Format

https://{region_specific_baseURL}/async/{proxyId}/{your_target_path}

Example Request

curl -X POST "https://us-east-1.requestrocket.com/async/{proxyId}/webhooks" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {your_proxy_credential}" \
  -d '{"event": "user.created", "data": {...}}'

Example Response

{
  "status": "queued",
  "requestId": "550e8400-e29b-41d4-a716-446655440000",
  "message": "Your request has been queued for processing."
}

View detailed Async API documentation →

Core API

The Core API allows you to programmatically manage all RequestRocket resources including clients (organisations), credentials, targets, proxies, and more.

Key Features

• Complete Resource Management: CRUD operations for all resources
• User Authentication: Uses personal user tokens (prefixed with u-)
• RESTful Design: Standard HTTP methods and status codes
• Comprehensive Access: Full control over your RequestRocket account

Base URL

https://api.requestrocket.com

Authentication

Use your personal user token in the Authorization header:

curl -X GET "https://api.requestrocket.com/clients" \
  -H "Content-Type: application/json" \
  -H "Authorization: {your_user_token}"

Available Resources

• Clients: Organisation management
• Users: User and membership management
• Invites: Team invitations
• Credentials: Proxy and target credentials
• Targets: Target API configurations
• Proxies: Proxy configurations
• Rules: Authorization rules
• Requests: Request history and logs
• Notifications: System and user notifications

View detailed Core API documentation →

Authentication Methods

Proxy/Async API Authentication

Uses proxy credentials configured in RequestRocket:

API Key Example:

Authorization: {API_Key_Value}

Bearer Token Example:

Authorization: Bearer {Token}

Basic Auth Example:

Authorization: Basic {Base64_Encoded_Username:Password}

JWT Example:

Authorization: {JWT_Token}

Core API Authentication

Uses personal user tokens from your profile:

Authorization: {user_token}

User tokens are prefixed with u- and can be found in your personal settings under the "Keys" tab.

Learn how to access your user tokens →

Response Headers

RequestRocket adds custom headers to all API responses to help you understand the request flow and troubleshoot issues.

Key Headers

• requestrocket-proxy-code: Status of proxy authentication (proxy-access-granted, proxy-access-denied, billing-suspended, response-too-large)
• requestrocket-proxy-message: Human-readable description of the proxy code
• requestrocket-proxy-warning: Warning messages about your account or request status

View complete response headers documentation →

Rate Limits

To ensure platform stability, RequestRocket may implement rate limiting on API calls:

When rate limits are exceeded, the API returns a 429 Too Many Requests status code.

Payload Size Limits

Due to AWS Lambda synchronous invocation limits, RequestRocket has a 6 MB response payload limit for the Proxy API.

Response Size Limit

If a response from your target API exceeds 6 MB, RequestRocket will return:

• Status Code: 413 Payload Too Large
• Header: requestrocket-proxy-code: response-too-large
• Error Response:

{
  "error": "Payload Too Large",
  "message": "The response from the target API is too large to return directly.",
  "responseSize": "7.32 MB",
  "limit": "6 MB",
  "suggestion": "Consider using pagination or requesting smaller data sets."
}

Handling Large Responses

To work with APIs that return large responses:

1. Use Pagination: Request smaller data sets with pagination parameters
2. Filter Results: Apply filters to reduce response size
3. Use Async API: Consider the Async API for large data transfers (future feature)
4. Stream Data: For very large datasets, consider alternative streaming approaches

Error Handling

Standard HTTP Status Codes

RequestRocket uses standard HTTP status codes:

Transient Error Codes

The Async API automatically retries these error codes:

408  - Request Timeout
429  - Too Many Requests
500  - Internal Server Error
502  - Bad Gateway
503  - Service Unavailable
504  - Gateway Timeout
507  - Insufficient Storage
509  - Bandwidth Limit Exceeded

Cloudflare-specific:
520-526, 530

Nginx-specific:
598, 599

Getting Started

Ready to integrate RequestRocket?

Next Steps