API-Release

Number of APIs: 5

1. Create Release

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

This call creates a new release in the specified API.

The request body should contain a release object which should have fields:

name	Required. Name of the Release
summary	Optional. Summary of the release
description	Optional. Description of the release
visibility	Required. Value can be private or public
gitTag	Optional This should be a valid Git tag in the repository connected with the API version

Response contains a release object with all the details related to the created release, namely, id, name, summary, description, visbility and gitTag.

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

---

2. Delete release

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

---

3. Get a Release

GET https://api.getpostman.com/apis/:apiId/versions/:apiVersionId/releases/:releaseId

This endpoint can be called to get information about a particular Release of the given API Version.

---

4. Update Release

PATCH https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/releases/{{releaseId}}

This call updates an existing release in the specified API Version.

The request body should contain a release object which can have the following fields:

name	Optional. Name of the Release
summary	Optional. Summary of the release
description	Optional. Description of the release
visibility	Optional. Value can be either private or public
gitTag	Optional This should be a valid Git tag in the repository connected with the API version

Response contains a release object with all the details related to the updated release, namely, id, name, summary, description, visbility and gitTag.

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

---

5. Get all releases

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

---