> 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="https://2013058394-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOqGnkz52o2zVUsEGEZGk%2Fuploads%2FjlgCerGL5RGgt9PDsnlk%2FGroup%2019.png?alt=media&amp;token=98433ee1-9883-4648-ac99-7198848e4303" 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
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=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.