cortex-xdr-client icon indicating copy to clipboard operation
cortex-xdr-client copied to clipboard

A python-based API client for Cortex XDR API.

About the cortex-xdr-client ###########################

A python-based API client for Cortex XDR API <https://cortex-panw.stoplight.io/docs/cortex-xdr/axpm6b98x4p18-cortex-xdr-api-overview>__.

Currently, it supports the following Cortex XDR Prevent & Pro APIs:

Alerts API:

  • Get Alerts <https://cortex-panw.stoplight.io/docs/cortex-xdr/813e387002342-get-all-alerts>__

Downloads API:

  • Download File <https://cortex-panw.stoplight.io/docs/cortex-xdr/2932f29d2ccdd-file-retrieval-details>__

Endpoints API:

  • Get All Endpoints <https://cortex-panw.stoplight.io/docs/cortex-xdr/89535019b740f-get-all-endpoints>__
  • Get Endpoint <https://cortex-panw.stoplight.io/docs/cortex-xdr/b149d40bd4c51-get-endpoint>__
  • Isolate Endpoints <https://cortex-panw.stoplight.io/docs/cortex-xdr/9c730a966cdd8-isolate-endpoints>__
  • Unisolate Endpoints <https://cortex-panw.stoplight.io/docs/cortex-xdr/c719336adb46b-unisolate-endpoints>__
  • Scan Endpoints <https://cortex-panw.stoplight.io/docs/cortex-xdr/2e666ee0be1c6-scan-endpoints>__
  • Set an Endpoint Alias <https://cortex-panw.stoplight.io/docs/cortex-xdr/c1ff89fa71c74-set-an-endpoint-alias>__
  • Retrieve File <https://cortex-panw.stoplight.io/docs/cortex-xdr/08b1ba9fcfae0-retrieve-file>__
  • Quarantine File <https://cortex-panw.stoplight.io/docs/cortex-xdr/76e8cca7fcb2e-quarantine-files>__

Incidents API:

  • Get Incidents <https://cortex-panw.stoplight.io/docs/cortex-xdr/a61eadc13dd54-get-all-incidents>__
  • Get Extra Incident Data <https://cortex-panw.stoplight.io/docs/cortex-xdr/5a2fff98016d5-get-extra-incident-data>__

Indicators API:

  • Insert Simple Indicators JSON <https://cortex-panw.stoplight.io/docs/cortex-xdr/24e778d89726d-insert-simple-indicators-json>__

Response Actions API:

  • Get Action Status <https://cortex-panw.stoplight.io/docs/cortex-xdr/9782594f400c3-get-action-status>__

Scripts API:

  • Get Scripts <https://cortex-panw.stoplight.io/docs/cortex-xdr/6c41fe0732805-get-scripts>__
  • Get Script Metadata <https://cortex-panw.stoplight.io/docs/cortex-xdr/52ea90b5f5c72-get-script-metadata>__
  • Get Script Execution Status <https://cortex-panw.stoplight.io/docs/cortex-xdr/28073c365903b-get-script-execution-status>__
  • Get Script Execution Results <https://cortex-panw.stoplight.io/docs/cortex-xdr/fa2ca3b1ff49b-get-script-execution-results>__
  • Get Script Execution Result Files <https://cortex-panw.stoplight.io/docs/cortex-xdr/0fb66ea9988ff-get-script-execution-result-files>__
  • Run Script <https://cortex-panw.stoplight.io/docs/cortex-xdr/7223bea7d2bea-run-script>__
  • Run Snippet Code Script <https://cortex-panw.stoplight.io/docs/cortex-xdr/083859c8c6729-run-snippet-code-script>__

XQL API:

  • Start XQL <https://cortex-panw.stoplight.io/docs/cortex-xdr/ecc87ad01e173-start-an-xql-query>__
  • Get XQL Results <https://cortex-panw.stoplight.io/docs/cortex-xdr/be3d47e8dce5a-get-xql-query-results>__
  • Get XQL Result Stream <https://cortex-panw.stoplight.io/docs/cortex-xdr/155abd6ca4b4d-get-xql-query-results-stream>__

Contributing:

See CONTRIBUTING.md <./CONTRIBUTING.md>__ for details.