> 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/siem-integrations/vulnerability-scanners/upguard.md).
# UpGuard
**Introduction**
UpGuard Cyber Risk is a third-party risk management and security ratings platform used by organizations to continuously monitor cyber risk posture, security findings, and vendor risk events. This guide provides instructions for integrating the UpGuard Cyber Risk API into the ThreatDefence SIEM platform, enabling UpGuard notifications to be ingested, normalized, and converted into SIEM events.
The integration assumes access to an UpGuard Cyber Risk account with API access enabled.
UpGuard provides access to resources (data entities) through a RESTful API. The ThreatDefence SIEM platform uses the API to make authenticated HTTP requests to retrieve public notifications data.
UpGuard Cyber Risk API endpoints follow this general structure:
`https:///api/`
`domain example:`
All API requests must be authenticated using an API Key provided by UpGuard, with the follwoig permissions enabled for the API Key.
* `Admin`
* `BreachRisk`
* `IdentityBreaches`
For information on generating an API key, refer to the UpGuard documentation:\
[https://www.upguard.com/platform/documentation/api](https://help.upguard.com/en/articles/8060003-how-to-authenticate-with-your-upguard-api-key)
**Integration Steps**
To activate the integration, supply the following information to your ThreatDefence representative:
* Your UpGuard domain (e.g. cyber-risk.upguard.com)
* Your generated API Key with permissions enabled.
---
# 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/siem-integrations/vulnerability-scanners/upguard.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.
