RailzwayDocs
API essentials

Base URLs

Address an organization through its default or custom API hostname.

Every organization receives an active default hostname when it is created. The hostname is derived from the organization ID and Fare's configured root domain:

https://<organization-id>.<default-root>

For example, with organization ID acme and production root api.railzway.com, the REST base URL is:

https://acme.api.railzway.com

API paths already contain the version prefix:

https://acme.api.railzway.com/v1/organizations/acme/customers

domains.default_root is an operator setting rather than a hard-coded Railzway domain. A self-hosted installation can use another DNS suffix. The development default is fare.local.

The hostname is part of tenant isolation

Fare resolves the organization from the HTTP Host header. An API key is rejected if its organization does not match the organization assigned to the hostname.

You can later expose the same organization through a custom domain. The API paths and API key do not change.