Adds a LB endpoint for monitoring

Adds a LB endpoint for monitoring. The probe only updates the endpoint's currState as reported by GET /config/endpoint/all. It has no effect on traffic forwarding unless the load-balancer rule referencing this endpoint is created with monitor set to true, which makes the rule sync probe results into its endpoint states

post/config/endpoint

Request

  • Base URL
    http://0.0.0.0:11111/netlox/v1
  • URL
    http://0.0.0.0:11111/netlox/v1/config/endpoint
  • Auth
    API key in header Authorization

Request body

hostNamestring required

Host name in CIDR

namestring

Endpoint Identifier. If omitted, the entry is keyed as <hostName><probeType><probePort>. To attach this probe to a load-balancer rule end-point (so the rule's monitor flag gates traffic on it), name must be set to <hostName><service-protocol><targetPort> of that rule end-point - the key the rule itself registers. This allows the probe port to differ from the rule's target port

inactiveReTriesinteger

Number of inactive retries

probeType'tcp' | 'udp' | 'sctp' | 'ping' | 'http' | 'https' | 'none'

Type of probe used

probeReqstring

URI for http/https probes

probeRespstring

Response for http/https probes

probeDurationinteger

How frequently to probe in seconds

probePortinteger

The l4port to probe on

Response

OK

Changes

No recorded changes to this operation across all 55 revisions of this API.