idstringrequired
The unique identifier of the address
Get Address Details
Retrieves detailed information about a specific network address including its type, associated protocols, and linked gateways.
get
https://public-api.cipherscale.com/qa/tenants/addresses/{id}
Path Parameters
Response
application/json
Response
application/json
Successfully retrieved the address
Address
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
get/tenants/addresses/{id}
Authentication
Path Parameters
application/json
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
idstringrequired
The unique identifier of the address to update
Body
application/json
Body
application/json
The address data to update
UpdateAddress
protocolsarray[string](uuid)required
Array of protocol IDs (UUIDs) to associate with this address
Example:["550e8400-e29b-41d4-a716-446655440000"]
addressstringrequired
Network address (IP address or domain name)
Example:192.168.1.100
Response
application/json
Response
application/json
Successfully updated the address
Address
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
put/tenants/addresses/{id}
Authentication
Path Parameters
Body
{
"address": "192.168.1.100",
"protocols": [
"550e8400-e29b-41d4-a716-446655440000"
]
}
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
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]
Resource information accessible through a gateway
Example:{"id":"550e8400-e29b-41d4-a716-446655440000","name":"Internal Web Server"}
Show Child Parameters
get/tenants/addresses/{id}/gateways
Authentication
Path Parameters
application/json
Protocols
Network protocol definitions and configurations