Interface Gateway

interface Gateway {
    bastionEnabled: boolean;
    bastionPort: number;
    canUpgradeTo?: string;
    createdAt?: Date;
    gatewayNetworks: GatewayNetwork[];
    id: string;
    ip?: VPCGW.v1.IP;
    ipMobilityEnabled: boolean;
    isLegacy: boolean;
    name: string;
    organizationId: string;
    projectId: string;
    smtpEnabled: boolean;
    status: GatewayStatus;
    tags: string[];
    type?: GatewayType;
    updatedAt?: Date;
    upstreamDnsServers: string[];
    version?: string;
    zone: Zone;
}

Properties

bastionEnabled bastionPort canUpgradeTo? createdAt? gatewayNetworks id ip? ipMobilityEnabled isLegacy name organizationId projectId smtpEnabled status tags type? updatedAt? upstreamDnsServers version? zone

Properties

bastionEnabled

bastionEnabled: boolean

Defines whether SSH bastion is enabled on the gateway.

bastionPort

bastionPort: number

Port of the SSH bastion.

OptionalcanUpgradeTo

canUpgradeTo?: string

Newly available gateway software version that can be updated to.

OptionalcreatedAt

createdAt?: Date

Gateway creation date.

gatewayNetworks

gatewayNetworks: GatewayNetwork[]

GatewayNetwork objects attached to the gateway (each one represents a connection to a Private Network).

id

id: string

ID of the gateway.

Optionalip

ip?: VPCGW.v1.IP

Public IP address of the gateway.

ipMobilityEnabled

ipMobilityEnabled: boolean

Defines whether the gateway uses routed IPs (IP mobility) instead of NAT IPs.

isLegacy

isLegacy: boolean

Defines whether the gateway uses non-IPAM IP configurations.

name

name: string

Name of the gateway.

organizationId

organizationId: string

Owning Organization.

projectId

projectId: string

Owning Project.

smtpEnabled

smtpEnabled: boolean

Defines whether SMTP traffic is allowed to pass through the gateway.

status

status: GatewayStatus

Current status of the gateway.

tags

tags: string[]

Tags associated with the gateway.

Optionaltype

type?: GatewayType

Gateway type (commercial offer).

OptionalupdatedAt

updatedAt?: Date

Gateway last modification date.

upstreamDnsServers

upstreamDnsServers: string[]

Array of DNS server IP addresses to override the gateway's default recursive DNS servers.

Optionalversion

version?: string

Version of the running gateway software.

zone

zone: Zone

Zone of the gateway.

Settings

On This Page

Properties