---
title: "Sets the state of a host"
method: POST
path: "/config/endpointhoststate"
---

# Sets the state of a host

`POST /config/endpointhoststate`

## Request

- Base URL: `http://0.0.0.0:11111/netlox/v1`
- URL: `http://0.0.0.0:11111/netlox/v1/config/endpointhoststate`
- Auth: API key in header `Authorization`

Sets the state of a host which can have multiple endpoints. The state affects traffic forwarding only for load-balancer rules created with monitor set to true; rules without it keep forwarding to the host regardless of this state

## Request body

- EndPointHostState
  - `hostName` string: Host name in CIDR
  - `epPort` integer: The end-point port (0 if not applicable)
  - `epProto` string: The end-point prototype (tcp,udp,sctp,icmp,http(s), empty if not applicable)
  - `state` string: Host state string ("green", "yellow", "red" )

## 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

## Changes

- **2025-02-20** `8f31422df7c1`: 1 info
  - endpoint added
- **2023-06-29** `0e6bd4e2dcc9`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/loxilb-io/apis/loxilb-rest-api/changes/config/endpointhoststate/post.md)

---

[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.dev/loxilb-io/apis/loxilb-rest-api/revisions/cb6820b4f999?raw)