Contact Support

Manage Lockdowns and Scenarios via API

Manage Verkada lockdowns and scenarios with third-party platforms

Scenarios

In the API, lockdowns are represented as scenarios. Each scenario includes a type field that defines its purpose. You can programmatically manage Verkada scenarios, such as listing available lockdowns, activating one, or releasing an active one, using third-party platforms and automation tools.

Command configuration

Organization level

1

In Verkada Command, go to All Products > Access.

2

On the left navigation, click Access Settings.

3

Toggle on Enable Lockdown and Scenario Control via API.

Generate API key

1

In Verkada Command, go to All Products > Admin.

2

Under Org Settings, click API & Integrations.

3

From the API & Integration settings, select API Keys > Add.

a. Select New Key and click Next. b. Enter a unique name. c. Under Endpoints, select Access Control. d. Set the permissions to Read/Write. e. Set the expiration date. f. Click Generate API.

Available API actions

Once you configure Command to allow API control of scenarios, you can perform the following actions:

See Verkada API Docs for more details on specific Access Control API endpoints.

Activate and release a scenario via API

When a scenario such as a lockdown is activated or released through the API, it behaves the same as if it were triggered manually in Command.

Using the API to activate or release a scenario will:

  • Execute all configured scenario actions, such as locking doors, triggering alerts, or activating AUX outputs.

  • Update the scenario’s status in both the Command interface and the Verkada Pass app.

  • Generate event logs for each action, visible in the Events report and the Command audit log.

Need more help? Contact Verkada Support.

Last updated

Was this helpful?