Retire a set of API versions
POST /apim/retire_versions
Overview
This API retires the specified set of API versions.
Prerequisites
- Environment (Org) admin permissions
Request
POST https://{controlplane_path}/api/1/rest/public/apim/retire_versions
Path parameters
| Key | Description |
|---|---|
controlplane_path |
Required. The path to the SnapLogic control plane:
elastic.snaplogic.com
For the UAT or EMEA control plane, substitute the name for elastic. For
example:
|
Query parameters
None.
Request header
Basic authentication
In the request header, specify Basic for authorization, add your credentials (Login and password of your SnapLogic user or service account), and specify application/json for content type.
For more details on accounts refer to Manage accounts.
Authorization: Basic {base64_encoded <email>:<password>}
Content-Type: application/json
Example of Basic authenthication using Postman
Request body
{
"org_name": "Automation2",
"version_paths": ["Test/3.0.0"]
} | Key | Type | Description |
|---|---|---|
org_name |
string | The name of the SnapLogic Environment/Org. |
version_paths |
array | An array of strings containing the paths to the API versions.
An API version path is formatted as {api_name}/{api_version}.
|
Response
{
"response_map": {
"successful_versions": [
"/Automation2/apim/Test/3.0.0"
],
"unsuccessful_versions": []
},
"http_status_code": 200
}| Key | Type | Description |
|---|---|---|
successful_versions |
array | An array of strings containing the paths of the API versions that were successfully processed. |
unsuccessful_versions |
array | An array of objects containing:
|