A REST API connection stores the address and credentials of an external REST API. Automation rules use it through the callRestApi action, for example to create a ticket in an ITSM tool when a data product is published. The connection is the only place where the target host and the credentials are defined; the automation rule refers to it by its connection key.
Create a connection
Only administrators can create connections.
- Go to Settings > Connections and click New connection.
- Search for REST, select the REST API tile and click Connect.
- On the first step, enter the name, an optional description and the connection type.
- On the second step, fill in the connection settings described below and save the connection.
The type (Shared or Private) makes no difference for a REST API connection. Dawiso always sends the requests itself and does not use the Dawiso Integration Runtime. The connection is not passed to the ingestion service, so it never has data sources.
Connection settings
| Field | Description |
|---|---|
| Connection key | Mandatory, unique among REST API connections (case-insensitive), so servicenow_cmdb and ServiceNow_CMDB cannot both exist. Letters, digits, underscore and hyphen only, up to 100 characters. Fixed after creation: the edit form still shows it as editable, but a changed key is rejected on save. An inactive connection keeps its key reserved; a deleted connection’s key can be reused. |
| Base URL | Mandatory. A complete https:// address with the host and an optional common path prefix, for example https://example.com/api/v2. Rejected: addresses without a scheme, using http://, or with user info, loopback, link-local, or cloud metadata hosts. Do not put a secret in the URL: a query string or fragment is stored and shown as plain text. |
| Authentication type | Mandatory. API key / static token or OAuth2 client credentials. |
| Header name, API key / token, Value prefix | For API key / static token. Dawiso sends the header as the prefix followed by the value, for example Authorization with the prefix Bearer . |
| Token endpoint, Client ID, Client secret, Scope | For OAuth2 client credentials. The token endpoint must use HTTPS. Dawiso requests a token with the client_credentials grant, reuses it while it is valid, and renews it before it expires. Scope is optional. |
| Allow use in automation actions | Off by default. While it is off, automation rules cannot send requests through the connection. |
The form shows the fields of both authentication types at once. Fill in only those of the selected type: a value entered for the other type is dropped when you save.
Secrets
The API key and the client secret are stored encrypted. After you save the connection, they are never returned or shown again. To replace a secret, enter a new value. If you leave the field empty when you edit the connection, the stored secret is kept. The field looks empty when you edit, even though a secret is stored.
Where requests can go
- Requests go only to the base URL of the connection. Automation rules supply a relative path, and Dawiso does not follow redirects.
- Private network addresses are allowed, so internal customer APIs work.
- Loopback, link-local, and cloud metadata addresses are always blocked, also when a host name resolves to one of them.
If an automation rule refers to a connection that does not exist, is inactive, belongs to another provider, or does not allow automation actions, Dawiso skips every object of the action without sending a request. The run log only counts the skipped objects. Installing the package warns only about a missing key or a key of another provider; see the callRestApi action’s Connection setup section.
When saving fails
If Dawiso rejects the settings, the form shows only the message Unsuccessful connection creation, also when you edit an existing connection. The message does not name the field. Check these first:
- The connection key uses only letters, digits, underscore and hyphen, has at most 100 characters, and is not used by another REST API connection.
- The base URL is a complete
https://address. - The fields of the selected authentication type are filled in.
- The connection key of an existing connection is unchanged.
Verify the connection
The REST API connection form has no Test connection button, and saving does not contact the target system. An unreachable host or wrong credentials are therefore not detected when you save. To verify the connection, run an automation rule with a callRestApi action that uses it, and open the run in Settings > Automation > Audit Logs.
Timeouts, retries, and logging
Timeouts and retries are configured on the callRestApi action that uses this connection, not here. See the action’s Retries and result section for the defaults and retry conditions.
The automation run log and Automation Preview report what happened per object, but never log secrets, header values, tokens, the full URL, or the request body. If the connection itself can’t be used (missing, inactive, wrong provider, or not allowed for automation actions), Automation Preview names the problem instead of the address it would call. See the action’s Logging and Preview sections for the full detail.