> For the complete documentation index, see [llms.txt](https://docs.octoxlabs.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.octoxlabs.com/adapters/adapters/upguard.md).

# UpGuard

## Connection Requirements

### 1 - Domain

The base domain of the UpGuard API.

{% hint style="info" %}
**Default:** cyber-risk.upguard.com
{% endhint %}

### 2 - API Key

Your UpGuard organization API key, used for authentication.

To create an API key:

1. Sign in to the UpGuard platform with an administrator account.
2. Click the Settings icon in the top-right corner.
3. Click the **API** tab.
4. Click **Create New API Key**.
5. Copy the generated key. You can manage or delete keys from this tab.

{% hint style="info" %}
**Permissions**

Only administrator accounts can access and create API keys within the UpGuard platform. Ensure your account has administrator access before proceeding.
{% endhint %}

{% hint style="warning" %}
**Security Notice**

Your UpGuard API key is sensitive — never share it publicly. Only use your API key with software from verified, trusted providers to safeguard your UpGuard account.
{% endhint %}

### 3 - HTTPS Proxy

Proxy URL (optional).

### 4 - Timeout

The amount of time (in seconds) to wait for API responses. (default: 30)

### 5 - Thread Count

This adapter works in a multi threaded manner. This field represents the number of parallel threads that is going to be constructed for sending API requests (default: **32**, min: **1**, max: **32**).

### 6 - Sleep Time

Number of seconds to wait during construction of parallel threads. By increasing this value, resource consumption is reduced at the cost of longer discovery time (default: **0**).

### 7 - Fetch Users

Include user risk inventory in the discovery (optional, default: **True**).

### 8 - Fetch Domains

Include domain inventory with detail enrichment in the discovery (optional, default: **True**).

### 9 - Fetch Services

Include vendor/service inventory in the discovery (optional, default: **True**).

{% hint style="danger" %}
**Attention**

Please perform a connection test to ensure there is a valid connection to the UpGuard API. When the discovery operation is finalized you will be able to see the details on Assets page.
{% endhint %}