Gateway
objectNetwork gateway configuration and status information
Unique identifier for the gateway
Timestamp when the gateway was created
Timestamp when the gateway was last updated
Human-readable name for the gateway
Detailed description of the gateway’s purpose and location
WireGuard VPN port number for this gateway
Current operational status of the gateway
Allowed values:PENDINGONLINEOFFLINEMAINTENANCEERROR
Error message if the gateway is in ERROR status
Authentication token for gateway communication
Timestamp when the gateway was last online
Whether the gateway can relay traffic between network segments
Network endpoint address for the gateway
Whether the gateway endpoint is automatically discovered
Resource information accessible through a gateway
Example:{"id":"550e8400-e29b-41d4-a716-446655440000","name":"Internal Web Server"}
Show Child Parameters
UpdateGateway
objectData for updating gateway configuration
Current operational status of the gateway
Allowed values:PENDINGONLINEOFFLINEMAINTENANCEERROR
Example:ONLINE
Human-readable name for the gateway
Example:US-East Gateway
Detailed description of the gateway’s purpose and location
Example:Primary gateway for US East region data center
WireGuard VPN port number for this gateway
Example:51820
Network endpoint address for the gateway
Example:gateway-us-east.company.com
NetworkProtocol
objectNetwork protocol type
Allowed values:TCPUDPICMP
Example:TCP
Port number or port range (e.g., “80”, “443”, “8080-8090”)
Example:80
Protocol
objectUnique identifier for the protocol
Example:550e8400-e29b-41d4-a716-446655440000
Human-readable name for the protocol
Example:HTTP/HTTPS
Array of network protocol configurations
Example:{"protocol":"TCP","port":"80"}
Show Child Parameters
Protocol type classification
Allowed values:ALLPREDEFINEDCUSTOM
Example:PREDEFINED
Address
objectUnique identifier for the address
Example:550e8400-e29b-41d4-a716-446655440001
Network address (IP address or domain name)
Example:192.168.1.100
Whether the address is an IP address (true) or domain name (false)
Example:true
Type of network resource this address belongs to
Allowed values:PRIVATESAASINTERNET
Example:PRIVATE
Array of protocol objects defining network protocols for this address
Example:{"id":"550e8400-e29b-41d4-a716-446655440000","name":"HTTP/HTTPS","type":"PREDEFINED","networkProtocols":[{"protocol":"TCP","port":"80"},{"protocol":"TCP","port":"443"}]}