List ports
Inspect a service’s primary HTTP port, additional exposed ports, and detected port suggestions.
Request & response examples
curl --fail-with-body --request GET \ 'https://app.helicarrier.xyz/api/services/YOUR_ID/ports' \ -H "Authorization: Bearer $HELI_API_KEY"const response = await fetch( "https://app.helicarrier.xyz/api/services/YOUR_ID/ports", { method: "GET", headers: { Authorization: `Bearer ${process.env.HELI_API_KEY}` } });const data = await response.json();if (!response.ok) { throw new Error(`HTTP ${response.status}: ${data.error}`);}// Inspect data; avoid logging secret responses.import osimport requests
response = requests.request( "GET", "https://app.helicarrier.xyz/api/services/YOUR_ID/ports", headers={ "Authorization": f"Bearer {os.environ['HELI_API_KEY']}" }, timeout=30,)response.raise_for_status()data = response.json()# Inspect data; avoid logging secret responses.{ "primaryPort": 3000, "ports": [], "detected": [ 8080 ]}Illustrative values · selected fields
Path parameters
id string required Service id.
Response 200
Returns the primary HTTP port, additional exposed ports, and detected ports that could be exposed. Exposing a port takes effect when the service is deployed.
Examples show selected response fields with illustrative values. Your response can contain additional fields.
primaryPort integer Primary internal HTTP port.
ports array Additional exposed HTTP ports.
detected array Detected internal ports that are not yet exposed.
Errors
401 The API key is missing, invalid, or revoked.
403 The caller or key scope does not permit this operation.
500 The operation could not be completed. Check resource state before retrying a write.
list_ports
Required MCP arguments: id. Send path, query,
and body fields together as tool arguments.