API profiles
An API profile is a REST server that agents call through the api command. The profile holds the server's base URL, the headers sent on every call, and the connection pool used.
Settings
| Field | Type | Default | Description |
|---|---|---|---|
namerequired | string | The name this profile is referred to by, in agents and in other configuration. | |
doc | string | Free-text notes about this profile, for whoever maintains the configuration. | |
urlrequired | dynamic string | The base URL of this API server. | |
addPath | "can" | "cannot" | "must" | "can" | Whether command can add path to the base URL |
headers | object of string → ValueModel | Headers sent with every call, including any authentication. | |
canAddHeaders | boolean | false | Whether more headers can be added by the command. |
queryParams | object of string → ValueModel | Query parameters sent with every call | |
canAddQueryParams | boolean | false | Whether more query parameters can be added by the command. |
connectionPoolName | string | "default" | The connection pool used for calls to this server. |
The URL and the header values are dynamic strings, so credentials can come from sys.secret instead of being stored in the profile. Headers set on the command are added to the profile's headers. Where both set the same header, the profile's value wins.