Deprecate a set of API versions

POST /apim/deprecate_versions

Overview

This API deprecates the specified set of API versions.

Prerequisites

  • Org admin (Environment admin) permissions

Request

 POST https://{pod_path}/api/1/rest/public/apim/deprecate_versions

Path Parameters

Key Description
pod_path Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

Query Parameters

None.

Request Header

Specify Basic for authorization and application/json for content type.

 Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json

Request Body

 {
  "org_name": "...",
  "version_infos": [
    {
      "path": "...",
      "message": "..."
    }
  ]
}
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 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