ServiceEndpoint

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ServiceEndpoint",
  "title": "ServiceEndpoint",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "User-friendly endpoint name that represents the corresponding port.",
      "example": "Example Title"
    },
    "port": {
      "type": "integer",
      "description": "The network port the service is listening on. NULL, when portRange is specified.",
      "example": 10
    },
    "portRange": {
      "type": "string",
      "description": "The network port range the service is listening on. NULL, when port is specified.",
      "example": "example_value"
    },
    "protocol": {
      "type": "string",
      "description": "Supported network protocol (TCP, HTTP, or HTTPS).",
      "default": "HTTP",
      "example": "example_value"
    },
    "is_public": {
      "type": "boolean",
      "description": "True, if the endpoint is public, accessible from internet.",
      "default": false,
      "example": true
    },
    "ingress_url": {
      "type": "string",
      "description": "Endpoint URL accessible from the internet.",
      "readOnly": true,
      "example": "https://www.example.com"
    }
  },
  "example": {
    "name": "endpoint",
    "port": 8080,
    "protocol": "HTTPS",
    "is_public": true,
    "ingress_url": "abcd-org-acc.snowflakecomputing.app"
  }
}