Authentication

Authentication

The HyperArmor API Documentation supports the following methods to authenticate requests. Individual operations in the documentation will include their specific authentication types.


sessionCookie

Console session cookie set by POST /api/v1/auth/login (HttpOnly, Secure, SameSite=Strict). Browsers send it automatically; there is no token to copy.


Type : apiKey
In : cookie
Name : VTP_SESSION

xsrfToken

CSRF token: the value of the XSRF-TOKEN cookie, echoed in this header. Required on POST, PUT, PATCH and DELETE requests; a missing or wrong value answers 403 CSRF_ERROR. Read-only requests do not need it.


Type : apiKey
In : header
Name : X-XSRF-TOKEN

bearerAuth

An API token created in Users and Access, API Tokens. It is returned once, when it is created, and cannot be shown again. Send it as Authorization: Bearer ; no session cookie or X-XSRF-TOKEN header is needed. In the Authorize dialog of this documentation page paste only the token, without the word Bearer; this page cannot send requests (Try it out is disabled), so use curl, Postman or Insomnia to call the API with a token, and to read this page or openapi.yaml without a browser login. Only the approved routes accept it: the Alerts operations that list bearerAuth in their security, and the read-only API documentation page and contract (GET and HEAD under /api/v1/docs). Every other route answers 403 API_TOKEN_NOT_PERMITTED.


Type : http
Scheme : bearer
Bearer Format : vtp_ opaque API token