System Health Check

Perform a health check of your
Cortex
XDR
environment.

Synopsis

URI
/public_api/v1/healthcheck/
HTTP Method
GET
Required License
Cortex XDR Prevent, Cortex XDR Pro per Endpoint, or Cortex XDR Pro per TB

Description

Perform a health check of your
Cortex
XDR
environment.

Success Response

Upon success, the HTTP response code is 200.
Field
Description
status
Displays the condition of your Cortex environment.
Success Response Example
{'status': 'available'}

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}}

Recommended For You