Search
K
Cipherscale API

Get Gateways for Address

Retrieves all gateways that provide access to the specified network address, showing the network topology and access paths for the address.

get
https://public-api.cipherscale.com/qa/tenants/addresses/{id}/gateways

Path Parameters

idstringrequired

The unique identifier of the address

Response

application/json

Successfully retrieved linked gateways

Network gateway configuration and status information

idstring(uuid)required

Unique identifier for the gateway

createdAtstring(date-time)required

Timestamp when the gateway was created

updatedAtstring(date-time)required

Timestamp when the gateway was last updated

namestringrequired

Human-readable name for the gateway

descriptionstring

Detailed description of the gateway’s purpose and location

wireguardPortstringrequired

WireGuard VPN port number for this gateway

statusstringrequired

Current operational status of the gateway

Allowed values:PENDINGONLINEOFFLINEMAINTENANCEERROR

errorstring

Error message if the gateway is in ERROR status

tokenstringrequired

Authentication token for gateway communication

lastOnlinestring(date-time)

Timestamp when the gateway was last online

relayEnabledboolean

Whether the gateway can relay traffic between network segments

endpointstring

Network endpoint address for the gateway

autoDiscoverEndpointbooleanrequired

Whether the gateway endpoint is automatically discovered

resourcesarray[object]

Resource information accessible through a gateway

Example:{"id":"550e8400-e29b-41d4-a716-446655440000","name":"Internal Web Server"}

Show Child Parameters
get/tenants/addresses/{id}/gateways
  
curl --request GET \
  --url https://public-api.cipherscale.com/qa/tenants/addresses//gateways \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apikey: '
application/json
{
  "id": "id",
  "createdAt": "createdAt",
  "updatedAt": "updatedAt",
  "name": "name",
  "description": "description",
  "wireguardPort": "wireguardPort",
  "status": "PENDING",
  "error": "error",
  "token": "token",
  "lastOnline": "lastOnline",
  "relayEnabled": false,
  "endpoint": "endpoint",
  "autoDiscoverEndpoint": false,
  "resources": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Internal Web Server"
    }
  ]
}

Protocols

Network protocol definitions and configurations

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