idstringrequired
The unique identifier of the address
Get Gateways for Address
Retrieves all gateways that provide access to the specified network address, showing the network topology and access paths for the address.
get
https://public-api.cipherscale.com/qa/tenants/addresses/{id}/gateways
Path Parameters
Response
application/json
Response
application/json
Successfully retrieved linked gateways
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 | null(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
get/tenants/addresses/{id}/gateways
Authentication
Path Parameters
application/json
Protocols
Network protocol definitions and configurations
Create Network Protocol
Creates a new network protocol definition that specifies allowed network protocols (TCP, UDP, ICMP) and ports for network access control.
post
https://public-api.cipherscale.com/qa/tenants/protocols
Body
application/json
Body
application/json
The protocol data to create
CreateProtocolDto
namestring
networkProtocolsarray[object]required
Show Child Parameters
Response
application/json
Response
application/json
Successfully created the protocol
ProtocolDto
idstring(uuid)required
namestringrequired
networkProtocolsarray[object]required
Show Child Parameters
typestringrequired
Allowed values:ALLPREDEFINEDCUSTOM
post/tenants/protocols
Authentication
Body
{
"networkProtocols": [
{
"protocol": "TCP"
}
]
}
application/json
List Network Protocols
Retrieves all network protocols configured for the tenant, including both predefined and custom protocol definitions with their associated network protocol settings.
get
https://public-api.cipherscale.com/qa/tenants/protocols
Response
application/json
Response
application/json
Successfully retrieved protocols
idstring(uuid)required
namestringrequired
networkProtocolsarray[object]required
Show Child Parameters
typestringrequired
Allowed values:ALLPREDEFINEDCUSTOM
get/tenants/protocols
Authentication
application/json
Remove Network Protocol
Permanently removes a network protocol definition from the tenant. This operation will affect any resources or addresses that use this protocol.
delete
https://public-api.cipherscale.com/qa/tenants/protocols/{id}
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the protocol to delete
Response
Response
Successfully deleted the protocol
delete/tenants/protocols/{id}