API versions
In Swarm 2019.3, we started adding a new set of v10 APIs to Swarm. These provide a new endpoint and response pattern, and are designed for use with the new rich User Interface that is being introduced in 2020. The v9 APIs will continue to be available for some time to come, but their functionality will be duplicated and expanded in the v10 APIs over the next few releases.
v10 does not currently provide a full set of features, so it is recommended that you use v9 for now if the features that you need are not present in v10.
-
Support for APIs older than v9 will be removed in the Swarm 2022.2 release.
- Swarm will continue to support the v9 APIs and you can continue to use them if you prefer.
- Any improvements made in the migration to v10 will not be backported to v9.
- New API endpoints will be created as v10 and will not be backported to v9.
-
In the next release of Swarm, we will introduce a new set of v11 APIs. These will refine and extend the v10 APIs, and further standardize the endpoint and response pattern.
-
The v10 APIs will continue to be available for some time to come.
-
Any improvements made in the migration to v11 will not be backported to v9 or v10.
-
New API endpoints will be created as v11 and will not be backported to v9 or v10.
-
Current API versions
| API version | Swarm Release | Date | Description |
|---|---|---|---|
| v10 | 2019.3 | October 2019 | Include support for integration with CI tools. |
|
v9 |
2018.1 |
April 2018 |
Include support for append and replace changelist to a review, 2 Factor Authentication and mark a comment as read. |
Deprecated API versions
Support for APIs older than v9 will be removed in the Swarm 2022.2 release.
| API version | Swarm Release | Date | Description |
|---|---|---|---|
|
v8 |
2017.4 |
December 2017 |
Include support for default reviewers on a project or project branch. |
|
v7 |
2017.3 |
October 2017 |
Include support for groups as participants of a review and groups as moderators of a project branch. |
|
v6 |
2017.1 |
May 2017 |
Include support for activity dashboard, archiving of inactive reviews, cleaning completed reviews and for voting reviews up and down. |
|
v5 |
2016.3 |
December 2016 |
Include support for limiting comments to a specific review version. |
|
v4 |
2016.2 |
October 2016 |
Include support for private projects, as well as file-level and line-level inline comments. |
|
v3 |
2016.1 SP1 |
September 2016 |
Include new endpoint for comments. |
|
v2 |
2016.1 |
May 2016 |
Include new endpoints for projects, groups, etc. |
|
v1.2 |
2015.3 |
October 2015 |
Add author filter to the list reviews endpoint. |
|
v1.1 |
2014.4 |
January 2015 |
Addition of required reviewers, and |
|
v1 |
2014.3 |
July 2014 |
Initial release. |
Get Swarm version information
The version endpoint lets you see the currently-installed Swarm version, the year of release, and the included API versions.
GET /api/version
Get Swarm version and API versions:
https://myswarm.url/api/version
Example response:
{"apiVersions":[1,1.1,1.2,2,3,4,5,6,7,8,9,10],"version":"SWARM\/2020.2\/2065513 (2021\/01\/19)","year":"2020"}
year refers to the year of the Swarm release, not necessarily the current year.
