Sign in
Projects

Rename the auto-managed subdomain for an environment.

Changed on

Replaces the environment's previous subdomain entirely — the old hostname stops resolving once the proxy reloads its route table. Custom domains attached to the environment are unaffected.

patch/projects/{project_id}/environments/{env_id}/subdomain

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{project_id}/environments/{env_id}/subdomain
  • Auth: none declared

Path parameters

project_idinteger required

Project ID or slug

env_idinteger required

Environment ID or slug

Request body

subdomainstring required

New subdomain label. Must be a DNS-safe slug (lowercase letters, digits, and hyphens, 1-63 characters). The value is slugified server-side, so casing and disallowed characters are normalized.

Example request

{
  "subdomain": "myapp"
}

Response

Subdomain updated successfully

attack_modeboolean nullable

Per-environment CAPTCHA attack-mode override. null means inherit the project-level attack_mode; true/false explicitly enable/disable the challenge for this environment. Always serialized (NOT skipped) so the UI can distinguish null from false.

branchstring nullable
created_atinteger required
current_deployment_idinteger nullable
estimated_sleep_atinteger nullable

Estimated time (epoch millis) when the environment will go to sleep based on last activity + idle timeout. NULL when sleeping or on-demand disabled.

force_httpsboolean nullable

Per-environment HTTP→HTTPS redirect override. null means inherit the proxy default (redirect only when the host has an active TLS certificate); true always redirects plain HTTP for this environment, false never does. Always serialized (NOT skipped) so the UI can distinguish null from false.

idinteger required
is_previewboolean required

Indicates if this is a preview environment (auto-created per branch) For preview environments, 'branch' contains the feature branch name

last_activity_atinteger nullable

Last proxied request timestamp (epoch millis) for on-demand environments. NULL when on-demand is disabled or no traffic has been received yet.

main_urlstring required
namestring required
project_idinteger required
protectedboolean required

When true, git pushes do NOT auto-deploy to this environment. Deployments must be promoted from another environment.

sleepingboolean required

When true, the environment's containers are currently stopped due to inactivity (on-demand mode) and will start on the next request.

slugstring required
subdomainstring required

The host label stored for this environment (e.g. myproject-production). This is the prefix that is combined with the platform's preview domain at request time to produce main_url. Edit this via the rename-subdomain endpoint, not the full URL.

updated_atinteger required

Changes

  • c3b504454b19Revision changes
    • info

      added the optional property ///// to the response with the status

  • 3c75d3f3795cRevision changes
    • info

      added the optional property ///// to the response with the status