Postman API

Create API Version

POST

/apis/{apiId}/versions

APIAPI Version

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.getpostman.com/apis//versions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "version": {
        "name": "1.0",
        "source": {
            "id": "{{apiVersionId}}",
            "relations": {
                "documentation": true,
                "mock": true,
                "monitor": true
            },
            "schema": true
        }
    }
}'

Response Example

{
  "version": {
    "api": "2b95d07c-8379-4bd1-924f-e7e1af185284",
    "id": "d71cf403-c549-4c7c-9dc6-a6a105acf67c",
    "name": "1.0"
  }
}

Request

Path Params

apiId

string

required

Body Params application/json

version

object

optional

name

string

optional

Example:

1.0

source

object

optional

Examples

Responses

🟢200Create API version

application/json

Body

version

object

optional

api

string

optional

Example:

2b95d07c-8379-4bd1-924f-e7e1af185284

string

optional

Example:

d71cf403-c549-4c7c-9dc6-a6a105acf67c

name

string

optional

Example:

1.0

Modified at 2023-08-15 05:41:03

Get All API Versions

Delete an API Version