> For the complete documentation index, see [llms.txt](https://docs.threatdefence.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.threatdefence.com/platform-management/public-api.md). # Public API ThreatDefence 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 ThreatDefence resources. ### API Key Generation To get started, navigate to API Keys in the ThreatDefence 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 ThreatDefence exposes it's APIs through a number of scoped public endpoints. #### Alert Center All alert interactions and lifecycle events, including escalations, notifications, and triage. Permission Requirements: `Alert Center` [Swagger docs](https://portal.threatdefence.io/docs/ac/index.html#/) #### Agent Interactions Endpoint Agent information and state, including version, last seen, and OS information. Permission Requirements: `Endpoint Isolation` [Swagger docs](https://portal.threatdefence.io/docs/agents) *** ## 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 "" and our team will assist you. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.threatdefence.com/platform-management/public-api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.