idstring(uuid)required
The unique identifier (UUID) of the gateway
Example:123e4567-e89b-12d3-a456-426614174000
Get Gateway Details
Retrieves comprehensive information about a specific gateway including its configuration, current status, associated resources, and connection statistics.
get
https://public-api.cipherscale.com/qa/tenants/gateways/{id}
Path Parameters
Response
application/json
Response
application/json
Successfully retrieved 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
get/tenants/gateways/{id}
Authentication
Path Parameters
application/json
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
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
Authentication
Path Parameters
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
application/json
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
Authentication
Path Parameters
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
application/json
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
Authentication
Path Parameters
application/json
Resources
Network resource definition and access control