Deprecation notice - changes in Extend Environment and Get All Environments APIs (Deprecated April 24, 2023)

[shirabendor-quali]

We're announcing today changes to 2 of our APIs: the API to extend environment and the API to get the list of environments. The current usage of these APIs is now deprecated, however it will continue working until April 24th, 2023. Please read the below information and make any necessary changes before April 24th.

Extend API change
For the extend API, we're changing the path structure as well as the body structure.
For this purpose, and to support backwards compatibility, we have introduced the "Extend Environment V2" API.
Please see the API description as well as compare and review the changes in the "Rest API" tab on your Torque account.

Get all Environments API change
This change does not modify the API path however it does change the Query parameters. This change is intended to support the new, enhanced filtering mechanism that we have in Torque (soon coming to the UI).
Here too you can check the API in the rest API page.

In order to make things clear, here is a summary of the changes :

The items in red are the entries that will be removed while the items in blue are the new, added items, which serve as filters to the list.
The last added item is the SortBy item, which dictates the order in which environments will be returned.
Choose one of the following:

• StartTime
• EndTime
• LastAccess
• Status
• BlueprintName
• Owner

Here is an example of usage for this API: 
GET {{host}}/api/spaces/{{space}}/environments?count=30&automation=false&status=Ended&status=Terminate Failed&name=simple&[email protected]&[email protected]&[email protected]&blueprint_name=simple&sort_by=StartTime 

To clarify, the existing Extend API and the full list of query parameters (including both old and new) will be supported until :
❗ April 24, 2023 ❗