> For the complete documentation index, see [llms.txt](https://docs.buildings.ability.abb/collection/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.buildings.ability.abb/collection/mandatory-base/platform-core/connect-hub/connectivity-as-a-service/connect-devices-via-restful/configure-restful-connection.md).

# Configure RESTful Connection

## Overview

<figure><img src="/files/lyHx8DxYJm3IXkBqvYiv" alt=""><figcaption></figcaption></figure>

<table data-full-width="true"><thead><tr><th width="68.73329671223956">Symbol</th><th width="242.79998779296875">Description</th><th>Details</th></tr></thead><tbody><tr><td><strong>[A]</strong></td><td>Base URL</td><td>Click to open the "Connections" menu</td></tr><tr><td><strong>[B]</strong></td><td>Name</td><td>Name of the connection</td></tr><tr><td><strong>[C]</strong></td><td>Authentication</td><td>Choose how you want to identify yourself to the API. The requirements for this</td></tr><tr><td><strong>[D]</strong></td><td>Show/hide more options</td><td>Click to show or hide more options</td></tr><tr><td><strong>[E]</strong></td><td>SOCKS5 Host</td><td>Optional: Enter the host for a SOCKS5 proxy server</td></tr><tr><td><strong>[F]</strong></td><td>SOCKS5 Port</td><td>Optional: Enter the port for a SOCKS5 proxy server</td></tr><tr><td><strong>[G]</strong></td><td>SOCKS5 Username</td><td>Optional: Enter the username for a SOCKS5 proxy server</td></tr><tr><td><strong>[H]</strong></td><td>SOCKS5 Password</td><td>Optional: Enter the password for a SOCKS5 proxy server</td></tr><tr><td><strong>[I]</strong></td><td>Save</td><td>Click to save the entries</td></tr><tr><td><strong>[J]</strong></td><td>Add request</td><td>Click to create a new request for the current connection</td></tr><tr><td><strong>[K]</strong></td><td>Base URL</td><td>Click to open the respective request</td></tr></tbody></table>


---

# 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.buildings.ability.abb/collection/mandatory-base/platform-core/connect-hub/connectivity-as-a-service/connect-devices-via-restful/configure-restful-connection.md?ask=<question>&goal=<endgoal>
```

`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.