# REST connection

## REST connection

![rest](/files/h80C86ISIZ5RePS0iGaw)

A REST connection is a connection to a REST api that can be reused from transforms like the [REST client](/data-shaper-1.21/knowing-the-data-shaper-designer/pipelines/transforms/rest.md).

The REST connection is a generic purpose metadata item. A transform or action that uses a REST connection can override its properties when required.

### Related Plugins

[REST client](/data-shaper-1.21/knowing-the-data-shaper-designer/pipelines/transforms/rest.md)

### Options

| Option                    | Description                                                                                                                                                       |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name                      | The name to be used for this REST connection                                                                                                                      |
| Base URL                  | The URL to use as the base URL for any API calls. The base URL will need to be appended from client transforms or actions that use it to make detailed API calls. |
| Test URL                  | A full URL that can be used to test this REST connection. If no test URL is specified, the base URL will be used to perform connection tests.                     |
| Authorization header name | The Authentication/Authorization header name to use for the connection.                                                                                           |
| Authorization prefix      | An (optional) prefix to use for the authentication/authorization header value (e.g. `Bearer`)                                                                     |
| Authorization value       | The Authentication/Authorization header value to use for the connection. This could be a token, an API key etc.                                                   |

Use the `Test` button to authenticate against the test or base URL, using the authentication/authorization header name, and (prefix + ) value.

### Samples

None


---

# 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.primeur.com/data-shaper-1.21/knowing-the-data-shaper-designer/index-2/rest-connection.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.