Parent Environments

Create a new parent environment

POST /api/{spaceId}/parentEnvironments

Also reachable at /api/spaces/{spaceIdentifier}/parentEnvironments.

Path Parameters

spaceId string (required)

Request Body

AutomaticDeprovisioningRule object
- ExpiryDays integer
- ExpiryHours integer
Description string
Name string (required)
Minimum length 1. Maximum length 50.
Slug string
SpaceId string (required)
UseGuidedFailure boolean

Response

201 — Created

Id string

{
  "AutomaticDeprovisioningRule": {
    "ExpiryDays": 0,
    "ExpiryHours": 0
  },
  "Description": "string",
  "Name": "string",
  "Slug": "string",
  "SpaceId": "Spaces-1",
  "UseGuidedFailure": true
}

{
  "Id": "Environments-1"
}

Modify an existing parent environment

PUT /api/{spaceId}/parentEnvironments/{environmentId}

Also reachable at /api/spaces/{spaceIdentifier}/parentEnvironments/{environmentId}.

Path Parameters

environmentId string (required)
spaceId string (required)

Request Body

AutomaticDeprovisioningRule object
- ExpiryDays integer
- ExpiryHours integer
Description string
EnvironmentId string (required)
Name string (required)
Minimum length 1.
Slug string
SortOrder integer
SpaceId string (required)
UseGuidedFailure boolean

Response

200 — The parent environment after modifications have been applied.

AutomaticDeprovisioningRule object
- ExpiryDays integer
- ExpiryHours integer
Description string
Id string
Name string
Minimum length 1.
Slug string
Minimum length 1.
SortOrder integer
SpaceId string
UseGuidedFailure boolean

{
  "AutomaticDeprovisioningRule": {
    "ExpiryDays": 0,
    "ExpiryHours": 0
  },
  "Description": "string",
  "EnvironmentId": "Environments-1",
  "Name": "string",
  "Slug": "string",
  "SortOrder": 0,
  "SpaceId": "Spaces-1",
  "UseGuidedFailure": true
}

{
  "AutomaticDeprovisioningRule": {
    "ExpiryDays": 0,
    "ExpiryHours": 0
  },
  "Description": "string",
  "Id": "Environments-1",
  "Name": "string",
  "Slug": "string",
  "SortOrder": 0,
  "SpaceId": "Spaces-1",
  "UseGuidedFailure": true
}

Get a specific Parent Environment

GET /api/{spaceId}/parentEnvironments/{id}

Also reachable at /api/spaces/{spaceIdentifier}/parentEnvironments/{id}.

Path Parameters

id string (required)
ID of the Parent Environment to load.
spaceId string (required)

Response

200 — The requested Parent Environment

AutomaticDeprovisioningRule object
- ExpiryDays integer
- ExpiryHours integer
Description string
Id string
Name string
Minimum length 1.
Slug string
Minimum length 1.
SortOrder integer
SpaceId string
UseGuidedFailure boolean

{
  "AutomaticDeprovisioningRule": {
    "ExpiryDays": 0,
    "ExpiryHours": 0
  },
  "Description": "string",
  "Id": "Environments-1",
  "Name": "string",
  "Slug": "string",
  "SortOrder": 0,
  "SpaceId": "Spaces-1",
  "UseGuidedFailure": true
}

Delete an existing Parent Environment

DELETE /api/{spaceId}/parentEnvironments/{id}

Also reachable at /api/spaces/{spaceIdentifier}/parentEnvironments/{id}.

Path Parameters

id string (required)
ID of the Parent Environment to delete.
spaceId string (required)
The ID of the space containing the resource(s).

Response

200 — Success