# BeyondTrust BeyondInsight

{% stepper %}
{% step %}

### IP

IP address that you want to connect to. Requests will be sent to this address.
{% endstep %}

{% step %}

### Port

Port number (optional, default: 443).
{% endstep %}

{% step %}

### API Key

To get API Key for Beyond Trust Beyond Insight API:

* Login to Web Console as a BeyondTrust Administrator.
* Navigate to Configuration > General > API registrations
* Click Create API Registration and then API key Policy
* Give the policy a name to identify it and select the authentication rule options relevant to your environment
* Click ‘Add Authentication Rule’ to provide a list of the allowed IP addresses where the API scripts will be run from. If using a proxy/forwarder/load balancer, make sure to allow those as well. If they are not using forwarding rules, the source IP address will not match that of the requestor machine. In this example, we are allowing a large range of IP addresses to make sure this works:
* Once the rule is updated this will make the API connection ‘Active’
  {% endstep %}

{% step %}

### Username

Username that will be used for the Beyond Trust Beyond Insight.
{% endstep %}

{% step %}

### Password

Password that will be used for the Beyond Trust Beyond Insight.
{% endstep %}

{% step %}

### Ignore Workgroups

Excludes the specified workgroup IDs from the search.
{% endstep %}

{% step %}

### Timeout

Amount of time that will be waited for API response. (default: 120)
{% endstep %}

{% step %}

### Is Secure?

Enable this option if the connection will be established over HTTPS.
{% endstep %}
{% endstepper %}


---

# Agent Instructions: 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:

```
GET https://docs.octoxlabs.com/adapters/adapters/beyondtrust-beyondinsight.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.