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.
• Используйте его для мониторинга, поскольку это самый маленький запрос, доступный только для чтения.