Publish a set of API versions
POST /apim/publish_versions
Overview
This API publishes the specified set of API versions.
Prerequisites
- Org admin (Environment admin) permissions
Request
POST https://{pod_path}/api/1/rest/public/apim/publish_versions
Path Parameters
Key | Description |
---|---|
pod_path |
Required. The path to your SnapLogic pod.
Example: |
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": "...",
"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: |
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 If |
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:
|