Frequently Asked Questions

What is an endpoint?

A Beeceptor endpoint is a mock server, or a sub-domain to serve as an API server base URL.

These endpoints are public just like the real API endpoints. Anyone with the URL can send requests, anyone having a link to the dashboard can view requests and responses in real time. Each endpoint gets a dedicated sub-domain as my-server.proxy.beeceptor.com.

How to set up a mock server?

To create a mock server in Beeceptor, simply provide a name for the server from the home page. Mocking rules can then be added to specify the desired responses for specific routes. When a request path matches a rule, Beeceptor will send the pre-defined response. To begin, send a request and click "Create Rule" to set up the response. Beeceptor automatically captures the request details, allowing customization of the response with status codes, headers, and bodies. Creating a mock server and defining mocking rules is a quick and easy process with Beeceptor. Check out setting up mocking routes to know more about this.

What is a dashboard?

A dashboard is a place you can intercept and review all incoming requests coming to an endpoint. Beeceptor dashboard gives you an opportunity to inspect HTTP payload and setup mocks. When you make a request to my-endpoint.proxy.beeceptor.com, request & responses are visible on the dashboard page beeceptor.com/console/my-endpoint to inspect the payloads.

Are the endpoints secure or private?

Free endpoints are public.

• Anyone having a link to the dashboard can see incoming requests. Copy and share dashboard URL.
• On the dashboard, you see the number of online users for that endpoint.

Is there an HTTPs support?

Yes! Beeceptor supports HTTPs. You can send requests with HTTP and HTTPs, both. In addition, Beeceptor supports HTTP/2 as well.

Does it support Cross-Origin Resource Sharing (CORS)?

Beeceptor supports CORS by default. This will ease out making a cross-domain call from a webpage. (1) All OPTIONS calls are accepted. (2) Any mock/rules you create, Beeceptor adds a response header Access-Control-Allow-Origin: * making API consumption easier.

What is 'Proxy Setup'?

Proxy Setup helps you route requests to a target domain. You can create mock rules to manipulate specific requests instead of sending to the target domain. For example, you can create a rule matching HTTP's GET method and request path /my/api/path and send a 403 status code instead of 200 which the target domain would have sent.

1. When the rules are enabled, they are matched in the listed order. The first matched rule is evaluated to send a response. If no rule is matched, the target endpoint is hit as usual.
2. When the rules are disabled or no rule matches, the endpoint routes the request to the target endpoint.

How to simulate behavior of a 3rd party API?

Beeceptor is an advanced MITM proxy that elevates your API mocking and integrations capabilities. If you're utilizing a 3rd party API, you can wrap its endpoint with Beeceptor's sub-domain to gain complete control over the traffic that passes through it. This grants you the ability to easily review all the HTTP communication. Further, you can build mock rules for some or all requests giving you unparalleled flexibility while testing your application.

Can I use this for load/performance testing? (i.e. 100+ requests/sec)

Yes, with paid plans. Refer pricing page to find a suitable plan and upgrade. Feel free to reach out to us if your requirements are beyond this.

Can I see request history for an endpoint?

Yes, with the Team plan. Refer Request History documentation.

How much does it cost?

• Beeceptor is free for public endpoints with a limit on daily requests. Feel free to spread your love and share feedback.
• Beeceptor comes with awesome features with paid plans. (e.g private endpoints, request history, sharing, email support, APIs, OpenAPI, etc.) Refer to the pricing page for a detailed comparison.

Can I manager mocking routes/rules using APIs?

Yes. You can use Beeceptor APIs to create/update mocking rules. In addition, you can retrieve request history. Using this you can integrate Beeceptor to CI and Integration Tests. Refer to the API Documentation page.

What is privacy policy?

Beeceptor is a request interceptor and a router.

• If the dashboard page is open, these are sent over web-socket to inspect. Anyone with a dashboard page open can view and inspect request and response payloads.
• The server persists information about the endpoint (like settings, rules, etc) and requests (like target URL, headers and payloads of requests and responses, no. of hits to an endpoint, etc).

• You are advised not to send production secrets, passwords or api-keys in any of these: headers/body/payload/URL when you use Free endpoints.
• You are advised to use private endpoints (available with paid plans).
• You are advised to create endpoints with unique or difficult to guess names.
• You can protect these endpoints with an HTTP header that Beeceptor can validate.

How long Beeceptor stores the HTTP/API requests?

At Beeceptor, we have a structured data retention policy to ensure a balance between operational needs and data privacy. Here's what you need to know:

• Request Storage: All HTTP/API requests sent to the mock endpoint are stored for a duration of 10 days. Following this period, the data is automatically purged. This stored information encompasses the request and response payloads, headers and other relevant details.
• Application Logs Beeceptor retains application logs for a span of 30 days. These logs serve critical purposes such as auditing, providing support, and monitoring our services. They contain minimal information like request paths, status codes, and source IP addresses. However, it's important to note that application logs do not retain request/response payloads or headers. Furthermore, Personally Identifiable Information (PII) data is never present in these logs, ensuring the utmost protection of sensitive information.

How do I delete an endpoint?

There is no self-service way to delete endpoints. These are cleaned up after a certain period of non-usage.

• For a free endpoint, you can delete all the mocking-rules, proxy-setup, etc, and release it for others to use. As these are public in nature, other users can use this anytime.
• For a paid endpoint, you can reach out to support to purge/delete the endpoint. These are never purged.
• The requests and responses are purged after 10 days.

How do I delete my account?

You can delete your account with Beeceptor. Once you are logged in, visit the 'Edit Account' page to delete your account.

How Beeceptor is different from RequestBin or Mocky.io?

RequestBin helps by letting us inspect what the client is sending, and Mocky.io creates dummy endpoints to send mocked responses. Beeceptor covers both in one tool letting you inspect requests and build mock responses.

In addition, Beeceptor has more features to be your one-stop API development companion.

• Proxying: Route the traffic from mock to the original API/Service with single click. No need of redeployment or code changes.
• Extract request components (headers, query parameters, payload) and send a dynamic mock response.
• Generate fake data and make API responses look real.
• Beeceptor APIs allow you deeper integration with CI and Integration Tests.
• Local tunneling to help you with webhook development.

Use-cases

• Mock a rest API in seconds.
• Build a fake API without any coding.
• Customizable responses to simulate API response and failures.
• Load testing your APIs without passing the load to the downstream APIs.
• Simulate latencies and timeouts of downstream APIs (validate rarely reachable code paths)
• Local tunneling for webhook development. Expose your local port to the world.
• Host your OpenAPI specification with and generate mocks out of the box.
• Say goodbye to the static mocked response. You can now send dynamic responses by picking request payload parameters or query parameters.
• Conduct A/B testing by switching API endpoints or versions without any redeployment. This is useful when you want to check API behaviors from two environments, e.g. prod code vs sandbox code.
• Don't block your UI devs when backend APIs are still in development. Just mock it!
• Create endpoints for webhooks and inspect incoming payloads.