Search
K
Cipherscale API

Gateways

Network gateway configuration and management

Create New Gateway

Creates a new network gateway that will serve as an access point for users and devices to connect to the tenant’s network resources. The gateway will be configured with WireGuard VPN settings and endpoint information.

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

Body

application/json

The gateway data to create

CreateGateway

Data required to create a new network gateway

namestringrequired

Human-readable name for the gateway

Example:US-East Gateway

descriptionstring

Detailed description of the gateway’s purpose and location

Example:Primary gateway for US East region data center

wireguardPortstringrequired

WireGuard VPN port number for this gateway

Example:51820

endpointstring

Network endpoint address for the gateway

Example:gateway-us-east.company.com

Response

application/json

Successfully created the gateway

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

Body

{
  "name": "US-East Gateway",
  "description": "Primary gateway for US East region data center",
  "wireguardPort": "51820",
  "endpoint": "gateway-us-east.company.com"
}
{ "name": "US-East Gateway", "description": "Primary gateway for US East region data center", "wireguardPort": "51820", "endpoint": "gateway-us-east.company.com" }
  
curl --request POST \
  --url https://public-api.cipherscale.com/qa/tenants/gateways \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apikey: ' \
  --data '{
  "name": "US-East Gateway",
  "description": "Primary gateway for US East region data center",
  "wireguardPort": "51820",
  "endpoint": "gateway-us-east.company.com"
}'
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"
    }
  ]
}

List All Gateways

Retrieves a comprehensive list of all gateways configured for the tenant, including their status, configuration details, and associated resources. This information is essential for network topology management.

get
https://public-api.cipherscale.com/qa/tenants/gateways

Response

application/json

Successfully retrieved 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/gateways
  
curl --request GET \
  --url https://public-api.cipherscale.com/qa/tenants/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"
    }
  ]
}

Remove Gateway

Permanently removes a gateway from the tenant. This operation will disconnect all associated resources and may impact network connectivity. Ensure all resources are reassigned to other gateways before deletion.

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

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the gateway to delete

Response

Successfully deleted the gateway

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

Update Gateway Configuration

Updates gateway settings including name, description, WireGuard port, endpoint configuration, and operational status. Changes may require gateway restart to take effect.

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

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the gateway to update

Body

application/json

UpdateGateway

Data for updating gateway configuration

statusstring

Current operational status of the gateway

Allowed values:PENDINGONLINEOFFLINEMAINTENANCEERROR

Example:ONLINE

namestringrequired

Human-readable name for the gateway

Example:US-East Gateway

descriptionstring

Detailed description of the gateway’s purpose and location

Example:Primary gateway for US East region data center

wireguardPortstringrequired

WireGuard VPN port number for this gateway

Example:51820

endpointstring

Network endpoint address for the gateway

Example:gateway-us-east.company.com

Response

200 application/json

Successfully updated gateway configuration

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
patch/tenants/gateways/{id}

Body

{
  "name": "US-East Gateway",
  "description": "Primary gateway for US East region data center",
  "wireguardPort": "51820",
  "endpoint": "gateway-us-east.company.com",
  "status": "ONLINE"
}
{ "name": "US-East Gateway", "description": "Primary gateway for US East region data center", "wireguardPort": "51820", "endpoint": "gateway-us-east.company.com", "status": "ONLINE" }
  
curl --request PATCH \
  --url https://public-api.cipherscale.com/qa/tenants/gateways/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apikey: ' \
  --data '{
  "name": "US-East Gateway",
  "description": "Primary gateway for US East region data center",
  "wireguardPort": "51820",
  "endpoint": "gateway-us-east.company.com",
  "status": "ONLINE"
}'
200 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"
    }
  ]
}