White Labeled Endpoints

Domain white label is a configuration where you can bring your own domain and hide the Beeceptor's endpoint. This is quite useful when you are giving a prototype demo and would like to completely hide Beeceptor identity.

For example, assume you own a domain my-domain.com, and have an active subscription to Beeceptor endpoint my-apis.proxy.beeceptor.com. With white labeling feature you can send API requests to my-domain.com. When the client app hits my-custom-domain.com, the request will be served by my-work.proxy.beeceptor.com and you can use all the features as before.

This feature is available with Team plan.

Step 1: Create a CNAME record

The first step is to decide a domain you would like to use and add whitelabel.beeceptor.com as a CNAME record in the domain's DNS.

Here are some links to help you with popular domain registrars. You can follow these steps to add required DNS record.

Step 2: Open white label settings

You can open White Label setup screen by navigating as Account Menu > Your Endpoints > Settings for the selected endpoint.

uploading-oas-in-beeceptor

Scroll down the settings page to see following section:

white-label-beeceptor-setup

Step 3: Validate the DNS

Enter the domain name and click Verify. If the verification is successful you will see a confirmation message. In case of errors, you can wait for sometime as DNS propagation typically takes time. (~24 hours)

Once the custom domain is verified, you are all set to test it.

Step 4: Test the setup

Send a GET request to https://my-domain.com/. You should be able to see this request on the dashboard. This means you are all set to start using it.

Notes

  • A change in DNS record takes time to propagate over the Internet. If the verification is not working, please try after some time.
  • The domain name should be unique. If a domain is being used and verified with an endpoint, you cannot use the same domain name with another Beeceptor endpoint.
  • The white labeled domain and Beeceptor provided sub-domain, both can accept incoming requests.
  • Beeceptor provisions an SSL certificate on-demand. This happens in-flight while serving the very first request.
← Open API SpecificationAPI Overview →