Stream the progress of edge (proxy) TLS setup
Drives the whole TLS setup flow and reports its progress as Server-Sent Events.
post
Authorizations
defguard_sessionstringRequired
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
401
Session is missing or invalid.
application/json
403
Requires admin privileges.
application/json
post/api/v1/proxy/setup/stream
POST /api/v1/proxy/setup/stream 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":"SigningCertificate","version":null,"message":null,"logs":null,"error":false}
data: {"step":"Done","version":null,"message":null,"logs":null,"error":false}
PreviousStream the progress of Let's Encrypt certificate issuance on the edge
NextGet an edge instance
Last updated
Was this helpful?