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
List All Roles
Retrieves all user roles available in the tenant, including system-defined roles (OWNER, ADMIN, etc.) and custom roles with their permissions and capabilities.
get
https://public-api.cipherscale.com/qa/tenants/roles
Response
application/json
Response
application/json
Successfully retrieved roles
User role definition with specific permissions and capabilities
idstring(uuid)required
Unique identifier for the role
createdAtstring(date-time)required
Timestamp when the role was created
updatedAtstring(date-time)required
Timestamp when the role was last modified
namestringrequired
Human-readable name of the role
descriptionstring
Detailed description of the role’s purpose and permissions
deleteablebooleanrequired
Whether this role can be deleted (system roles are typically not deletable)
typestringrequired
Predefined role type that determines the base permissions
Allowed values:OWNERADMINDEFAULTBASICBILLINGAUDITOR
get/tenants/roles
Authentication
application/json