API reference
Base URL https://api.1keyplatform.dev/v1.
Every endpoint is generated from the OpenAPI contract,
which you can download as openapi.yaml.
Sites
9The buildings your organization manages. Every hub is at a site.
Hubs
22Hubs your organization owns.
- GET Read a hub's logs
- POST Run a recovery action on a hub
- GET Read a hub's Z-Wave radio
- PUT Turn a hub's cellular auto-activate on or off
- POST Save a Wi-Fi network on a hub
- POST Check a hub's network
- GET Read a hub's health
- GET Get a hub's uptime
- GET Read a hub's black box
- GET List a hub's saved Wi-Fi networks
- GET List hubs
- POST Add a hub to a site
- GET List a hub's SIM events
- POST Reset a hub's cloud link
- PUT Reorder a hub's saved Wi-Fi networks
- GET Scan for Wi-Fi networks near a hub
- DELETE Remove a saved Wi-Fi network from a hub
- GET Get a hub's SIM
- GET Read a hub's audit log
- DELETE Remove a hub
- GET Get a hub
- PATCH Update a hub
Intercoms
281Key Intercoms your organization owns: the entry consoles at buildings' doors. They share hubs' scopes.
- GET Read a 1Key intercom's enrollment code
- POST Make a new enrollment code
- GET List an intercom's codes and cards
- POST Add a code, card or face
- DELETE Remove a directory entry
- PATCH Change a directory entry
- GET Read an intercom's concierge prompt
- PATCH Change an intercom's concierge prompt
- GET List intercoms
- POST Add an intercom to a site
- DELETE End a 1Key intercom's enrollment
- GET Where the desktop intercom's updates and models are
- GET Fetch one of the desktop intercom's files
- GET Read an intercom's codes
- POST Start a concierge conversation
- POST Reset an intercom's cloud link
- POST Open an intercom's door
- DELETE Remove a code or card
- PATCH Change a code or card
- GET Read an intercom's settings
- PATCH Change a 1Key intercom's settings
- GET Get an intercom's uptime
- GET List an intercom's directory
- POST Add a directory entry
- GET Read an intercom's directory
- DELETE Remove an intercom
- GET Get an intercom
- PATCH Update an intercom
Fleet
2Your hubs together, or one site's. What they're connected by now, what needs attention, and how they did over the last 24 hours, 7 days or 30 days.
Members
7People in your organization, and invitations to join it.
Devices
15Devices connected to a hub and their channels, read live from the hub.
- POST Confirm a joining device's setup code
- POST Ping a device
- POST Start the hub's device network over
- DELETE Close the removal window
- POST Open the hub's network for a device to leave
- GET Read a device's Z-Wave node
- POST Replace a failed device with a new one
- GET List a hub's devices
- DELETE Close the pairing window
- POST Open the hub's network for a device to join
- POST Describe a device for the registry
- GET Every channel type, as JSON Schema
- DELETE Forget a device the hub can't reach
- GET Get a device and its current state
- PATCH Name a device and set its room
Settings
2A device's own configuration, such as a lock's auto-lock time.
Access
6Lock users, their PINs and cards, and the schedules the hub enforces.
Automations
21Automations, schedules and remote triggers the hub keeps and runs, offline too.
- DELETE Delete a calendar
- GET One calendar
- PUT Create or replace a calendar
- DELETE Delete a schedule
- PUT Create or replace a schedule
- GET A template (latest, or `?version=`)
- PUT Save a template's next version
- POST Deploy a template to hubs
- GET Each template's latest version
- GET The organization's calendars
- POST Fire a hub's remote triggers
- GET An automation's last runs
- DELETE Delete an automation
- GET One automation
- PUT Create or replace an automation
- GET A deployment and each target's status
- GET The hub's automations
- POST Check an automation without saving it
- GET The hub's schedules
- POST Enable, disable, test or run an automation
- POST Fire a remote trigger across hubs and sites
Setup
2Checking a device works before marking its setup complete. The hub runs the checks and keeps the mark.
Devices that join on their own when powered on, from their QR codes. Codes for a hub that is offline, or has never connected, are kept until it connects.
Commands
1Actions sent to a hub's devices.
Events
6Events from your hubs, kept 30 days. Read your organization's log with one cursor, or one hub's events with its own.
Organization
11Your organization, its API keys, their usage and request log, and your email alerts.
Products
2The device registry. Every Z-Wave product 1key knows, with its maker, manual and inclusion, exclusion and reset steps.