30 Day Challange API Documentation

API-API Version

Number of APIs: 5

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

Gets information about an API's versions.

In Qodex v9 and earlier:

When you create an API, the system creates a single, default API version. You can use this version’s ID with any endpoints that require an API version ID.

2. Create an API version

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

This endpoint is deprecated in Qodex v10 and higher.

Creates a new API version. Include the following request body properties in the version object:

name — Required. A string that contains the API version's name.
source — An object that contains the following properties:
- id — A string that contains an API version's ID to copy to the created API version.
- schema — A boolean value. If true, copy the API definition to the new API version.
- relations — An object that contains the relation types to copy to the new API version. Each property is a boolean value that, if true, copies to the new API version. If you do not include any the following properties, the system does not copy them over (defaults to the false value):
  - monitor
  - mock
  - documentation
  - test
  - environment

3. Get an API version

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

Gets information about an API version.

In Qodex v9 and earlier:

When you create an API, the system creates a single, default API version. You can use this version’s ID with any endpoints that require an API version ID.

4. Update an API version

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

This endpoint is deprecated in Qodex v10 and higher.

Updates an API version. Include the following request body properties in the version object:

name — A string that contains the API version's name.

5. Delete an API version

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

This endpoint is deprecated in Qodex v10 and higher.

Deletes an API version.