Interface Gateway

Gateways are used to connect services to the internet or a private network

Hierarchy

  • Gateway

Properties

created_at deployment_id domains hopsh_domain hopsh_domain_enabled id internal_domain name protocol target_port type

Properties

created_at

created_at: Timestamp

The date this gateway was created

deployment_id

deployment_id: `deployment_${string}`

The deployment this gateway is associated with

domains

domains: Domain[]

Domains associated with this gateway

hopsh_domain

hopsh_domain: null | `${string}.hop.sh`

Domain automatically assigned by Hop

hopsh_domain_enabled

hopsh_domain_enabled: boolean

Determines if the hop.sh domain is current active.

id

id: `gateway_${string}`

The ID of the gateway

internal_domain

internal_domain: null | `${string}.hop`

Internal domain assigned by user upon gateway creation

name

name: string

The name of the gateway

protocol

protocol: null | "http"

The protocol for this gateway (Only for external)

Warning

Currently, hop only supports HTTP. This will eventually change to an enum

target_port

target_port: null | number

Port the Gateway targets (Only for external gateways)

type

type: GatewayType

The type of the gateway

Settings

Member Visibility

Theme

Generated using TypeDoc