REST connection
A REST connection is a connection to a REST api that can be reused from transforms like the REST client.
The REST connection is a generic purpose metadata item. A transform or action that uses a REST connection can override its properties when required.
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. |
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.