Skip to main content

Project address

Every project gets a public address with HTTPS. You do not configure a certificate, open a port, or point DNS: the address is born with the project.

How the address is composed​

SituationAddress form
Main web service in Production<project>-<organization>
Main web service in another environment<project>-<environment>-<organization>
Additional web service in Production<service>-<project>-<organization>
Additional web service in another environment<service>-<project>-<environment>-<organization>

The full address is that label plus the domain: the platform's, or your organization's own domain.

The environment appears in the address for non-production environments so the same service in different environments does not collapse into a single address. Production uses the short form because that is the address you hand out.

Choosing the address​

At project creation, and later under Domains in the project, you can choose the label. Three independent questions, which the form asks for you:

  • Can this text become an address? — the label has rules: lowercase, numbers, and hyphens, up to 63 characters for the whole label.
  • Is it free? — the check is about the final address, not about the name inside the organization. A name that is free in your organization can produce an address that is taken.
  • What alternatives exist? — the form suggests free addresses based on the name you typed.

Typing reserves nothing. The reservation happens when you confirm.

Choose the zone before the address

If you are going to publish under your company's domain, choose the zone before checking the address: checking store without knowing which domain it sits under checks the wrong thing. store can be free under one domain and taken under another.

Reserved names​

Some labels belong to the platform — console, api, auth, www, login, among others — and are refused. That holds under a custom domain too.

Changing the address​

A service has one public address. Changing it does not pile up old addresses: the previous one goes out of use and stays reserved to your organization.

  1. Under Domains, in the project, type the new address and choose Use this one.
  2. Read the confirmation and click Change the address:

Switch to new address? The current address stops answering as soon as the new one is live and stays reserved to your organization — no other organization can use it. Published links, login callbacks (OAuth), and webhooks that use the current address need to be updated.

When you confirm, the platform redeploys the version that is already live with the new address, without rebuilding. The deployment shows up under Deployments as Address change. While it runs, the previous address shows as Stops answering once the new address is live.

SituationWhat happens to the previous address
The deployment with the new address becomes readyIt stops answering at that same instant and stays reserved to your organization. There is never a gap with no address
The deployment failsIt keeps answering. The next deployment that becomes ready completes the change
The project has never deployedIt goes out of use immediately, reserved to your organization: there is nothing to redeploy
You go back to the previous name before the deployment finishesThe change is undone
The previous address stays with your organization

No other organization can choose the previous address: whatever still points to it — links, login callbacks (OAuth), webhooks — never lands in another company's application. A project in your organization can use it again whenever it wants. Still, update what points to the old address: it stops answering.

The project's internal identifier does not change when the address changes.

How far the address is confirmed​

On the project's Domains page, each address shows two indicators:

IndicatorWhat it means
HTTPSConfirmed or not confirmed yet
RoutingConfirmed or not confirmed yet

They record what the deployment proved, not a probe run just now. That is why they never say "error": absence of proof is not proof of failure, and a freshly deployed address showing red would teach people to ignore red when it matters.

Common errors​

SymptomCauseWhat to do
"This address is already in use"The final address is reservedChoose another or take a suggestion
The address appears but does not answerThe first deployment has not finishedFollow it under Deployments
The old address stopped answeringThere was an address change, and the deployment with the new one became readyThat is expected: use the new address and update links, callbacks, and webhooks
Address refused for no obvious reasonA label reserved by the platformChoose another name
Address longer than allowedThe whole label exceeds 63 charactersShorten the project name

Next steps​