Share feedback
Answers are generated based on the documentation.

Experimental

Schema

Port

Type: object

Port is one sandbox port made reachable from outside the sandbox. The same facts appear inline on SandboxCore.ports for a caller reading the sandbox.
etag · response only

Type: string

etag identifies the observed version of this port.
All schema constraints and annotations
{
  "description": "etag identifies the observed version of this port.",
  "readOnly": true,
  "type": "string"
}
name

Type: string

(IDENTIFIER) name identifies the published port number under its sandbox resource name.
All schema constraints and annotations
{
  "description": "(IDENTIFIER) name identifies the published port number under its sandbox resource name.",
  "type": "string"
}
number · required

Type: integer

(IMMUTABLE) number is immutable and unique within the sandbox; duplicates refuse ALREADY_EXISTS.
All schema constraints and annotations
{
  "description": "(IMMUTABLE) number is immutable and unique within the sandbox; duplicates refuse ALREADY_EXISTS.",
  "format": "int32",
  "maximum": 65535,
  "minimum": 1,
  "type": "integer"
}
protocol

Schema: Protocol

(IMMUTABLE) protocol defaults to TCP when unspecified.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/Protocol",
  "description": "(IMMUTABLE) protocol defaults to TCP when unspecified."
}
uid · response only

Type: string | null

(IMMUTABLE) uid is the durable publication incarnation when the backend provides one.
All schema constraints and annotations
{
  "description": "(IMMUTABLE) uid is the durable publication incarnation when the backend provides one.",
  "readOnly": true,
  "type": [
    "string",
    "null"
  ]
}
url · response only

Type: string

url is the required externally reachable address, including host-local addresses.
All schema constraints and annotations
{
  "description": "url is the required externally reachable address, including host-local addresses.",
  "readOnly": true,
  "type": "string"
}
All schema constraints and annotations
{
  "description": "Port is one sandbox port made reachable from outside the sandbox. The same\nfacts appear inline on SandboxCore.ports for a caller reading the sandbox.",
  "properties": {
    "etag": {
      "description": "etag identifies the observed version of this port.",
      "readOnly": true,
      "type": "string"
    },
    "name": {
      "description": "(IDENTIFIER) name identifies the published port number under its sandbox resource name.",
      "type": "string"
    },
    "number": {
      "description": "(IMMUTABLE) number is immutable and unique within the sandbox; duplicates refuse ALREADY_EXISTS.",
      "format": "int32",
      "maximum": 65535,
      "minimum": 1,
      "type": "integer"
    },
    "protocol": {
      "$ref": "#/components/schemas/Protocol",
      "description": "(IMMUTABLE) protocol defaults to TCP when unspecified."
    },
    "uid": {
      "description": "(IMMUTABLE) uid is the durable publication incarnation when the backend provides one.",
      "readOnly": true,
      "type": [
        "string",
        "null"
      ]
    },
    "url": {
      "description": "url is the required externally reachable address, including host-local addresses.",
      "readOnly": true,
      "type": "string"
    }
  },
  "required": [
    "number"
  ],
  "title": "Port",
  "type": "object"
}