Connections API

Overview

The Connections API provides endpoints for managing connections to external systems such as databases, message queues, email servers, and logging systems. Connections are reusable configurations that can be used by policies and other components.

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

• ROLE_API_SECURITY - Required for all connection operations

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