Ephemeral Environments

POST /api/{spaceId}/environments/ephemeral/{id}/deprovision

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

Path Parameters

• id string (required)
  The ID of the ephemeral environment to deprovision.
• spaceId string (required)

Response

200 — Deprovision an ephemeral environment response

• DeprovisioningRuns array of object
  • RunbookRunId string
  • TaskId string

{
  "DeprovisioningRuns": [
    {
      "RunbookRunId": "RunbookRuns-1",
      "TaskId": "ServerTasks-1"
    }
  ]
}

POST /api/{spaceId}/projects/{projectId}/environments/ephemeral

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

Path Parameters

• projectId string (required)
• spaceId string (required)

Request Body

• EnvironmentName string (required)
  The name to give the new ephemeral environment. Minimum length 1.
• ProjectId string (required)
• SpaceId string (required)

Response

201 — Created

• Id string

{
  "EnvironmentName": "string",
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

{
  "Id": "Environments-1"
}

POST /api/{spaceId}/projects/{projectId}/environments/ephemeral/{environmentId}/deprovision

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

Path Parameters

• environmentId string (required)
• projectId string (required)
• spaceId string (required)

Response

200 — Deprovision an ephemeral environment response

• DeprovisioningRun object
  • RunbookRunId string
  • TaskId string

{
  "DeprovisioningRun": {
    "RunbookRunId": "RunbookRuns-1",
    "TaskId": "ServerTasks-1"
  }
}

POST /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 string (required)
• projectId string (required)
• spaceId string (required)

Response

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

{}

POST /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 string (required)
• projectId string (required)
• spaceId string (required)

Response

200 — Response to retry deprovisioning an ephemeral environment

• DeprovisioningRun object
  • RunbookRunId string
  • TaskId string

{
  "DeprovisioningRun": {
    "RunbookRunId": "RunbookRuns-1",
    "TaskId": "ServerTasks-1"
  }
}

POST /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 string (required)
• projectId string (required)
• spaceId string (required)

Response

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

{}

POST /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 string (required)
• projectId string (required)
• spaceId string (required)

Response

200 — Response to retry provisioning an ephemeral environment

• ProvisioningRun object
  • RunbookRunId string
  • TaskId string

{
  "ProvisioningRun": {
    "RunbookRunId": "RunbookRuns-1",
    "TaskId": "ServerTasks-1"
  }
}

GET /api/{spaceId}/projects/{projectId}/environments/ephemeral/{id}/status

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

Path Parameters

• id string (required)
  The ID of the ephemeral environment whose status to report.
• projectId string (required)
• spaceId string (required)

Response

200 — Success

• Status string

{
  "Status": "string"
}