Search
K
Cipherscale API

UpdateGateway

object

Data for updating gateway configuration

statusstring

Current operational status of the gateway

Allowed values:PENDINGONLINEOFFLINEMAINTENANCEERROR

Example:ONLINE

namestringrequired

Human-readable name for the gateway

Example:US-East Gateway

descriptionstring

Detailed description of the gateway’s purpose and location

Example:Primary gateway for US East region data center

wireguardPortstringrequired

WireGuard VPN port number for this gateway

Example:51820

endpointstring

Network endpoint address for the gateway

Example:gateway-us-east.company.com

Example

NetworkProtocol

object
protocolstringrequired

Network protocol type

Allowed values:TCPUDPICMP

Example:TCP

portstring

Port number or port range (e.g., “80”, “443”, “8080-8090”)

Example:80

Example

Protocol

object
idstring(uuid)required

Unique identifier for the protocol

Example:550e8400-e29b-41d4-a716-446655440000

namestringrequired

Human-readable name for the protocol

Example:HTTP/HTTPS

networkProtocolsarray[object]required

Array of network protocol configurations

Example:{"protocol":"TCP","port":"80"}

Show Child Parameters
typestringrequired

Protocol type classification

Allowed values:ALLPREDEFINEDCUSTOM

Example:PREDEFINED

Example

Address

object
idstring(uuid)required

Unique identifier for the address

Example:550e8400-e29b-41d4-a716-446655440001

addressstringrequired

Network address (IP address or domain name)

Example:192.168.1.100

isIpbooleanrequired

Whether the address is an IP address (true) or domain name (false)

Example:true

typestringrequired

Type of network resource this address belongs to

Allowed values:PRIVATESAASINTERNET

Example:PRIVATE

protocolsarray[object]required

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"}]}

Show Child Parameters
Example

AccessPoint

object

Connection between a network address and a gateway

addressIdstringrequired

Unique identifier of the network address

Example:550e8400-e29b-41d4-a716-446655440000

gatewayIdstringrequired

Unique identifier of the gateway

Example:550e8400-e29b-41d4-a716-446655440001

Example