---
title: "Adds a LB endpoint for monitoring"
method: POST
path: "/config/endpoint"
---

# Adds a LB endpoint for monitoring

`POST /config/endpoint`

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

## Request body

- EndPoint
  - `hostName` string, required — Host name in CIDR
  - `name` string — 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
  - `inactiveReTries` integer — Number of inactive retries
  - `probeType` 'tcp' | 'udp' | 'sctp' | 'ping' | 'http' | 'https' | 'none' — Type of probe used
  - `probeReq` string — URI for http/https probes
  - `probeResp` string — Response for http/https probes
  - `probeDuration` integer — How frequently to probe in seconds
  - `probePort` integer — The l4port to probe on

## Response `204`

OK

## Other responses

- `400` — Malformed arguments for API call
- `401` — Invalid authentication credentials
- `403` — Capacity insufficient
- `404` — Resource not found
- `409` — Resource Conflict.
- `500` — Internal service error
- `503` — Maintenance mode

---

[API](https://skmtc.dev/loxilb-io/apis/loxilb-rest-api.md) · [All operations](https://skmtc.dev/loxilb-io/apis/loxilb-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/loxilb-io/loxilb-rest-api/revisions/cb6820b4f999/schema)