idstringrequired
The unique identifier of the address to update
Update Network Address
Modifies the configuration of an existing network address including its associated protocols and access settings.
put
https://public-api.cipherscale.com/qa/tenants/addresses/{id}
Path Parameters
Body
application/json
Body
application/json
The address data to update
UpdateAddressDto
protocolsarray[string](uuid)required
addressstringrequired
Response
application/json
Response
application/json
Successfully updated the address
AddressDto
idstring(uuid)required
addressstringrequired
isIpbooleanrequired
typestringrequired
Allowed values:PRIVATESAASINTERNET
protocolsarray[object]required
Show Child Parameters
put/tenants/addresses/{id}
Authentication
Path Parameters
Body
{
"protocols": [
"[]"
],
"address": "address"
}
application/json
Remove Network Address
Permanently removes a network address from the tenant. This operation will also remove the address from any associated resources.
delete
https://public-api.cipherscale.com/qa/tenants/addresses/{id}
Path Parameters
idstringrequired
The unique identifier of the address to delete
Response
Response
Successfully deleted the address
delete/tenants/addresses/{id}
Authentication
Path Parameters
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
idstringrequired
The unique identifier of the address
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