Skip to content

Admin WebSocket commands

The Varco integration registers admin commands on the Home Assistant WebSocket API. The /varco panel uses them, and they are the only programmatic admin surface. All commands require an admin Home Assistant user.

Source: custom_components/varco/websocket_api.py.

CommandFieldsResult
varco/infonone{ authority_id, relay } with relay connection status.
varco/access_requestsnoneList of pending access requests.
varco/grantsnoneList of stored grants.
varco/auditnoneList of audit events.
varco/approve_requestrequest_id (required), expires_at (optional ISO timestamp or null), approved_manifest (optional dict; scope lists are intersected with the requested manifest, never widened)The created grant.
varco/reject_requestrequest_id (required){ ok: true }.
varco/revoke_grantgrant_id (required)The revoked grant.
varco/delete_grantgrant_id (required)The deleted grant.
varco/update_grant_restrictionsgrant_id (required), restrictions (required list)The updated grant.
varco/sharesnoneList of unexpired shares, without secret hashes. Expired shares are purged first.
varco/create_sharename (required), manifest (required), max_claims, expires_at, restrictions, note (optional)The created share without its secret hash, plus share_url.
varco/revoke_shareshare_id (required)The revoked share without its secret hash.
varco/delete_shareshare_id (required)The deleted share without its secret hash.
varco/dashboard_exportconfig (required dict), selected_entities, dashboard_title, dashboard_url_path, view_index (optional)Dashboard brief export payload.

Example call over the Home Assistant WebSocket API:

{ "id": 12, "type": "varco/revoke_grant", "grant_id": "GRANT_ID" }

For automations and scripts, the equivalent fallbacks are documented in Home Assistant services.