API Commands deprecated in Runtime 4.4
As a part of Runtime´s version 4.4 release, we´ll be removing a few deprecated API functions in order to improve the user experience and stability of our REST API. This can impact existing Runtime automation scripts that rely on sending commands through the API, but as these functions have been deprecated for more than a year now, we suspect the impact of this change will be minimal. Nevertheless, below is an overview of removed functions and their alternatives, should you have to partially rework your scripts.
Removed API Function | Alternative | Description |
|---|---|---|
Environment → Retrieve Application (api/2/environments/{environmentId}/application) | Environment → Retrieve Installed Applications (api/2/environments/{environmentId}/applications) | More than one application can be installed to a given environment, which this deprecated function didn’t account for. |
Parameters → Create a Parameter (api/2/parameters) | Environment Parameters → Create An Environment Parameter (api/2/parameters/environment) | Parameters were added under environments as this made more sense logically, and allows for a more logical divide when working with multiple environments. |
Parameters → Update / Delete a Parameter (/api/2/parameters/{parameterId}) | Environment Parameters → Update / Delete An Environment Parameter (/api/2/parameters/environment/{parameterId}) | See “Parameters → Create a Parameter“. |
Parameters → Retrieve the Target Database Connection (api/2/parameters/database) | Environment Parameters → Retrieve the Target Database Connection (api/2/parameters/environment/database) | See “Parameters → Create a Parameter“. |
Parameters → Test the Given Database Parameter (api/2/parameters/database/test) | Environment Parameters → Test the Given Database Parameter (api/2/parameters/environment/database/test) | See “Parameters → Create a Parameter“. |
Run History → findExecutionsById (api/2/runs/history/executions/{runHistoryId}) | Active Runs → Retrieve processable executions for an active run (/api/2/runs/{runId}/executions) | These two functions both retrieved executions of a run, and as the value for runHistoryId and runId are identical, the deprecated function is redundant. |
Run History → findArtifacts /api/2/runs/history/{runHistoryId}/artifacts | Active Runs → Retrieve Artifact (api/2/runs/{runId}/artifacts/{filename}) | See “Run History → findExecutionsById“. |
Run History → getRunLog /api/2/runs/history/{runHistoryId}/log | Active Runs → Retrieve Active or Historic Run by ID (/api/2/runs/{runId}) | See “Run History → findExecutionsById“. |
API Key metadata (/api/2/metadata/{key}) | None, see description. | This function was already not published in the documentation, but had the key exposed in the URI. This is obviously not a good idea as this is a potential security risk, so we’ve decided to prune this function altogether. Original functionality was to obtain metadata for a given API key. |