Install Guide
Prerequisites
Prepare the endpoint URL and authentication credentials for the target REST API before creating a connect profile.
Profile Configuration
Create a connect profile of type http with the following settings:
| Option | Required | Description |
|---|---|---|
| Endpoint | Yes | Base URL (e.g. https://api.example.com) |
| Auth Type | Yes | Authentication type: Bearer, Basic, or None |
| Token | Conditional | Bearer token or API key. Required when Auth Type is Bearer |
| Header Name | No | Custom auth header name (e.g. X-API-Key). If not set, uses Authorization: Bearer {token} |
| Username | Conditional | Username. Required when Auth Type is Basic |
| Password | Conditional | Password. Required when Auth Type is Basic |
| HTTP Proxy | No | HTTP proxy in IP:PORT format |
| Connect Timeout | No | Connection timeout in seconds (default: 30) |
| Read Timeout | No | Read timeout in seconds (default: 30) |
| TLS Verify | No | Verify TLS certificate (default: false) |
Token and Password are stored encrypted.
Auth Type Examples
Bearer (Default header)
When Header Name is not set, the request includes Authorization: Bearer {token} header. Suitable for GitHub, Slack, OpenAI, etc.
| Option | Value |
|---|---|
| Endpoint | https://api.github.com |
| Auth Type | Bearer |
| Token | ghp_xxxxxxxxxxxx |
Bearer (Custom header)
When Header Name is set, the request includes {header_name}: {token} header. Suitable for AbuseIPDB (Key), VirusTotal (x-apikey), etc.
| Option | Value |
|---|---|
| Endpoint | https://api.abuseipdb.com |
| Auth Type | Bearer |
| Token | your-api-key |
| Header Name | Key |
Basic
The request includes Authorization: Basic base64(username:password) header. Suitable for Jira, Zendesk, etc.
| Option | Value |
|---|---|
| Endpoint | https://your-instance.atlassian.net |
| Auth Type | Basic |
| Username | user@example.com |
| Password | your-api-token |
None
No authentication header is added. Suitable for public APIs such as CISA KEV.
| Option | Value |
|---|---|
| Endpoint | https://www.cisa.gov |
| Auth Type | None |