Environment Management API

The Environment Management APIs allow you to list, view, refresh, enable/disable, and delete environments in XLServer.
Most operations (except GET requests) are asynchronous: the API returns a success response immediately while the actual job continues in the background.

---

List All Environments

Endpoint

GET /xls-server/environment/list

Description

Retrieves all environments managed by XLServer.

Request Example

curl -k -X GET https://<server>:8443/xls-server/environment/list \
    -H "Authorization: Bearer <token>"

Get Environment

Endpoint

GET /xls-server/environment/{id}

Description

Retrieves detailed information about a specific environment.

Path Parameters

Parameter	Type	Description
id	string	Unique environment identifier

Request Example

curl -k -X GET https://<server>:8443/xls-server/environment/HOST_ENVIRONMENT-29 \
    -H "Authorization: Bearer <token>"

Refresh Environment

Endpoint

PUT /xls-server/environment/refresh

Description

Refreshes the specified environment to discover any new databases.

Request Body

The environment identifier as a plain string.

Example Payload

"HOST_ENVIRONMENT-29"

Request Example

curl -k -X PUT https://<server>:8443/xls-server/environment/refresh \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>" \
    -d '"HOST_ENVIRONMENT-29"'

Asynchronous Response

{"objectType":"SUCCESS_RESULT","status":"SUCCESS","object":null}

💡 The actual refresh job runs in the background.

Disable Environment

Endpoint

PUT /xls-server/environment/disable

Description

Disables an environment, preventing operations from being executed on it.

Request Example

curl -k -X PUT https://<server>:8443/xls-server/environment/disable \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>" \
    -d '"HOST_ENVIRONMENT-29"'

Asynchronous Response

{"objectType":"SUCCESS_RESULT","status":"SUCCESS","object":null}

Enable Environment

Endpoint

PUT /xls-server/environment/enable

Description

Re-enables a previously disabled environment.

Request Example

curl -k -X PUT https://<server>:8443/xls-server/environment/enable \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>" \
    -d '"HOST_ENVIRONMENT-29"'

Asynchronous Response

{"objectType":"SUCCESS_RESULT","status":"SUCCESS","object":null}

Delete Environment

Endpoint

DELETE /xls-server/environment/delete

Description

Deletes a specific environment from XLServer.

Query Parameters

Parameter	Type	Description
input	string	Unique environment identifier

Request Example

curl -k -X DELETE https://<server>:8443/xls-server/environment/delete?input=HOST_ENVIRONMENT-29 \
    -H "Authorization: Bearer <token>"

Asynchronous Response

{"objectType":"SUCCESS_RESULT","status":"SUCCESS","object":null}