Create a version

POST {{baseUrl}}/apis/{{apiId}}/versions

Creates a new API version asynchronously and immediately returns an HTTP 202 Accepted response. The response contains a polling link to the task status API in the Location header.

This endpoint is equivalent to publishing a version in Qodex app, which is the snapshot of API collections and schema at a given point in time.

Include the following properties in the request body:

• name — A string value that contains the version name.
• collections — An array containing all the collections to publish.
• schemas — An array containing the schema to publish.
• branch — A string value that contains the name of the repository branch. This property is required only for Git-linked APIs.

You can include the following optional properties:

• releaseNotes — A string value that contains the Markdown-supported version summary.

Request Body

{"name"=>"{{apiReleaseName}}", "releaseNotes"=>"{{apiReleaseDescription}}", "collections"=>[{"id"=>"{{collectionId}}"}], "schemas"=>[{"id"=>"{{schemaId}}"}]}

HEADERS