For AI agents: The complete documentation index is available at /docs/llms.txt. A markdown version of this page is available at /docs/apis/system/retrieve-system-version.md.

Retrieve System Version API

Edit on GitHub
View Markdown
On this page

The Version API is used to retrieve the current version of FusionAuth.

Request#

API Key AuthenticationBasic Authentication using an API Key
Return the FusionAuth system version
GET/api/system/version
OpenAPI Spec

Response#

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
401You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

version String

The version of the running FusionAuth instance.

Example JSON Response
{
  "version": "1.27.0"
}

Related

APIs

Export System Logs API

API documentation for the FusionAuth Export System Logs API.

fusionauth apirest apihttp api
APIs

System API

Learn about the APIs for retrieving and updating the system configuration.

fusionauth apirest apihttp api
APIs

Rebuild the Elasticsearch index API

API documentation for the FusionAuth Rebuild the Elasticsearch index API.

fusionauth apirest apihttp api
APIs

Retrieve System Health API

API documentation for the FusionAuth Retrieve System Health API.

fusionauth apirest apihttp api