The protocol data to create
CreateProtocolDto
namestring
networkProtocolsarray[object]required
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
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}
Authentication
Path Parameters
Get Protocol Details
Retrieves detailed information about a specific network protocol including its name, type, and associated network protocol settings (TCP, UDP, ICMP).
get
https://public-api.cipherscale.com/qa/tenants/protocols/{id}
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the protocol
Response
application/json
Response
application/json
Successfully retrieved the protocol
ProtocolDto
idstring(uuid)required
namestringrequired
networkProtocolsarray[object]required
Show Child Parameters
typestringrequired
Allowed values:ALLPREDEFINEDCUSTOM
get/tenants/protocols/{id}
Authentication
Path Parameters
application/json
Roles
User role and permission management