Interface Gateway

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

Properties

bandwidth bastionAllowedIps bastionEnabled bastionPort canUpgradeTo? createdAt? gatewayNetworks id ipv4? isLegacy name organizationId projectId smtpEnabled status tags type updatedAt? version? zone

Properties

bandwidth

bandwidth: number

Bandwidth available of the gateway.

bastionAllowedIps

bastionAllowedIps: string[]

Ranges of IP addresses allowed to connect to the gateway's SSH bastion.

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: VPCGW.v2.GatewayNetwork[]

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

id

id: string

ID of the gateway.

Optionalipv4

ipv4?: VPCGW.v2.IP

Public IPv4 address of the gateway.

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: VPCGW.v2.GatewayStatus

Current status of the gateway.

tags

tags: string[]

Tags associated with the gateway.

type

type: string

Gateway type name (commercial offer).

OptionalupdatedAt

updatedAt?: Date

Gateway last modification date.

Optionalversion

version?: string

Version of the running gateway software.

zone

zone: Zone

Zone of the gateway.

Settings

On This Page

Properties