Sign in
latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
Environment

Add a new Environment to an Application.

Creates a new Environment of the specified Type and associates it with the Application specified by appId.

The Environment is also initialized to the current or past state of Deployment in another Environment. This ensures that every Environment is derived from a previously known state. This means it is not possible to create a new Environment for an Application until at least one Deployment has occurred. (The Deployment does not have to be successful.)

The Type of the Environment must be already defined in the Organization.

post/orgs/{orgId}/apps/{appId}/envs

Path parameters

orgIdstring required

The Organization ID.

appIdstring required

The Application ID.

Request body

from_deploy_idstring

Defines the existing Deployment the new Environment will be based on.

idstring required

The ID the Environment is referenced as.

namestring required

The Human-friendly name for the Environment.

typestring

The Environment Type. This is used for organizing and managing Environments.

Response

The new Environment.

created_atstring date-time required

The timestamp in UTC of when the Environment was created.

created_bystring required

The user who created the Environment

idstring required

The ID the Environment is referenced as.

namestring required

The Human-friendly name for the Environment.

typestring required

The Environment Type. This is used for organizing and managing Environments.

status'active' | 'deleting' required

The status of the environment

status_changed_atstring date-time required

The timestamp in UTC of when the Environment status was last changed.

status_messagestring

The message associated with the status of the environment

Example response

{
  "created_at": "2020-05-22T14:58:07Z",
  "created_by": "a.user@example.com",
  "status": "active",
  "status_changed_at": "2020-05-22T14:59:01Z",
  "from_deploy": {
    "comment": "Updated version of module-one to v0.3.1",
    "created_at": "2020-05-22T14:58:07Z",
    "created_by": "a.user@example.com",
    "delta_id": "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
    "env_id": "my-env",
    "from_id": "42d4b302fd3c",
    "id": "67f1619a57d",
    "status": "in progress",
    "status_changed_at": "2020-05-22T14:59:01Z"
  },
  "id": "feature-test",
  "last_deploy": {
    "comment": "Updated version of module-one to v0.3.1",
    "created_at": "2020-05-22T14:58:07Z",
    "created_by": "a.user@example.com",
    "delta_id": "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
    "env_id": "my-env",
    "from_id": "42d4b302fd3c",
    "id": "67f1619a57d",
    "status": "in progress",
    "status_changed_at": "2020-05-22T14:59:01Z"
  },
  "name": "Feature Test",
  "type": "development"
}