Endpoints

Endpoints are access points that allow external communication with applications running in a Sandbox. Each endpoint can be customized with security settings, regional configuration, and protocol type.

How do endpoints work?

Endpoints in Sandboxes act as tunnels operating through the Buddy agent. The agent is a lightweight daemon (bdy) installed in the Sandbox that maintains an encrypted connection with Buddy. Sandbox endpoints can be used as targets in actions. For more information about targets, see the Targets documentation

Adding an endpoint

1. Navigate to Sandbox settings
2. Click the + button
3. Configure endpoint
4. Save the configuration

Types of endpoints

• HTTP Endpoints - Provide access to web applications over the HTTP/HTTPS protocol. Support compression, HTTP/2, SSL certificate verification, and Basic Auth.

• TCP Endpoints - Provide a direct TCP connection to the application. Ideal for accessing SSH, databases, or other services that require a direct connection.

• TLS Endpoints - Provide a secure connection with TLS encryption. You can configure custom certificates and define the TLS termination point.

Endpoint configuration

Basic settings

• Name: Unique endpoint name
• Local endpoint: Port or destination address (e.g., localhost:8080, 80)
• Type: Type of the endpoint (Via HTTP, Via TCP, Via TLS)
• Region: Geographical region (EU or US)

Security

• Whitelist IPs & subnets: List of allowed IP addresses
• Timeout: Connection timeout in seconds
• Authentication: HTTP endpoint authentication

HTTP endpoint security

• Whitelist user-agents - List of allowed user-agents
• Rewrite Host header - Custom host header
• Request header - Custom request header
• Response header - Custom response header
• Circuit breaker - Circuit breaker threshold (0-100)

Agent recovery

The Agent Service is the component responsible for managing endpoints within a Sandbox. If the agent is removed or stopped, all public endpoints will become unavailable.

Image loading...

To restore endpoint functionality:

1. Click "Enable agent"
2. The agent will be automatically reinstalled and configured
3. All endpoints will return to the Online status
4. App access will be resotred

Endpoints in API and YAML

Learn more about API and YAML confifguration of endpoints in our documentation:

• REST API
• YAML Configuration