POST /apis/{apiId}/versions

This call creates a new API version in the specified API.

Request body should contain a version object which should have fields:

name

Required. Name of the API Version

source

If specified, it will copy the contents of the specified api version to create a new api verison.

id	Required. Id of the apiversion from where the details are to be copied
schema	Boolean. If true then copies the schema from the specified api version
relations	Object. {"<relationType>": true/false}. Allowed relation types are `mock`, `monitor`, `documentation`, `contracttest`, `integrationtest`, `testsuite`, `environment` Relation types which should be copied over to the new api verison

Response contains a version object with all the details related to the created API Version, namely, id, name, api.

Requires API Key as X-Api-Key request header or apikey URL query parameter.

Servers

https://api.getpostman.com

Path parameters

Name	Type	Required	Description
`apiId`	String	Yes

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required
`version`	Object	No
`version.source`	Object	No
`version.source.id`	String	No
`version.source.relations`	Object	No
`version.source.relations.documentation`	Boolean	No
`version.source.relations.mock`	Boolean	No
`version.source.relations.monitor`	Boolean	No
`version.source.schema`	Boolean	No
`version.name`	String	No

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.

All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.

Pricing Templates Integrations Blog Contact Us Help

Terms of Service Privacy Policy