Overview

The Version API is used to retrieve the currently running OneDB API version.

This endpoint is useful for administrators, client applications, integration services, and support teams to verify the installed OneDB API version without accessing the server directly.

This API is available starting from OneDB API v1.1.0.

Endpoint

https://<onedb-hostname>:8443/api/v1/version

Method

GET

Authentication

This API requires a valid access token.

The access token must be included in the request header using the Bearer authentication scheme.

Authorization: Bearer <token>

Successful Response

{
  "id": 1,
  "message": "Version retrieved successfully",
  "success": true,
  "version": "1.1.0"
}

Response Fields

Failed Response

If the request is sent without a valid access token, OneDB API returns an authentication error.

{
  "id": 4,
  "message": "Full authentication is required to access this resource",
  "success": false
}

Example Request Using cURL

curl -X GET "https://<onedb-hostname>:8443/api/version" \
  -H "Authorization: Bearer <token>"

Example Response

{
  "id": 1,
  "message": "Version retrieved successfully",
  "success": true,
  "version": "1.1.0"
}

Usage Notes

• This API can be used to verify the active OneDB API version after installation, update, or upgrade.
• This API is available starting from OneDB API v1.1.0.
• Existing APIs from v1.0.0 remain unchanged and continue to be supported in the OneDB API v1 release family.
• The returned version represents the running OneDB API service version.
• If the request fails, verify that the access token is valid and has not expired.