Search
K
Cipherscale API

Enable Gateway Relay

Enables relay functionality for the gateway, allowing it to forward traffic between different network segments and improve connectivity for remote users.

post
https://public-api.cipherscale.com/qa/tenants/gateways/{id}/enable-relay

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the gateway

Response

application/json

Successfully enabled gateway relay

Gateway

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
post/tenants/gateways/{id}/enable-relay
  
curl --request POST \
  --url https://public-api.cipherscale.com/qa/tenants/gateways//enable-relay \
  --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"
    }
  ]
}

Disable Gateway Relay

Disables relay functionality for the gateway, restricting it to direct connections only. This may improve security but reduce connectivity options.

post
https://public-api.cipherscale.com/qa/tenants/gateways/{id}/disable-relay

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the gateway

Response

application/json

Successfully disabled gateway relay

Gateway

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
post/tenants/gateways/{id}/disable-relay
  
curl --request POST \
  --url https://public-api.cipherscale.com/qa/tenants/gateways//disable-relay \
  --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"
    }
  ]
}

Test Gateway Configuration

Validates the gateway configuration by performing connectivity tests and verifying that all settings are properly configured. This helps identify configuration issues before deployment.

post
https://public-api.cipherscale.com/qa/tenants/gateways/{id}/test-configuration

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the gateway

Response

application/json

Gateway configuration test result

TestConfiguration

Response from gateway configuration test

statusstringrequired

Status of the gateway

Allowed values:ONLINEMAINTENANCENOT_REACHABLEERRORUNRECOGNIZED

detailsstring

Additional details about the test result

errorstring

Standard error message from the gateway test configuration process

_errorstring

Additional error information that may be provided by the system (internal error details)

post/tenants/gateways/{id}/test-configuration
  
curl --request POST \
  --url https://public-api.cipherscale.com/qa/tenants/gateways//test-configuration \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apikey: '
application/json
{
  "status": "ONLINE",
  "details": "details",
  "error": "error",
  "_error": "_error"
}

Resources

Network resource definition and access control

Create Network Resource

Creates a new network resource that defines access points for users and devices. Resources can be private networks, SaaS applications, or internet access points, each with specific protocols and access controls.

post
https://public-api.cipherscale.com/qa/tenants/resources

Body

application/json

CreateResource

addressesarray[object]required

Array of network addresses with their associated protocols. Protocol IDs can be obtained from the “List Network Protocols” endpoint or created using the “Create Network Protocol” endpoint.

Example:{"address":"192.168.1.100","protocols":["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"]}

Show Child Parameters
namestringrequired

Name of the network resource

Example:Internal Web Server

typestringrequired

Type of network resource

Allowed values:PRIVATESAASINTERNET

Example:PRIVATE

descriptionstring

Optional description of the resource

Example:Internal web server for company applications

Response

application/json

Successfully created the resource

Resource

Complete network resource information with addresses and gateways

idstring(uuid)required

Unique identifier for the resource

Example:550e8400-e29b-41d4-a716-446655440000

createdAtstring(date-time)required

Timestamp when the resource was created

Example:2023-01-15T14:30:00Z

updatedAtstring(date-time)required

Timestamp when the resource was last updated

Example:2023-01-15T14:30:00Z

namestringrequired

Human-readable name for the resource

Example:Internal Web Server

typestringrequired

Type of the network resource

Allowed values:PRIVATESAASINTERNET

Example:PRIVATE

loadBalancingModestringrequired

Load balancing configuration for this resource

Allowed values:MANUALAUTOMATIC

Default:MANUAL

Example:MANUAL

statusstring

Current operational status of the resource

Allowed values:ONLINEOFFLINE

Example:ONLINE

descriptionstring

Detailed description of the resource’s purpose

Example:Internal web server for company applications

addressesarray[object]required

Array of network addresses associated with this resource

Example:{"id":"550e8400-e29b-41d4-a716-446655440001","address":"192.168.1.100","isIp":true,"type":"PRIVATE","protocols":[{"id":"550e8400-e29b-41d4-a716-446655440000","name":"HTTP/HTTPS","type":"PREDEFINED","networkProtocols":[{"protocol":"TCP","port":"80"},{"protocol":"TCP","port":"443"}]}]}

Show Child Parameters
gatewaysarray[object]required

Network gateway configuration and status information

Show Child Parameters
post/tenants/resources

Body

{
  "name": "Internal Web Server",
  "type": "PRIVATE",
  "description": "Internal web server for company applications",
  "addresses": [
    {
      "address": "192.168.1.100",
      "protocols": [
        "550e8400-e29b-41d4-a716-446655440000",
        "550e8400-e29b-41d4-a716-446655440001"
      ]
    }
  ]
}
{ "name": "Internal Web Server", "type": "PRIVATE", "description": "Internal web server for company applications", "addresses": [ { "address": "192.168.1.100", "protocols": [ "550e8400-e29b-41d4-a716-446655440000", "550e8400-e29b-41d4-a716-446655440001" ] } ] }
  
curl --request POST \
  --url https://public-api.cipherscale.com/qa/tenants/resources \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apikey: ' \
  --data '{
  "name": "Internal Web Server",
  "type": "PRIVATE",
  "description": "Internal web server for company applications",
  "addresses": [
    {
      "address": "192.168.1.100",
      "protocols": [
        "550e8400-e29b-41d4-a716-446655440000",
        "550e8400-e29b-41d4-a716-446655440001"
      ]
    }
  ]
}'
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2023-01-15T14:30:00Z",
  "updatedAt": "2023-01-15T14:30:00Z",
  "name": "Internal Web Server",
  "type": "PRIVATE",
  "loadBalancingMode": "MANUAL",
  "status": "ONLINE",
  "description": "Internal web server for company applications",
  "addresses": [],
  "gateways": []
}