tcp_proxy_create
Set up TCP proxies to access databases or expose TCP services externally. Requires service and environment IDs, and application port. Use for configuring secure external connections.
Instructions
[API] Create a new TCP proxy for a service
⚡️ Best for: ✓ Setting up database access ✓ Configuring external connections ✓ Exposing TCP services
⚠️ Not for: × HTTP/HTTPS endpoints (use domain_create) × Internal service communication
→ Prerequisites: service_list
→ Alternatives: domain_create
→ Next steps: tcp_proxy_list
→ Related: service_info, service_update
Input Schema
Name | Required | Description | Default |
---|---|---|---|
applicationPort | Yes | Port of application/service to proxy, usually based off of the service's Dockerfile or designated running port. | |
environmentId | Yes | ID of the environment (usually obtained from service_info) | |
serviceId | Yes | ID of the service |