Update an API Version

PUT

/apis/{apiId}/versions/{apiVersionId}

APIAPI Version

This call updates an existing API Version.

Request body should contain a version object with the fields which need to be updated. Only field which can be updated is name.

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

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.getpostman.com/apis//versions/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "version": {
        "name": "2.0"
    }
}'

Response Example

{
  "version": {
    "api": "2b95d07c-8379-4bd1-924f-e7e1af185284",
    "createdAt": "2019-07-26T11:24:15.000Z",
    "createdBy": "12",
    "id": "d71cf403-c549-4c7c-9dc6-a6a105acf67c",
    "name": "2.0",
    "updatedAt": "2019-08-09T09:27:36.000Z",
    "updatedBy": "5665"
  }
}

Request

Path Params

apiId

string

required

apiVersionId

string

required

Body Params application/json

version

object

optional

name

string

optional

Example:

2.0

Examples

Responses

🟢200Update an API version

application/json

Body

version

object

optional

api

string

optional

Example:

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

createdAt

string

optional

Example:

2019-07-26T11:24:15.000Z

createdBy

string

optional

Example:

string

optional

Example:

d71cf403-c549-4c7c-9dc6-a6a105acf67c

name

string

optional

Example:

2.0

updatedAt

string

optional

Example:

2019-08-09T09:27:36.000Z

updatedBy

string

optional

Example:

5665

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

Get an API Version

Get contract test relations