For the complete documentation index, see llms.txt. This page is also available as Markdown.

Public API

CybrHawk provides a public REST API that allows customers and partners to programmatically access key platform data. This enables seamless integration with external systems, automation workflows, and custom reporting. Support for interactive actions and additional capabilities will be introduced in future releases.

Authentication

All API requests are authenticated using an API key. Each request must include a valid API key with the appropriate permissions to ensure secure access to CybrHawk resources.

API Key Generation

To get started, navigate to API Keys in the CybrHawk platform and create a new API key with relevant permissions for the target APIs.

Keep your API key secure and avoid sharing it publicly, as it provides access to your tenant’s data.

Usage

CybrHawk exposes its APIs through several scoped public endpoints.

Alert Center

All alert interactions and lifecycle events, including escalations, notifications, and triage.

Permission Requirements: Alert Center

Swagger docs

Agent Interactions

Endpoint Agent information and state, including version, last seen, and OS information.

Permission Requirements: Endpoint Isolation

Swagger docs


Having Trouble?

If you're having any issues with user management, please open a request via the support portal or email our support email at "socv2@cybrhawk.com," and our team will assist you.

Last updated