GET /version
Endpoint: GET /v1/pdapi/version
Auth: Bearer token
Permission: REST.Version.Read
Purpose
Use this endpoint as a health check and version check for tools, dashboards, and scripts.
Path parameters
None.
Query parameters
None.
Request body
No request body.
Response schema
200 response schema
| Field | Type | Description |
|---|---|---|
Version |
object | PalDefender version details. |
Version object schema:
| Field | Type | Description |
|---|---|---|
Major |
integer | Major version number. |
Minor |
integer | Minor version number. |
Patch |
integer | Patch version number. |
Build |
integer | Build number. |
Version |
string | Short version string. |
VersionLong |
string | Long version string. |
Beta |
boolean | Whether this build is marked as beta. |
Error responses
Error bodies use this shape:
| HTTP | Error code | When it happens |
|---|---|---|
401 |
INVALID_TOKEN |
The Authorization header is missing, malformed, or does not match a configured bearer token. |
403 |
MISSING_PERMISSION |
The token is valid, but it does not include this endpoint permission. |
Examples
Health and version check
Scenarios
- Use it after configuring the REST API token to confirm authentication works.
- Use it before calling endpoints if your tool needs a minimum PalDefender version.
- Use it for monitoring, because it is the smallest read-only request.