For the complete documentation index, see llms.txt. This page is also available as Markdown.

Stream the progress of gateway TLS setup

Drives the whole TLS setup flow and reports its progress as Server-Sent Events.

post
Authorizations
defguard_sessionstringRequired
Path parameters
network_idinteger · int64Required

ID of the network.

Body
common_namestringRequired
grpc_portinteger · int32Required
ip_or_domainstringRequired
Responses
200

Server-Sent Event stream with setup progress. Each event carries the current step name and its result.

text/event-stream
stringOptional
post/api/v1/network/{network_id}/gateways/setup
POST /api/v1/network/{network_id}/gateways/setup HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "common_name": "text",
  "grpc_port": 1,
  "ip_or_domain": "text"
}
data: {"step":"CheckingConfiguration","version":null,"message":null,"logs":null,"error":false}

data: {"step":"CheckingVersion","version":"2.1.0","message":null,"logs":null,"error":false}

data: {"step":"ConfiguringTls","version":null,"message":null,"logs":null,"error":false}

data: {"step":"Done","version":null,"message":null,"logs":null,"error":false}

Last updated

Was this helpful?