# Ephemeral Environments

## Deprovision an ephemeral environment

:endpoint{method="POST" path="/api/\{spaceId\}/environments/ephemeral/\{id\}/deprovision"}

Also reachable at `/api/spaces/{spaceIdentifier}/environments/ephemeral/{id}/deprovision`.

**Path Parameters**

- **`id`** :span[string]{.type-label} *(required)*  
  The ID of the ephemeral environment to deprovision.
- **`spaceId`** :span[string]{.type-label} *(required)*

**Response**

`200` — Deprovision an ephemeral environment response

- **`DeprovisioningRuns`** :span[array of object]{.type-label}
  - **`RunbookRunId`** :span[string]{.type-label}
  - **`TaskId`** :span[string]{.type-label}

:::api-example{label="Response"}
```json
{
  "DeprovisioningRuns": [
    {
      "RunbookRunId": "RunbookRuns-1",
      "TaskId": "ServerTasks-1"
    }
  ]
}
```
:::

## Allow the creation of an ephemeral environment in a given space

:endpoint{method="POST" path="/api/\{spaceId\}/projects/\{projectId\}/environments/ephemeral"}

Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/environments/ephemeral`.

**Path Parameters**

- **`projectId`** :span[string]{.type-label} *(required)*
- **`spaceId`** :span[string]{.type-label} *(required)*

**Request Body**

- **`EnvironmentName`** :span[string]{.type-label} *(required)*  
  The name to give the new ephemeral environment. Minimum length 1.
- **`ProjectId`** :span[string]{.type-label} *(required)*
- **`SpaceId`** :span[string]{.type-label} *(required)*

:::api-example{label="Request"}
```json
{
  "EnvironmentName": "string",
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}
```
:::

**Response**

`201` — Created

- **`Id`** :span[string]{.type-label}

:::api-example{label="Response"}
```json
{
  "Id": "Environments-1"
}
```
:::

## Deprovision an ephemeral environment for a specific project

:endpoint{method="POST" path="/api/\{spaceId\}/projects/\{projectId\}/environments/ephemeral/\{environmentId\}/deprovision"}

Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/environments/ephemeral/{environmentId}/deprovision`.

**Path Parameters**

- **`environmentId`** :span[string]{.type-label} *(required)*
- **`projectId`** :span[string]{.type-label} *(required)*
- **`spaceId`** :span[string]{.type-label} *(required)*

**Response**

`200` — Deprovision an ephemeral environment response

- **`DeprovisioningRun`** :span[object]{.type-label}
  - **`RunbookRunId`** :span[string]{.type-label}
  - **`TaskId`** :span[string]{.type-label}

:::api-example{label="Response"}
```json
{
  "DeprovisioningRun": {
    "RunbookRunId": "RunbookRuns-1",
    "TaskId": "ServerTasks-1"
  }
}
```
:::

## Mark a failed deprovisioning as successful for an ephemeral environment

:endpoint{method="POST" path="/api/\{spaceId\}/projects/\{projectId\}/environments/ephemeral/\{environmentId\}/deprovisioning/mark-successful"}

Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/environments/ephemeral/{environmentId}/deprovisioning/mark-successful`.

**Path Parameters**

- **`environmentId`** :span[string]{.type-label} *(required)*
- **`projectId`** :span[string]{.type-label} *(required)*
- **`spaceId`** :span[string]{.type-label} *(required)*

**Response**

`200` — Response to mark deprovisioning as successful for an ephemeral environment

:::api-example{label="Response"}
```json
{}
```
:::

## Retry deprovisioning an ephemeral environment

:endpoint{method="POST" path="/api/\{spaceId\}/projects/\{projectId\}/environments/ephemeral/\{environmentId\}/deprovisioning/retry"}

Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/environments/ephemeral/{environmentId}/deprovisioning/retry`.

**Path Parameters**

- **`environmentId`** :span[string]{.type-label} *(required)*
- **`projectId`** :span[string]{.type-label} *(required)*
- **`spaceId`** :span[string]{.type-label} *(required)*

**Response**

`200` — Response to retry deprovisioning an ephemeral environment

- **`DeprovisioningRun`** :span[object]{.type-label}
  - **`RunbookRunId`** :span[string]{.type-label}
  - **`TaskId`** :span[string]{.type-label}

:::api-example{label="Response"}
```json
{
  "DeprovisioningRun": {
    "RunbookRunId": "RunbookRuns-1",
    "TaskId": "ServerTasks-1"
  }
}
```
:::

## Mark a failed provisioning as successful for an ephemeral environment

:endpoint{method="POST" path="/api/\{spaceId\}/projects/\{projectId\}/environments/ephemeral/\{environmentId\}/provisioning/mark-successful"}

Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/environments/ephemeral/{environmentId}/provisioning/mark-successful`.

**Path Parameters**

- **`environmentId`** :span[string]{.type-label} *(required)*
- **`projectId`** :span[string]{.type-label} *(required)*
- **`spaceId`** :span[string]{.type-label} *(required)*

**Response**

`200` — Response to mark provisioning as successful for an ephemeral environment

:::api-example{label="Response"}
```json
{}
```
:::

## Retry provisioning an ephemeral environment

:endpoint{method="POST" path="/api/\{spaceId\}/projects/\{projectId\}/environments/ephemeral/\{environmentId\}/provisioning/retry"}

Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/environments/ephemeral/{environmentId}/provisioning/retry`.

**Path Parameters**

- **`environmentId`** :span[string]{.type-label} *(required)*
- **`projectId`** :span[string]{.type-label} *(required)*
- **`spaceId`** :span[string]{.type-label} *(required)*

**Response**

`200` — Response to retry provisioning an ephemeral environment

- **`ProvisioningRun`** :span[object]{.type-label}
  - **`RunbookRunId`** :span[string]{.type-label}
  - **`TaskId`** :span[string]{.type-label}

:::api-example{label="Response"}
```json
{
  "ProvisioningRun": {
    "RunbookRunId": "RunbookRuns-1",
    "TaskId": "ServerTasks-1"
  }
}
```
:::

## Get the status of an ephemeral environment for a given project

:endpoint{method="GET" path="/api/\{spaceId\}/projects/\{projectId\}/environments/ephemeral/\{id\}/status"}

Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/environments/ephemeral/{id}/status`.

**Path Parameters**

- **`id`** :span[string]{.type-label} *(required)*  
  The ID of the ephemeral environment whose status to report.
- **`projectId`** :span[string]{.type-label} *(required)*
- **`spaceId`** :span[string]{.type-label} *(required)*

**Response**

`200` — Success

- **`Status`** :span[string]{.type-label}

:::api-example{label="Response"}
```json
{
  "Status": "string"
}
```
:::