Search
K
Cipherscale API

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

Successfully retrieved protocols

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

get/tenants/protocols
  
curl --request GET \
  --url https://public-api.cipherscale.com/qa/tenants/protocols \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "HTTP/HTTPS",
  "type": "PREDEFINED",
  "networkProtocols": [
    {
      "protocol": "TCP",
      "port": "80"
    },
    {
      "protocol": "TCP",
      "port": "443"
    }
  ]
}

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

Successfully deleted the protocol

delete/tenants/protocols/{id}
  
curl --request DELETE \
  --url https://public-api.cipherscale.com/qa/tenants/protocols/ \
  --header 'Content-Type: application/json'
Successfully deleted the protocol

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

Successfully retrieved the protocol

Protocol

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

get/tenants/protocols/{id}
  
curl --request GET \
  --url https://public-api.cipherscale.com/qa/tenants/protocols/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "HTTP/HTTPS",
  "type": "PREDEFINED",
  "networkProtocols": [
    {
      "protocol": "TCP",
      "port": "80"
    },
    {
      "protocol": "TCP",
      "port": "443"
    }
  ]
}

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

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:OWNERADMINDEFAULTBASICBILLINGAUDITORSUPPORT

get/tenants/roles
  
curl --request GET \
  --url https://public-api.cipherscale.com/qa/tenants/roles \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
application/json
{
  "id": "id",
  "createdAt": "createdAt",
  "updatedAt": "updatedAt",
  "name": "name",
  "description": "description",
  "deleteable": false,
  "type": "OWNER"
}