Search
K
Cipherscale API

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

The protocol data to create

CreateProtocol

Data required to create a new network protocol definition

namestring

Human-readable name for the protocol

Example:Custom Web Services

networkProtocolsarray[object]required

Array of network protocol configurations (TCP, UDP, ICMP)

Example:{"protocol":"TCP","port":"80"}

Show Child Parameters

Response

application/json

Successfully created 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

post/tenants/protocols

Body

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

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' \
  --header 'apikey: '
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' \
  --header 'apikey: '
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' \
  --header 'apikey: '
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