API-Release

Number of APIs: 5

1. Get an API release

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

This endpoint is deprecated in Qodex v10 and higher.

Gets information about an API version's release.

---

2. Get all API releases

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

This endpoint is deprecated in Qodex v10 and higher.

Gets information about all of an API version's releases.

---

3. Create an API release

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

This endpoint is deprecated in Qodex v10 and higher.

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

• name — A string value that contains the release name.
• visibility — A string value that contains the release's visibility. One of:
  • private — The release is private.
  • public — The release is public.

You can include the following optional properties:

• summary — A string value that contains the release's summary.
• description — A string value that contains the release's description.
• gitTag — A string value that contains a valid Git tag ID. The tag must exist in the API's connected Git repository.

---

4. Update an API release

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

This endpoint is deprecated in Qodex v10 and higher.

Updates an API version's release. Include at least one of the following properties in the release object:

• name — A string value that contains the release name.
• visibility — A string value that contains the release's visibility. One of:
  • private — The release is private.
  • public — The release is public.
• summary — A string value that contains the release's summary.
• description — A string value that contains the release's description.
• gitTag — A string value that contains a valid Git tag ID. The tag must exist in the API's connected Git repository.

---

5. Delete an API release

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

This endpoint is deprecated in Qodex v10 and higher.

Deletes an API version's release.

---