コンテンツにスキップ

GET /version

エンドポイント: GET /v1/pdapi/version

認証: ベアラートークン

許可: REST.Version.Read

目的

このエンドポイントは、ツール、ダッシュボード、およびスクリプトのヘルス チェックとバージョン チェックとして使用します。

パスパラメータ

なし。

クエリパラメータ

なし。

リクエストボディ

リクエスト本文がありません。

応答スキーマ

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": {
        "Code": "ERROR_CODE",
        "Message": "Human-readable message",
        "Details": {}
    }
}
HTTP エラーコード それが起こったとき
401 INVALID_TOKEN Authorization ヘッダーが欠落しているか、形式が不正であるか、構成されたベアラー トークンと一致しません。
403 MISSING_PERMISSION トークンは有効ですが、このエンドポイント権限が含まれていません。

例

ヘルスとバージョンのチェック

GET /v1/pdapi/version

シナリオ

  • REST API トークンを構成した後に使用して、認証が機能することを確認します。
  • ツールに最小 PalDefender バージョンが必要な場合は、エンドポイントを呼び出す前にこれを使用します。
  • 最小の読み取り専用リクエストであるため、監視に使用します。