Get All Endpoints
Get a list of all endpoints.
Synopsis
URI | /public_api/v1/endpoints/get_endpoints/ |
HTTP Method | POST |
Required License | Cortex XDR Prevent or Cortex XDR Pro per Endpoint |
Request Fields
The body of this request
contains an empty JSON object.
Request Example
curl -X POST https://api-{fqdn}/public_api/v1/endpoints/get_endpoints \ -H "x-xdr-auth-id:{API_KEY_ID}" \ -H "Authorization:{API_KEY}" \ -H "Content-Type:application/json" \ -d '{}'
Code copied to clipboard
Unable to copy due to lack of browser support.
Success Response
Upon success,
the HTTP response code is 200. In addition, this API returns a JSON
object containing the query status, as well as an array of JSON
objects, each of which represents a single endpoint.
Field | Description |
|---|---|
reply | JSON object containing the query result. |
agent_id | Endpoint ID |
agent_status | Endpoint status |
host_name | Name of endpoint host |
agent_type | Type pf endpoint |
ip | List of strings displaying the Endpoint IP
address |
Success Response Example
{ "reply":[ { "agent_id":"<agent ID>", "agent_status":"LOST", "host_name":"EX2", "agent_type":"Server", "ip":<IP address> }, { "agent_id":"<agent ID>", "agent_status":"LOST", "host_name":"EX1", "agent_type":"Server", "ip":<IP address> }, { "agent_id":"<agent ID>", "agent_status":"CONNECTED", "host_name":"<host name>", "agent_type":"Workstation", "ip":<IP address> }, { "agent_id":"<agent ID>", "agent_status":"CONNECTED", "host_name":"<host name>", "agent_type":"Workstation", "ip":<IP address> }, { "agent_id":"<agent ID>", "agent_status":"CONNECTED", "host_name":"<host Name>", "agent_type":"Workstation", "ip":<IP address> }, { "agent_id":"<agent ID>", "agent_status":"LOST", "host_name":"<host name>", "agent_type":"Workstation", "ip":<IP address> }, { "agent_id":"<agent ID>", "agent_status":"DISCONNECTED", "host_name":"<host name>", "agent_type":"Workstation", "ip":<IP address> } ] }
Code copied to clipboard
Unable to copy due to lack of browser support.
Error Response
Upon error,
the reply includes an HTTP response code, an error message, and
additional information describing the error. The HTTP response code
is one of the following:
Field | Description |
|---|---|
400 | Bad Request. Got an invalid JSON. |
401 | Unauthorized access. An issue occurred during authentication.
This can indicate an incorrect key, id, or other invalid authentication
parameters. |
402 | Unauthorized access. User does not have the
required license type to run this API. |
403 | Forbidden access. The provided API Key does
not have the required RBAC permissions to run this API. |
500 | Internal server error. A unified status for
API communication type errors. |
Error Response Format
{"reply": {"err_code": STATUS_CODE, "err_msg": GENERAL_MESSAGE, "err_extra": EXTRA_DATA}}
Code copied to clipboard
Unable to copy due to lack of browser support.
Recommended For You
Recommended Videos
Recommended videos not found.
