Stream the progress of edge (proxy) TLS setup

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

get

Authorizations

defguard_sessionstringRequired

Query parameters

common_namestringRequired

Common name for the edge certificate.

ip_or_domainstringRequired

Address the edge instance is reachable at.

grpc_portinteger · int32Required

gRPC port of the edge instance.

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

get/api/v1/proxy/setup/stream

GET /api/v1/proxy/setup/stream?common_name=text&ip_or_domain=text&grpc_port=1 HTTP/1.1
Accept: */*

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}