Search
K
Cipherscale API

GatewayDto

object

Network gateway configuration and status information

idstring(uuid)required

Unique identifier for the gateway

createdAtstring(date-time)required

Timestamp when the gateway was created

deployedOnstring(date-time)required

Timestamp when the gateway was first successfully deployed

updatedAtstring(date-time)required

Timestamp when the gateway was last updated

namestringrequired

Human-readable name for the gateway

descriptionstring

Detailed description of the gateway’s purpose and location

wireguardPortstringrequired

WireGuard VPN port number for this gateway

statusstringrequired

Current operational status of the gateway

Allowed values:PENDINGONLINEOFFLINEMAINTENANCEERROR

errorstring

Error message if the gateway is in ERROR status

tokenstringrequired

Authentication token for gateway communication

lastOnlinestring(date-time)

Timestamp when the gateway was last online

relayEnabledboolean

Whether the gateway can relay traffic between network segments

endpointstring

Network endpoint address for the gateway

autoDiscoverEndpointbooleanrequired

Whether the gateway endpoint is automatically discovered

resourcesarray[object]

List of resources accessible through this gateway

Show Child Parameters
Example

UpdateGatewayDto

object
statusstring

Allowed values:PENDINGONLINEOFFLINEMAINTENANCEERROR

namestringrequired
descriptionstring
wireguardPortstringrequired
endpointstring
Example

NetworkProtocolDto

object
protocolstringrequired

Allowed values:TCPUDPICMP

portstring
Example

ProtocolDto

object
idstring(uuid)required
namestringrequired
networkProtocolsarray[object]required
Show Child Parameters
typestringrequired

Allowed values:ALLPREDEFINEDCUSTOM

Example

AddressDto

object
idstring(uuid)required
addressstringrequired
isIpbooleanrequired
typestringrequired

Allowed values:PRIVATESAASINTERNET

protocolsarray[object]required
Show Child Parameters
Example