Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Endpoint

Hierarchy

  • Endpoint

Index

Properties

Optional bindings

bindings: string[]

the bindings associated with this endpoint

Optional createdAt

createdAt: Date

timestamp when the endpoint was created in RFC 3339 format

Optional description

description: string

user-supplied description of the associated tunnel

Optional domain

domain: Ref

the domain reserved for this endpoint

Optional edge

edge: Ref

the edge serving requests to this endpoint, if this is an edge endpoint

Optional host

host: string

hostport

hostport: string

hostport served by this endpoint (hostname:port) -> soon to be deprecated

id

id: string

unique endpoint resource identifier

Optional metadata

metadata: string

user-supplied metadata of the associated tunnel or edge object

Optional name

name: string

user supplied name for the endpoint

Optional port

port: number

Optional principal

principal: Ref

The ID of the owner (bot or user) that owns this endpoint

Optional principalId

principalId: Ref

TODO: deprecate me!

proto

proto: string

protocol served by this endpoint. one of http, https, tcp, or tls

publicUrl

publicUrl: string

URL of the hostport served by this endpoint

Optional region

region: string

identifier of the region this endpoint belongs to

Optional scheme

scheme: string

Optional tcpAddr

tcpAddr: Ref

the address reserved for this endpoint

Optional trafficPolicy

trafficPolicy: string

The traffic policy attached to this endpoint

Optional tunnel

tunnel: Ref

the tunnel serving requests to this endpoint, if this is an ephemeral endpoint

Optional tunnelSession

tunnelSession: Ref

The tunnel session of the agent for this endpoint

type

type: string

whether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a cloud endpoint)

Optional updatedAt

updatedAt: Date

timestamp when the endpoint was updated in RFC 3339 format

Optional upstreamProto

upstreamProto: string

the protocol the agent uses to forward with

Optional upstreamUrl

upstreamUrl: string

the local address the tunnel forwards to

Optional uri

uri: string

URI of the clep API resource

Optional url

url: string

the url of the endpoint

Generated using TypeDoc