idstring(uuid)required
The unique identifier (UUID) of the gateway
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
Response
200 application/json
Response
200 application/json
GatewayDto
Network gateway configuration and status information
idstring(uuid)required
Unique identifier for the gateway
createdAtstring(date-time)required
Timestamp when the gateway was created
deployedOnstring | null(date-time)required
Timestamp when the gateway was first successfully deployed
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]
List of resources accessible through this gateway
Show Child Parameters
post/tenants/gateways/{id}/enable-relay
Authentication
Path Parameters
200 application/json
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
200 application/json
Response
200 application/json
GatewayDto
Network gateway configuration and status information
idstring(uuid)required
Unique identifier for the gateway
createdAtstring(date-time)required
Timestamp when the gateway was created
deployedOnstring | null(date-time)required
Timestamp when the gateway was first successfully deployed
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]
List of resources accessible through this gateway
Show Child Parameters
post/tenants/gateways/{id}/disable-relay
Authentication
Path Parameters
200 application/json
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
200 application/json
Response
200 application/json
object
post/tenants/gateways/{id}/test-configuration
Authentication
Path Parameters
200 application/json
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
Body
application/json
CreateResourceDto
addressesarray[object]required
Show Child Parameters
namestringrequired
typestringrequired
Allowed values:PRIVATESAASINTERNET
descriptionstring
Response
application/json
Response
application/json
Successfully created the resource
ResourceDto
idstring(uuid)required
createdAtstring(date-time)required
updatedAtstring(date-time)required
namestringrequired
typestringrequired
Allowed values:PRIVATESAASINTERNET
loadBalancingModestringrequired
Allowed values:MANUALAUTOMATIC
Default:MANUAL
statusstring
Allowed values:ONLINEOFFLINE
descriptionstring
addressesarray[object]required
Show Child Parameters
gatewaysarray[object]required
Network gateway configuration and status information
Show Child Parameters
post/tenants/resources
Authentication
Body
{
"addresses": [
{
"protocols": [
"[]"
],
"address": "address"
}
],
"name": "name",
"type": "PRIVATE"
}
application/json