Search
K
Cipherscale API

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

CreateAddress

object
protocolsarray[string](uuid)required

Array of protocol IDs (UUIDs) that define the network protocols for this address. Use the “List Network Protocols” endpoint to get available protocol IDs, or create new protocols using the “Create Network Protocol” endpoint.

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

addressstringrequired

Network address (IP address or domain name)

Example:192.168.1.100

Example