Delete API
DELETE /apim/{path_to_api}
Overview
This API soft deletes the API. It is recoverable from recycle
bin as it is a soft delete.
Note: As an Org admin, you can use the Recycle Bin to recover
or permanently remove deleted endpoint accounts, files, pipelines, tasks, project spaces,
and projects. Deleted items can be recovered in 30 days unless you delete them
permanently. Learn More about Recycle Bin.
Prerequisites
- Environment (Org) admin permissions
Request
DELETE https://{controlplane_path}/api/1/rest/public/apim/{path_to_api}?{query_parameters}
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:
|
path_to_api |
Required. The path to the SnapLogic API.
Format: Important: The path is case sensitive
|
Query parameters
Key | Type | Description |
---|---|---|
soft_delete |
boolean |
|
Request header
In the request header, specify Basic
for authorization, add your credentials, and specify 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": [],
"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 |
---|---|---|
400 |
{"message":"Published/Deprecated API cannot be deleted,
Unpublish/Retire the api first to remove."} |
Unpublish or deprecate the API to delete it. |
404 |
{"message": "The requested resource at the supplied path does not
exist: /org_name/apim/api_version"} |
|