Endpoints
CRUD Operations
- List Connections - Get all connections for a project
- Get Connection - Get connection details
- Create Connection - Create a new connection (general)
- Update Connection - Update a connection (general)
- Delete Connection - Delete a connection
Connection Types
Each connection type has its own documentation page with complete examples:- Email Connection
- Kafka Connection
- Elasticsearch Connection
- RabbitMQ Connection
- FTP Connection
- Graylog Connection
- Syslog Connection
- Webhook Connection
- Logback Connection
- Apache ActiveMQ Connection
- SNMP Connection
- Linux Script Connection
- Database Connection
- LDAP Connection
Authentication
All endpoints require authentication using a Personal API Access Token.Permissions
GET Operations (List/Get Connection)
- User must have
CONNECTIONS+VIEWpermission in the project - If the asset category does not exist, user must have at least one permission in the project
POST/PUT/DELETE Operations (Create/Update/Delete Connection)
- User must have
CONNECTIONS+MANAGEpermission in the project
Permission Requirements
| Operation | Required Permission |
|---|---|
| List/Get Connection | CONNECTIONS + VIEW (or any permission if category doesn’t exist) |
| Create/Update/Delete Connection | CONNECTIONS + MANAGE |
Secret Fields
- List Operations: Secret fields (passwords, API keys, etc.) are masked and returned as
null - Get Single Connection: Secret fields are returned in full
- Security: Never commit connection configurations with secrets to version control
Related Documentation
- Authentication Guide - How to obtain and use API tokens
- Error Handling - Error response formats