ByCloud Docs
GuidesCLIAPISDK
patch/v1/health-monitors/{health_monitor_id}

Update health monitor

Update a health monitor

Path Parameters

health_monitor_id

string<uuid>required

path

Health Monitor ID

Example: "550e8400-e29b-41d4-a716-446655440000"

Request Body

required

Content-Type: application/json

name

stringoptional

admin_state_up

booleanoptional

delay

integeroptional

timeout

integeroptional

max_retries

integeroptional

max_retries_down

integeroptional

http_method

stringoptional

Enum: "GET", "HEAD", "POST", "PUT", "DELETE", "TRACE", "OPTIONS", "CONNECT", "PATCH"

url_path

stringoptional

expected_codes

stringoptional

tags

arrayoptional

Responses

200

Health monitor updated

Content-Type: application/json

health_monitor

objectoptional
400

Invalid request parameters

Content-Type: application/json

error

objectrequired
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
404

Resource not found

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X PATCH "https://api.spo1.mycloud.com/v1/health-monitors/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "admin_state_up": true,
    "delay": 1,
    "timeout": 1,
    "max_retries": 1,
    "max_retries_down": 1,
    "http_method": "GET",
    "url_path": "string",
    "expected_codes": "string",
    "tags": [
      "web",
      "frontend"
    ]
  }'