Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

Schema

SandboxEndpoint

Type: object

SandboxEndpoint tells a client where sandbox endpoint services are served. network endpoints require scoped credentials; Unix sockets use actual socket access controls sandbox must contain the endpoint's immutable sandbox UID
apiVersion · required

Type: string

api_version identifies the /v1 endpoint contract before the client connects.
All schema constraints and annotations
{
  "const": "v1",
  "description": "api_version identifies the /v1 endpoint contract before the client connects.",
  "type": "string"
}
authentication · required

Schema: EndpointAuthentication

capabilities · required

Type: array

capabilities lists supported public operation IDs, independently of caller grants.
Array item

Type: string

All schema constraints and annotations
{
  "pattern": "^[a-z][A-Za-z0-9]*$",
  "type": "string"
}
All schema constraints and annotations
{
  "description": "capabilities lists supported public operation IDs, independently of caller grants.",
  "items": {
    "pattern": "^[a-z][A-Za-z0-9]*$",
    "type": "string"
  },
  "minItems": 1,
  "type": "array",
  "uniqueItems": true
}
credentialAudience

Type: string

credential_audience is server-controlled and required for network endpoints.
All schema constraints and annotations
{
  "description": "credential_audience is server-controlled and required for network endpoints.",
  "type": "string"
}
protocol

Schema: SandboxEndpointProtocol

protocol identifies the endpoint transport.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/SandboxEndpointProtocol",
  "description": "protocol identifies the endpoint transport."
}
sandbox · required

Type: string

sandbox names the immutable sandbox incarnation served by this endpoint.
All schema constraints and annotations
{
  "description": "sandbox names the immutable sandbox incarnation served by this endpoint.",
  "pattern": "^sandboxes/[^/]+$",
  "type": "string"
}
sandboxUid · required · response only

Type: string

All schema constraints and annotations
{
  "minLength": 1,
  "readOnly": true,
  "type": [
    "string"
  ]
}
uri

Type: string

uri is the endpoint API base; preserve its path prefix when appending /v1 routes.
All schema constraints and annotations
{
  "description": "uri is the endpoint API base; preserve its path prefix when appending /v1 routes.",
  "type": "string"
}
All schema constraints and annotations
{
  "dependentSchemas": {
    "authentication": {
      "allOf": [
        {
          "oneOf": [
            {
              "properties": {
                "authentication": {
                  "properties": {
                    "scheme": {
                      "const": "scopedBearer"
                    }
                  }
                },
                "credentialAudience": {
                  "minLength": 1
                },
                "protocol": {
                  "const": "http"
                }
              },
              "required": [
                "credentialAudience"
              ]
            },
            {
              "properties": {
                "authentication": {
                  "properties": {
                    "scheme": {
                      "const": "localSocket"
                    }
                  }
                },
                "credentialAudience": {
                  "const": ""
                },
                "protocol": {
                  "const": "unixSocket"
                }
              }
            }
          ],
          "required": [
            "protocol"
          ]
        }
      ]
    }
  },
  "description": "SandboxEndpoint tells a client where sandbox endpoint services are served.\nnetwork endpoints require scoped credentials; Unix sockets use actual socket access controls\nsandbox must contain the endpoint's immutable sandbox UID",
  "properties": {
    "apiVersion": {
      "const": "v1",
      "description": "api_version identifies the /v1 endpoint contract before the client connects.",
      "type": "string"
    },
    "authentication": {
      "$ref": "#/components/schemas/EndpointAuthentication"
    },
    "capabilities": {
      "description": "capabilities lists supported public operation IDs, independently of caller grants.",
      "items": {
        "pattern": "^[a-z][A-Za-z0-9]*$",
        "type": "string"
      },
      "minItems": 1,
      "type": "array",
      "uniqueItems": true
    },
    "credentialAudience": {
      "description": "credential_audience is server-controlled and required for network endpoints.",
      "type": "string"
    },
    "protocol": {
      "$ref": "#/components/schemas/SandboxEndpointProtocol",
      "description": "protocol identifies the endpoint transport."
    },
    "sandbox": {
      "description": "sandbox names the immutable sandbox incarnation served by this endpoint.",
      "pattern": "^sandboxes/[^/]+$",
      "type": "string"
    },
    "sandboxUid": {
      "minLength": 1,
      "readOnly": true,
      "type": [
        "string"
      ]
    },
    "uri": {
      "description": "uri is the endpoint API base; preserve its path prefix when appending /v1 routes.",
      "type": "string"
    }
  },
  "required": [
    "sandbox",
    "sandboxUid",
    "apiVersion",
    "capabilities",
    "authentication"
  ],
  "title": "SandboxEndpoint",
  "type": "object"
}