Forge API

Guides

Custom Domains

Coming soon

Custom-domain support will let you serve Forge API mock endpoints from a domain or subdomain that you control.

Status: PlannedAvailability: Not yet available

This feature is not live yet

Forge API currently serves public endpoints from apis.getforgeapi.com. Do not create DNS records for Forge API until custom-domain support is officially released.

How endpoints work today

Every public endpoint currently uses the hosted Forge API domain.

Hosted API domain
https://apis.getforgeapi.com
Project key
abc12
Endpoint path
/products
Complete URL
https://apis.getforgeapi.com/abc12/products

These URLs already use HTTPS and can be called from browsers, frontend applications, mobile apps, test suites and API clients.

What custom domains will provide

A custom domain will give your mock API a URL that matches your own product or environment.

Branded API URLs

Use your own domain or subdomain instead of the standard Forge API public domain.

Realistic environments

Make staging, preview and demonstration URLs look closer to production infrastructure.

Easier client demonstrations

Present mock endpoints using a domain associated with your application or client.

Simpler future migrations

Keep a stable application-facing domain while changing the service behind it later.

Example custom-domain URLs

These examples show what the planned feature may look like.

Development API

https://api-dev.example.com/products

Preview environment

https://preview-api.example.com/orders

Client demonstration

https://demo-api.example.com/users

Examples only

The URLs above are illustrative. The final setup flow, supported record types and plan availability may change before launch.

Expected setup process

The final workflow is expected to involve adding a domain and verifying its DNS configuration.

  1. 1

    Add a custom domain or subdomain inside Forge API.

  2. 2

    Forge API provides the DNS record that must be created with your domain provider.

  3. 3

    Add the required DNS record through providers such as Cloudflare, GoDaddy, Namecheap or another DNS host.

  4. 4

    Forge API checks that the DNS record points to the correct service.

  5. 5

    After verification, Forge API provisions HTTPS for the domain.

  6. 6

    Assign the verified domain to the relevant project or environment.

Do not configure DNS yet

No production DNS target has been published for customer domains. Adding speculative records now will not activate a Forge API custom domain.

Domain requirements

Custom domains will need to satisfy basic ownership and DNS requirements.

  • You must control the domain or subdomain.
  • You must be able to create or update its DNS records.
  • The domain must not already be connected to an incompatible service.
  • DNS changes must be allowed time to propagate before verification.
  • The domain must pass Forge API ownership verification.

HTTPS and certificates

Custom API domains must use encrypted HTTPS connections.

The planned implementation will automatically provision and renew an SSL/TLS certificate after the domain is successfully verified.

Certificate provisioning takes time

DNS verification and certificate provisioning are not always immediate. A newly connected domain may remain pending while DNS changes propagate and the certificate is issued.

Custom domains and project keys

The final URL structure will depend on how the domain is assigned.

Forge API may support one or more of the following approaches:

Domain assigned to one project

https://api.example.com/products

The project key is hidden because the domain already identifies the project.

Domain shared across projects

https://api.example.com/abc12/products

The public project key remains part of the URL when multiple projects share one domain.

Final design not confirmed

Forge API will document the exact routing behaviour before custom domains become publicly available.

Custom domains and request protection

Using a custom domain will not automatically make an endpoint private.

A domain controls the address used to reach the endpoint. Access protection is configured separately through required request headers on supported paid plans.

Custom domain

Changes the public URL used to call the mock API.

Required request headers

Rejects requests that do not include the configured shared secret values.

A branded URL is still public

Anyone who discovers a custom-domain endpoint may attempt to call it. Configure request-header protection when access should be limited.

Potential limitations

The released feature may include limits based on plan and account configuration.

Possible limits may include:

  • Number of custom domains per account
  • Number of domains assigned to one project
  • Supported DNS record types
  • Availability on selected paid plans
  • Restrictions on wildcard domains
  • Domain verification and certificate timeouts

Final limits will be published on the pricing page and in this documentation before launch.

Until custom domains are available

Use the standard Forge API URL for development, testing and demonstrations.

The hosted domain is already suitable for:

  • Local frontend development
  • Preview and staging deployments
  • Mobile application development
  • Automated and manual testing
  • Product demonstrations and prototypes
Coming soon

Use your own domain for mock APIs

Custom-domain support is planned but is not currently available. Continue using the hosted Forge API domain until the feature is officially released.