post
/public_api/v1/endpoints/get_endpoints
Gets a list of all of your endpoints. The response is concatenated using AND condition (OR is not supported).
Required license: Cortex XDR Prevent or Cortex XDR Pro per Endpoint
CURL
curl -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://api-yourfqdn/public_api/v1/endpoints/get_endpoints" \
-d ''
Response
{
"reply": [
{
"agent_id": "<agent_id>",
"agent_status": "DISCONNECTED",
"operational_status": "PROTECTED",
"host_name": "<hostname>",
"agent_type": "Workstation",
"ip": [
"<ip_address>"
],
"last_seen": 1678012587521,
"tags": {
"server_tags": [],
"endpoint_tags": []
},
"users": [
"user"
]
}
]
}
Request
Body
optional
Example:
Object
Responses
Successful response
Body
reply
optional
Array
agent_id
optional
String
agent_status
optional
String
operational_status
optional
String
host_name
optional
String
agent_type
optional
String
ip
optional
Array
of strings
last_seen
optional
Integer
tags
optional
server_tags
optional
Array
of objects
endpoint_tags
optional
Array
of objects
users
optional
Array
of strings
Bad Request. Got an invalid JSON.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
Example:
{"line": 1, "column": 19, "message": "no viable alternative at input '|alter2'"}
err_extra
optional
String
Additional information describing the error.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
Example:
{"line": 1, "column": 19, "message": "no viable alternative at input '|alter2'"}
err_extra
optional
String
Additional information describing the error.
Unauthorized access. User does not have the required license type to run this API.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
Example:
{"line": 1, "column": 19, "message": "no viable alternative at input '|alter2'"}
err_extra
optional
String
Additional information describing the error.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
Example:
{"line": 1, "column": 19, "message": "no viable alternative at input '|alter2'"}
err_extra
optional
String
Additional information describing the error.
Internal server error. A unified status for API communication type errors.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
Example:
{"line": 1, "column": 19, "message": "no viable alternative at input '|alter2'"}
err_extra
optional
String
Additional information describing the error.