API

Environments

Preview environments a mission deploys to.

GET
/environments

Query Parameters

issueId?string
projectId?string
status?string

Value in

  • "provisioning"
  • "active"
  • "destroying"
  • "destroyed"
  • "failed"
limit?integer
Range1 <= value <= 500
Default200

Response Body

application/json

application/json

curl -X GET "https://example.com/environments"
{  "data": [    {      "environmentId": "string",      "projectId": "string",      "issueId": "string",      "prNumber": 0,      "workerName": "string",      "status": "provisioning",      "createdAt": 0,      "expiresAt": 0,      "destroyedAt": 0    }  ],  "nextCursor": "string"}
GET
/environments/{environmentId}

Path Parameters

environmentId*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://example.com/environments/string"
{  "environment": {    "environmentId": "string",    "projectId": "string",    "issueId": "string",    "prNumber": 0,    "workerName": "string",    "status": "provisioning",    "createdAt": 0,    "expiresAt": 0,    "destroyedAt": 0  }}
DELETE
/environments/{environmentId}

Path Parameters

environmentId*string
Length1 <= length

Response Body

application/json

application/json

application/json

curl -X DELETE "https://example.com/environments/string"
{  "ok": true,  "environmentId": "string"}

How is this page?