Netwrix Privilege Secure for Discovery API
REST API for Netwrix Privilege Secure for Discovery.
Base path. All endpoints are under /api/v1 on your server.
Authentication. Call POST /login (or POST /api-keys/auth with an API key) to get a JSON Web Token (JWT). Send it on every other call as Authorization: Bearer <access-token>. The server also accepts the x-access-token header. The token lifetime is set by the administrator; read expires in the sign-in response. There is no refresh endpoint, so sign in again when the token expires.
Roles. The description of each operation ends with or contains a Required role line: superadmin, admin or user. Administrator operations accept superadmin and admin; user operations accept all three.
Request bodies. The server parses both application/json and application/x-www-form-urlencoded bodies.
Paging. Operations that take limit and page are paged; other list operations return every record in one response. limit defaults to 100, and values above the maximum of 1000 are reduced to 1000. A limit below 1 or a non-numeric limit returns an empty page instead of an error. page starts at 1. Paged responses carry X-Pagination-* and Link headers; each operation lists the headers it sends. Add inlinePageInfo to wrap the body as {limit, page, pages, total, links, docs}; a few operations, such as GET /config/integrations/edr/bulk-scans, always return a wrapped body with their own paging ({docs, page, pages, total, limit}). Many lists also accept an advanced query for filtering, plus sort and select.
Errors. Errors use one of four shapes: {name, message, context, code}, {error}, {message}, or a plain-text 404 for an invalid :id. Each operation lists the shapes it can return.
Authentication
- HTTP: Bearer Auth
JWT access token from POST /login or POST /api-keys/auth, sent as Authorization: Bearer <access-token>.
The server also accepts the token in the x-access-token header (and token in the body or query string),
but the Authorization header is preferred. Roles are superadmin, admin and user; each operation lists
the role it needs.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |