Deprecate a set of API versions

POST /apim/deprecate_versions

Overview

This API deprecates the specified set of API versions.

Prerequisites

Environment (Org) admin permissions

Request

 POST https://{controlplane_path}/api/1/rest/public/apim/deprecate_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: `uat.snaplogic.com` `emea.snaplogic.com`

Query parameters

None.

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

 
{
  "org_name": "Automation2",
  "version_infos": [
    {
      "path": "/Test/3.0.0",
      "message": "Testing Public API"
    }
  ]
}


Key	Type	Description
`org_name`	string	The name of the SnapLogic Environment/Org.
`version_infos`	array	An array of objects containing information about the API versions.
`path`	string	The path to the API version. Format: `{api_name}/{api_version}`
`message`	string	Optional. A comment about the deprecation.

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: the path to the API version that failed the reason for the failure