Modify Endpoint
/endpointsApply endpoint partial metadata, enablement or merge changes in one SQLite transaction. At least one field besides id is required. An empty 202 is returned only after commit; clients may requery metadata. Endpoint updated notifications are best effort. A merge cannot cross owners or silently rewrite unsupported dependencies; conflicts roll back all changes.
Required scope
endpoint:writeRequest body
Fields
- enablement
string Whether Port OS uses an endpoint or group. A disabled one is hidden from collections by default and cannot be sent device messages or targeted by them; exact authorized reads still return it. Rediscovery never changes it, so disabling is how a user hides a discovered device or room for good.
Default:
ENABLEDAllowed values: ENABLED, DISABLED.
Returns
202
Endpoint modification committed; empty response.
No response body.
Errors
400Invalid partial update or incompatible merge.
Check the request fields and any validation details, then correct the payload.
401Authentication required.
Obtain a valid access token, then retry.
403Endpoint management or dependency permission denied.
Check the linked account and its permissions for the device or resource.
404Endpoint not found.
Verify the target identifier and that its endpoint or plugin route still exists.
409Dependent state prevents merge; nothing changed.
Check the device’s current mode or state. Retry only after the conflict is resolved.
500Modification failed before commit.
Retry with backoff only when the operation is safe to repeat. Include the error code when reporting persistent failures.
503ENDPOINT_COMMITTED_CLEANUP_PENDING. The modification committed, but required active-work cleanup is pending. Re-read source and target before retrying.
Wait for the provider or bridge to recover, then retry safely with backoff.