Update an HA rule

Changes the VMs, the affinity or the enabled state of a rule. Only the fields you send are changed. VMs and affinity can be changed only on rules created through the portal or API (managed).

Authorization

bearerAuth

AuthorizationBearer <token>

API key created in the portal (Settings → API Keys). Send as Authorization: Bearer <key>.

In: header

Path Parameters

project_uuid*string

Project UUID.

rule_id*string

HA rule ID (rule from the HA overview).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Fields to change on an HA rule. Omitted fields stay as they are.

vmids?array<>

VMIDs the rule applies to: 2 to 3, no duplicates. Each VM can be in one rule only. HA is enabled on these VMs if it is not yet.

affinity?string

negative keeps the VMs on separate nodes, positive keeps them on the same node.

Value in

"positive"
"negative"

enabled?boolean

Whether the rule is applied.

Response Body

`application/json`

curl -X PATCH "https://example.com/cloud/project/string/vm/ha/rules/string/" \  -H "Content-Type: application/json" \  -d '{}'

{  "rule": "string",  "affinity": "positive",  "enabled": true,  "vmids": [    0  ],  "managed": true}