Sign in
latestOpenAPI 3.0.12026-08-10234260964.0 KB

6cc88fde6435

Environment

Get an environment

Retrieve the details of a single existing environment.

get/projects/{projectId}/environments/{environmentId}

Path parameters

projectIdstring required
environmentIdstring required

Response

idstring required

The identifier of Environment

created_atstring date-time nullable required

The creation date

updated_atstring date-time nullable required

The update date

namestring required

The name of the environment

machine_namestring required

The machine name for the environment

titlestring required

The title of the environment

attributesobject required

Arbitrary attributes attached to this resource

type'development' | 'production' | 'staging' required

The type of environment (production, staging or development), if not provided, a default will be calculated

parentstring nullable required

The name of the parent environment

default_domainstring nullable required

The default domain

has_domainsboolean required

Whether the environment has domains

clone_parent_on_createboolean required

Clone data when creating that environment

deployment_targetstring nullable required

Deployment target of the environment

is_prboolean required

Is this environment a pull request / merge request

has_remoteboolean required

Does this environment have a remote repository

status'active' | 'deleting' | 'dirty' | 'inactive' | 'paused' required

The status of the environment

enable_smtpboolean required

Whether to configure SMTP for this environment

restrict_robotsboolean required

Whether to restrict robots for this environment

edge_hostnamestring required

The hostname to use as the CNAME

resources_overridesobject required

Resources overrides

max_instance_countinteger nullable required

Max number of instances for this environment

last_active_atstring date-time nullable required

Last activity date

last_backup_atstring date-time nullable required

Last backup date

projectstring required

The project the environment belongs to

is_mainboolean required

Is this environment the main environment

is_dirtyboolean required

Is there any pending activity on this environment

has_staged_activitiesboolean required

Is there any staged activity on this environment

can_rolling_deployboolean required

If the environment has rolling deployments ready for use

supports_rolling_deploymentsboolean required

If the environment supports rolling deployments

has_codeboolean required

Does this environment have code

head_commitstring nullable required

The SHA of the head commit for this environment

has_deploymentboolean required

Whether this environment had a successful deployment

supports_restrict_robotsboolean required

Does this environment support configuring restrict_robots