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:
  • 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": "...",
  "version_paths": [ ... ]
}
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 body

 {
  "response_map": {
    "successful_versions": [ ... ],
    "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