Environment

List all environments

get

Responses

default

default response

application/json

get/environment

HTTPcURLJavaScriptPython

GET /rest/environment HTTP/1.1
Accept: */*

default

default response

Create a new environment

post

Body

application/json

createdDatestring · date-timeOptional

idstring · uuidOptional

modifiedDatestring · date-timeOptional

namestringOptional

serviceIdSetstring · uuid[]Optional

statusstring · enumOptionalPossible values:

Responses

default

default response

application/json

createdDatestring · date-timeOptional

idstring · uuidOptional

modifiedDatestring · date-timeOptional

namestringOptional

serviceIdSetstring · uuid[]Optional

statusstring · enumOptionalPossible values:

post/environment

HTTPcURLJavaScriptPython

POST /rest/environment HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "createdDate": "2026-07-12T01:06:52.141Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedDate": "2026-07-12T01:06:52.141Z",
  "name": "text",
  "serviceIdSet": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "status": "INCOMPLETE"
}

default

default response

{
  "createdDate": "2026-07-12T01:06:52.141Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedDate": "2026-07-12T01:06:52.141Z",
  "name": "text",
  "serviceIdSet": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "status": "INCOMPLETE"
}

Get an environment by ID

get

Path parameters

environmentIdstring · uuidRequired

The ID of the environment to retrieve

Responses

default

default response

application/json

createdDatestring · date-timeOptional

idstring · uuidOptional

modifiedDatestring · date-timeOptional

namestringOptional

serviceIdSetstring · uuid[]Optional

statusstring · enumOptionalPossible values:

get/environment/{environmentId}

HTTPcURLJavaScriptPython

GET /rest/environment/{environmentId} HTTP/1.1
Accept: */*

default

default response

{
  "createdDate": "2026-07-12T01:06:52.141Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedDate": "2026-07-12T01:06:52.141Z",
  "name": "text",
  "serviceIdSet": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "status": "INCOMPLETE"
}

Change an existing environment

put

Path parameters

environmentIdstring · uuidRequired

The ID of the environment to change

Body

application/json

createdDatestring · date-timeOptional

idstring · uuidOptional

modifiedDatestring · date-timeOptional

namestringOptional

serviceIdSetstring · uuid[]Optional

statusstring · enumOptionalPossible values:

Responses

default

default response

application/json

createdDatestring · date-timeOptional

idstring · uuidOptional

modifiedDatestring · date-timeOptional

namestringOptional

serviceIdSetstring · uuid[]Optional

statusstring · enumOptionalPossible values:

put/environment/{environmentId}

HTTPcURLJavaScriptPython

PUT /rest/environment/{environmentId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "createdDate": "2026-07-12T01:06:52.141Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedDate": "2026-07-12T01:06:52.141Z",
  "name": "text",
  "serviceIdSet": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "status": "INCOMPLETE"
}

default

default response

{
  "createdDate": "2026-07-12T01:06:52.141Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedDate": "2026-07-12T01:06:52.141Z",
  "name": "text",
  "serviceIdSet": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "status": "INCOMPLETE"
}

Delete an environment

delete

Path parameters

environmentIdstring · uuidRequired

The ID of the environment to delete

Responses

204

successful operation

No content

delete/environment/{environmentId}

HTTPcURLJavaScriptPython

DELETE /rest/environment/{environmentId} HTTP/1.1
Accept: */*

204

successful operation

No content

Add a managed service to an environment

post

Path parameters

environmentIdstring · uuidRequired

The ID of the target environment

managedServiceIdstring · uuidRequired

The ID of the managed service to add to the environment

Responses

default

default response

application/json

createdDatestring · date-timeOptional

idstring · uuidOptional

modifiedDatestring · date-timeOptional

namestringOptional

serviceIdSetstring · uuid[]Optional

statusstring · enumOptionalPossible values:

post/environment/{environmentId}/add/{managedServiceId}

HTTPcURLJavaScriptPython

POST /rest/environment/{environmentId}/add/{managedServiceId} HTTP/1.1
Accept: */*

default

default response

{
  "createdDate": "2026-07-12T01:06:52.141Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedDate": "2026-07-12T01:06:52.141Z",
  "name": "text",
  "serviceIdSet": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "status": "INCOMPLETE"
}

Add a service provider to an environment

post

Path parameters

environmentIdstring · uuidRequired

The ID of the target environment

serviceProviderIdstring · uuidRequired

The ID of the service provider to add to the environment

Responses

default

default response

application/json

createdDatestring · date-timeOptional

idstring · uuidOptional

modifiedDatestring · date-timeOptional

namestringOptional

serviceIdSetstring · uuid[]Optional

statusstring · enumOptionalPossible values:

post/environment/{environmentId}/addServiceProvider/{serviceProviderId}

HTTPcURLJavaScriptPython

POST /rest/environment/{environmentId}/addServiceProvider/{serviceProviderId} HTTP/1.1
Accept: */*

default

default response

{
  "createdDate": "2026-07-12T01:06:52.141Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedDate": "2026-07-12T01:06:52.141Z",
  "name": "text",
  "serviceIdSet": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "status": "INCOMPLETE"
}

Remove a service provider from an environment

post

Path parameters

environmentIdstring · uuidRequired

The ID of the target environment

serviceProviderIdstring · uuidRequired

The ID of the service provider to remove from the environment

Responses

default

default response

application/json

createdDatestring · date-timeOptional

idstring · uuidOptional

modifiedDatestring · date-timeOptional

namestringOptional

serviceIdSetstring · uuid[]Optional

statusstring · enumOptionalPossible values:

post/environment/{environmentId}/remove/{serviceProviderId}

HTTPcURLJavaScriptPython

POST /rest/environment/{environmentId}/remove/{serviceProviderId} HTTP/1.1
Accept: */*

default

default response

{
  "createdDate": "2026-07-12T01:06:52.141Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedDate": "2026-07-12T01:06:52.141Z",
  "name": "text",
  "serviceIdSet": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "status": "INCOMPLETE"
}

Start an environment

post

Path parameters

environmentIdstring · uuidRequired

The ID of the environment to start

Responses

202

successful operation

No content

post/environment/{environmentId}/start

HTTPcURLJavaScriptPython

POST /rest/environment/{environmentId}/start HTTP/1.1
Accept: */*

202

successful operation

No content

Stop an environment

post

Path parameters

environmentIdstring · uuidRequired

The ID of the environment to stop

Responses

202

successful operation

No content

post/environment/{environmentId}/stop

HTTPcURLJavaScriptPython

POST /rest/environment/{environmentId}/stop HTTP/1.1
Accept: */*

202

successful operation

No content