Skip to main content

Create An HTTP Endpoint

Beeceptor enables the creation of mock APIs, offering the means to replicate the functionality of a real API server. This involves creating or deploying an HTTP endpoint. The endpoint is modeled as sub-domain and supports both HTTP and HTTPS protocols, accommodating various HTTP methods such as GET, POST, PUT, and PATCH. Users can send API or HTTP requests to these endpoints and observe the requests and responses in real time via the dashboard.

Guidelines for Naming Endpoints​

In Beeceptor, you have the flexibility to create endpoints with names of your preference. When naming your endpoints, follow these guidelines:

  • Use alphanumeric characters in the name.
  • Begin the name with a letter.
  • Keep the name between 5 and 40 characters in length.
  • Only dash is allowed as special character, but not at the start and end of the name.

For instance, if you name your endpoint as 'my-apis,' it will result in the creation of two URLs:

  • Endpoint URL: This represents the base URL for your mock API. It is a sub-domain with the endpoint name. Example my-api.free.beeceptor.com.
  • Dashboard Page: The dashboard helps you manage the mock APIs, including the management of API routes and and oversight of request and response in real time. This page is accessible at app.beeceptor.com/console/my-api

Creating an Endpoint​

Follow these steps to create a Beeceptor endpoint and send your first request to mock server:

  1. Visit beeceptor.com.
  2. Choose a name of your preference and click the 'Create Endpoint' button.
  3. Once you land on the dashboard page, you will find two predefined mocking rules for request path /todo.
  4. You can copy the endpoint URL and initiate a GET HTTP/API request from your code, web browser, CURL command, or any API client. Moreover, you can refer sample code snippets for various programming languages.
  5. The dashboard page provides real-time visibility into incoming requests and responses. Simply click on a row to review the request and response payloads.

By default, Beeceptor endpoints are public. This means that anyone with access to the dashboard URL can view incoming requests and responses. You have the option to upgrade to a private dashboard, which is exclusively accessible to you. When creating a free endpoint it is recommended to choose a unique endpoint name that is difficult to guess. Additionally, the dashboard page displays the count of users connected to the page and actively monitoring incoming requests.