API reference · Schema
PodConnect
Present when reading one pod
portsarray of objectrequiredHow to reach each configured port
ShowHide 6 fields of
portsportintegerrequiredPort number the container listens on
namestringrequiredIts name
protocolstringrequired`http`: served at the port’s HTTPS URL (WebSocket included). `tcp`: raw TCP, reachable through SSH port forwarding.
One of
httptcpvisibilitystringrequired`public`: anyone with the URL. `private`: no URL; SSH port forwarding and the project network only.
One of
publicprivateurlstring | nullrequiredHTTPS URL (public HTTP ports)
forward_commandstring | nullrequiredSSH local-forward command reaching the port from your machine (when SSH is on)
sshobject | nullrequiredNull while SSH is off or the pod is not on a host
ShowHide 6 fields of
sshuserstringrequiredUser name to log in with (identifies the pod)
hoststringrequiredSSH host name
portintegerrequiredSSH TCP port
commandstringrequiredReady-to-run ssh command
known_hostsarray of stringrequiredLines for ~/.ssh/known_hosts pinning the host keys
sftp_commandstringrequiredReady-to-run sftp command
private_networkobjectrequiredHow other pods of the project reach this one
ShowHide 2 fields of
private_networkhostnamestringrequiredName this pod answers to in the project’s private network
scopestringrequiredOther pods of this project reach this one at `hostname` when they run on the same host (pods sharing a network volume always do). Pods of other projects cannot reach it.
One of
same_host
{
"ports": [
{
"port": 1,
"name": "string",
"protocol": "http",
"visibility": "public",
"url": "string",
"forward_command": "string"
}
],
"ssh": {
"user": "string",
"host": "string",
"port": 1,
"command": "string",
"known_hosts": [
"string"
],
"sftp_command": "string"
},
"private_network": {
"hostname": "string",
"scope": "same_host"
}
}