Create API Version

POST https://api.getpostman.com/apis/{{apiId}}/versions

Create API Version

Creates a new API version.

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.

Overview

Body tab

• 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.

You can include the following optional properties:

• releaseNotes — A string value that contains the Markdown-supported version summary.
• branch - A string value that contains the name of the repository branch. This property is required only for Git-linked APIs.

Pre-request Script tab

Sends a message to the Console that the Request is starting to create a new API version.

Tests tab

Checks for a 202 HTTP response to confirm that the new API Version has been created.

Request Body

{"name"=>"ApiVersion v{{today}}", "releaseNotes"=>"This is for version {{today}}", "collections"=>[{"id"=>"{{collectionUid}}"}], "schemas"=>[{"id"=>"{{schemaId}}"}]}

HEADERS