Delete API version
DELETE /apim/{path_to_apiversion}
Overview
This API soft deletes the API version. It is recoverable from recycle bin as it is a soft delete.
Prerequisites
- Environment (Org) admin permissions
Request
DELETE https://{controlplane_path}/api/1/rest/public/apim/{path_to_apiversion}?{query_parameters}
Path Parameters
Key | Description |
---|---|
controlplane_path |
Required. The path to the SnapLogic control plane. Example:
For other control planes, substitute the subdomain name for elastic . For
example:
|
path_to_apiversion |
Required. The path to the SnapLogic API version.
Format: Important: The path is case sensitive
|
Query Parameters
Key | Type | Description |
---|---|---|
force |
boolean |
|
Request Header
Specify Basic
for authorization and application/json
for content type.
Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json
Request Body
None.
Response
Response Body
{
"response_map": {
"success": {
"success": {
"disabled_jobs": [
{
"/Automation2/apim/api/1.0": []
},
{
"/Automation2/apim/api/1.1": []
}
],
"deleted_plexes": [plex1,plex2],
"path": "/Automation2/apim/api"
}
}
},
"http_status_code": 200
}
Key | Type | Description |
---|---|---|
disabled_jobs |
array | Paths to the disabled tasks in the API version. |
deleted_plexes |
array | Paths to the disabled plexes. |
path |
array | All the assets in the API version. |
Error Handling
HTTP Status Codes | Message | Resolution |
---|---|---|
404 |
{"message": "The requested resource at the supplied path does not
exist: /org_name/apim/api_version"} |
|
400 |
{"message":"Published/Deprecated API Versions cannot be deleted,
Unpublish/Retire the api first to remove."} |
Unpublish or deprecate the API version to delete it. |