API-API Version

Number of APIs: 5

1. Create a version

POST {{baseUrl}}/apis/{{apiId}}/versions

Creates a new API version asynchronously and immediately returns an HTTP 202 Accepted response. The response contains a polling link to the task status API in the Location header.

This endpoint is equivalent to publishing a version in Qodex app, which is the snapshot of API collections and schema at a given point in time.

Include the following properties in the request body:

• name — A string value that contains the version name.
• collections — An array containing all the collections to publish.
• schemas — An array containing the schema to publish.
• branch — A string value that contains the name of the repository branch. This property is required only for Git-linked APIs.

You can include the following optional properties:

• releaseNotes — A string value that contains the Markdown-supported version summary.

---

2. Get all versions

GET {{baseUrl}}/apis/{{apiId}}/versions

Gets all the published versions of an API.

---

3. Get a version

GET {{baseUrl}}/apis/{{apiId}}/versions/{{versionId}}

Gets information about an API version.

Note:

• For API editors, this endpoint returns an HTTP 302 Found status code when the version status is pending. It also returns the /apis/{apiId}/tasks/{taskId} task status response header.
• For API viewers, this endpoint returns an HTTP 404 Not Found when the version status is pending.

---

4. Update a version

PUT {{baseUrl}}/apis/{{apiId}}/versions/{{apiVersionId}}

Updates an API version. Include at least one of the following properties in the request body:

• name — A string value that contains the version name.
• releaseNotes — A string value that contains the Markdown-supported release notes.

Note:

This endpoint returns an HTTP 404 Not Found response when an API version is pending publication.

---

5. Delete a version

DELETE {{baseUrl}}/apis/{{apiId}}/versions/{{versionId}}

Deletes an API version.

Note:

This endpoint returns an HTTP 404 Not Found response when an API version is pending publication.

---