HomeGuidesAPI Reference
API Reference

Update HA instance comment

Updates the comment/description field for a specific orchestrator HA instance. Only the comment field from the request body is used; other fields are ignored. The action is logged to the system audit log.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Unique identifier of the orchestrator instance to update. Must match an existing registered instance.

Body Params

Instance object containing the comment to update. Only the comment field is processed; all other fields are ignored.

string

New comment or description for the instance. If blank or null, defaults to empty string.

Responses
200

Successfully updated the instance comment. Returned when the database row was modified.

204

No content - Instance was not found or comment was unchanged. No rows were updated in the database.

401

Unauthorized - Authentication required

403

Forbidden - Insufficient permissions. Requires READ_WRITE role.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json