Get active runtime environments
Retrieves a list of all active runtime environments.
API request
To retrieve active runtime environments, send a GET request to the following API:
GET /public/api/v2/runtimeenvironments
Request parameters
- Path parameters
No parameter.
- Query parameters
No parameter.
- Body Parameters
- This endpoint does not require any body parameters.
Request headers
The following table describes the headers that you specify in the API request:
Name | Required or Optional | Description |
|---|
Accept | Optional | Response media types. For example, application/json. |
IDS-SESSION-ID | Required | JWT-based session token to authenticate the request. |
Response parameters
The following table describes the parameters that are returned by the API:
Name | Type | Description |
|---|
RuntimeEnvironments | Array | List of active runtime environments. |
RuntimeEnvironments.RuntimeEnvName | String | Display name of the runtime environment. |
RuntimeEnvironments.RuntimeEnvId | String | Unique identifier for the runtime environment. |
Sample request
The following is a sample request based on the values provided:
curl -X GET \
"{base_url}/workbench-service/public/api/v2/runtimeenvironments" \
-H "IDS-SESSION-ID: eyJraW********"
Sample response
- 200 OK
{
"RuntimeEnvironments": [
{
"RuntimeEnvName": "invpc2cwinvm01",
"RuntimeEnvId": "016JN32500000000019A"
},
{
"RuntimeEnvName": "invwbprod04 (Shared)",
"RuntimeEnvId": "016JN3250000000000LO"
}
]
}
- 400 Bad Request
{
"message": "Bad request \u2013 invalid parameters"
}
- 401 Unauthorized
{
"message": "Unauthorized \u2013 missing or invalid session credentials"
}
- 404 Not Found
{
"message": "No active runtime environments found"
}
- 500 Internal Server Error
{
"message": "Internal server error while fetching runtime environments"
}