The gateway data to create
CreateGatewayDto
namestringrequired
descriptionstring
wireguardPortstringrequired
endpointstring
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
Body
application/json
Response
application/json
Response
application/json
Successfully created the gateway
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
Authentication
Body
{
"name": "name",
"wireguardPort": "wireguardPort"
}
application/json
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
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
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
get/tenants/gateways
Authentication
application/json
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
Response
Successfully deleted the gateway
delete/tenants/gateways/{id}
Authentication
Path Parameters
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
Body
application/json
UpdateGatewayDto
statusstring
Allowed values:PENDINGONLINEOFFLINEMAINTENANCEERROR
namestringrequired
descriptionstring
wireguardPortstringrequired
endpointstring
Response
application/json
Response
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
patch/tenants/gateways/{id}
Authentication
Path Parameters
Body
{
"name": "name",
"wireguardPort": "wireguardPort"
}
application/json
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
idstring(uuid)required
The unique identifier (UUID) of the gateway
Example:123e4567-e89b-12d3-a456-426614174000
Response
application/json
Response
application/json
Successfully retrieved the gateway
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
get/tenants/gateways/{id}
Authentication
Path Parameters
application/json