To use the NDR API, you need a valid user account on the NDR appliance with the UI/API role. You obtain a token that lasts for multiple consecutive requests.
Note
The user account with the UI/API role must be created on the NDR appliance before you can establish a session between the remote server and the NDR appliance. For more information about setting up user accounts on the NDR appliance, see the Network Detection and Response System Administration Guide.
By default, tokens expire after 24 hours. You can use the command-line interface (CLI) to change these defaults. For instructions on accessing the CLI, see the Network Detection and Response System Administration Guide or the Network Detection and Response User Guide.
Note
The examples in this document use tokens. If using port 443, you can also use basic authentication in place of tokens.
To check if your current session is still active, use the session request.
After you have finished using the NDR API, use the log out request.
Note
Trellix highly recommends that you log out of any session you open after you have finished.
The following authentication endpoints are available:
POST https://<IA_IP_address>:<port_number>/loginPOST https://<IA_IP_address>:<port_number>/sessionPOST https://<IA_IP_address>:<port_number>/logoutGET https://<IA_IP_address>:<port_number>/config/v1/auth/x509/statePUT https://<IA_IP_address>:<port_number>/config/v1/auth/x509/stateGET https://<IA_IP_address>:<port_number>/config/v1/auth/x509/ocspUpdate OCSP configuration: Request
PUT https://<IA_IP_address>:<port_number>/config/v1/auth/x509/ocspGET https://<IA_IP_address>:<port_number>/config/v1/auth/x509/crlUpdate CRL configuration: Request
PUT https://<IA_IP_address>:<port_number>/config/v1/auth/x509/crlGET https://<IA_IP_address>:<port_number>/config/v1/auth/x509/crl/filePOST https://<IA_IP_address>:<port_number>/config/v1/auth/x509/crl/fileDELETE https://<IA_IP_address>:<port_number>/config/v1/auth/x509/crl/fileUpdate CRL refresh interval: Request
POST https://<IA_IP_address>:<port_number>/config/v1/auth/x509/crl/refreshClient CA certificate configuration: Request
GET https://<IA_IP_address>:<port_number>/config/v1/auth/x509/client/caUpdate CA certificate: Request
POST https://<IA_IP_address>:<port_number>/config/v1/auth/x509/client/caDelete certificate authority: Request
DELETE https://<IA_IP_address>:<port_number>/config/v1/auth/x509/client/caGenerate certificate signing request: Request
POST https://<IA_IP_address>:<port_number>/config/v1/auth/x509/client/csrReplace signed client certificate: Request
POST https://<IA_IP_address>:<port_number>/config/v1/auth/x509/client/certDelete client certificate: Request
DELETE https://<IA_IP_address>:<port_number>/config/v1/auth/x509/client/certGET https://<IA_IP_address>:<port_number>/config/v1/auth/x509/client/certPOST https://<IA_IP_address>:<port_number>/config/v1/auth/x509/client/p12LDAP authentication configuration: Request
GET https://<IA_IP_address>:<port_number>/config/v1/auth/x509/authorizationUpdate LDAP authentication configuration: Request
PUT https://<IA_IP_address>:<port_number>/config/v1/auth/x509/authorizationServer certificate status: Request
GET https://<IA_IP_address>:<port_number>/config/v1/x509/serverGenerate server certificate signing request: Request
POST https://<IA_IP_address>:<port_number>/config/v1/x509/server/csrUpload custom server certificate: Request
POST https://<IA_IP_address>:<port_number>/config/v1/x509/server/certCA certificate status: Request
GET https://<IA_IP_address>:<port_number>/config/v1/x509/caPOST https://<IA_IP_address>:<port_number>/config/v1/x509/ca/certDELETE https://<IA_IP_address>:<port_number>/config/v1/x509/ca/cert