Publish a set of API versions

POST /apim/publish_versions

Overview

This API publishes the specified set of API versions.

Prerequisites

Environment (Org) admin permissions

Request

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

Query parameters

None.

Request header

Basic authentication

In the request header, specify Basic for authorization, add your credentials (Login and password of your SnapLogic user or service account), and specify application/json for content type. For more details on accounts refer to Manage accounts.


Authorization: Basic {base64_encoded <email>:<password>}
Content-Type: application/json

Example of Basic authenthication using Postman

Request body

 {
  "org_name": "...",
  "versions_info": [
    {
      "path": "...",
      "publish_info": { "contact_email": "..." },
      "allow_subscriptions": true,
      "auto_approve": true,
      "is_yaml": true,
      "spec": "..."
    }
  ]
}


Key	Type	Description
`org_name`	string	The name of the SnapLogic Environment/Org.
`versions_info`	array	An array of objects containing information about the API versions.
`path`	string	The path to the API version. Format: `{api_name}/{api_version}`
`publish_info`.`contact_email`	string	The email address that API consumers can contact about the API.
`allow_subscriptions`	Boolean	To allow API consumers to subscribe to the API version, set to `true`.
`auto_approve`	Boolean	To automatically approve subscriptions, set to `true`.
`is_yaml`	Boolean	If `spec` is in YAML format, set to `true`. If `spec` is in JSON format, set to `false`.
`spec`	string	The complete Open API Specification (OAS) in either JSON or YAML format.

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