How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rhombus Systems Lockdown Plan Webservice API

The Lockdown Plan Webservice API from Rhombus Systems — 17 operation(s) for lockdown plan webservice.

Rhombus Systems Lockdown Plan Webservice API is one of 65 APIs that Rhombus Systems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Lockdown Plan Webservice. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 17 operations across 17 paths, and defines 98 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api2.rhombussystems.com.

17 operations 17 paths 98 schemas 17 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api2.rhombussystems.com/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Rhombus Systems Lockdown Plan Webservice API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-auth-apikey (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Paths & Operations 17

Across 17 paths, the API surfaces 17 operations — 17 POST. Each is listed below with its method, path, parameters, and response codes.

Lockdown Plan Webservice 17
POST
/api/accesscontrol/lockdownPlan/activateLockdownForLocation
Activate lockdown for the specified location
activateLockdownForLocation 1 param body → 200
POST
/api/accesscontrol/lockdownPlan/createLocationLockdownPlan
Create location lockdown plan
createLocationLockdownPlan 1 param body → 200
POST
/api/accesscontrol/lockdownPlan/createLockdownRuleForLocation
Create lockdown rule for location
createLockdownRuleForLocation 1 param body → 200
POST
/api/accesscontrol/lockdownPlan/deactivateLockdownForLocation
Deactivate lockdown for the specified location
deactivateLockdownForLocation 1 param body → 200
POST
/api/accesscontrol/lockdownPlan/deleteLocationLockdownState
Delete location lockdown state
deleteLocationLockdownState 1 param body → 200
POST
/api/accesscontrol/lockdownPlan/deleteLockdownPlan
Delete lockdown plan
deleteLockdownPlan 1 param body → 200
POST
/api/accesscontrol/lockdownPlan/deleteLockdownRuleForLocation
Delete lockdown rule for location
deleteLockdownRuleForLocation 1 param body → 200
POST
/api/accesscontrol/lockdownPlan/disableLockdownTestModeForLocation
Disable test mode of lockdown for the specified location
disableLockdownTestModeForLocation 1 param body → 200
POST
/api/accesscontrol/lockdownPlan/enableLockdownTestModeForLocation
Enable test mode of lockdown for the specified location
enableLockdownTestModeForLocation 1 param body → 200
POST
/api/accesscontrol/lockdownPlan/findLocationLockdownEvents
Find location lockdown events
findLocationLockdownEvents 1 param body → 200
POST
/api/accesscontrol/lockdownPlan/findLocationLockdownStates
Find location lockdown states
findLocationLockdownStates 1 param body → 200
POST
/api/accesscontrol/lockdownPlan/findLockdownPlans
Find lockdown plans in the org
findLockdownPlans 1 param body → 200
POST
/api/accesscontrol/lockdownPlan/findLockdownPlansByLocation
Find lockdown plans for the specified location
findLockdownPlansByLocation 1 param body → 200
POST
/api/accesscontrol/lockdownPlan/getLockdownPlan
Get lockdown plan
getLockdownPlan 1 param body → 200
POST
/api/accesscontrol/lockdownPlan/getLockdownRulesForLocation
Get lockdown rules for location
getLockdownRulesForLocation 1 param body → 200
POST
/api/accesscontrol/lockdownPlan/getOrCreateLocationLockdownState
Get or create location lockdown state
getOrCreateLocationLockdownState 1 param body → 200
POST
/api/accesscontrol/lockdownPlan/updateLocationLockdownPlan
Update location lockdown plan
updateLocationLockdownPlan 1 param body → 200

Schemas 98

The contract defines 98 schemas that model the data the API accepts and returns. The most detailed are ClipBoundingBoxType (25 properties), RuleActionType (21 properties), LocationLockdownPlanType (14 properties), BaseLockdownPlanType (13 properties). Each schema is shown below with its type and property counts.

ConnectAudioDeviceToMobileAppActionType
object
4 properties
PointType
object
2 properties
AccessStateOverrideExpirationStrategyEnum
string
ChangeComponentCompositeAccessStateActionType
object
8 properties
BaseLocationLockdownEventOriginator
object
1 property
LocationLockdownStateEnumType
string
Accesscontrol_lockdownplan_GetLockdownRulesForLocationWSRequest
object
Request to retrieve all lockdown rules for a specific location.
1 property
ReportLookbackTypeEnum
string
EnableDisableAudioRecordActionType
object
2 properties
IntegrationNotificationActionType
object
3 properties
NoOpAction
objectnull
2 properties
Accesscontrol_lockdownplan_GetLockdownPlanWSResponse
object
Response containing the requested lockdown plan.
1 property
SensorValType
object
3 properties
Accesscontrol_lockdownplan_CreateLockdownRuleForLocationWSResponse
object
Response containing the UUID of the created lockdown rule.
4 properties
CreateAlarmTriggerTypeEnum
string
ComponentRelayOutputTypeEnum
string
ActivityEnum
string
CancelLoopingAudioPlaybackActionType
object
2 properties
ToastOrderIdType
object
5 properties
RuleActionType
object
The action to take when this lockdown rule is triggered.
21 properties
Accesscontrol_lockdownplan_CreateLocationLockdownPlanWSResponse
object
Response containing the created location lockdown plan.
1 property
ActivateLocationLockdownActionType
object
2 properties
Accesscontrol_lockdownplan_FindLocationLockdownEventsWSRequest
object
Request to find lockdown events for a specific location with optional time filtering.
4 properties 1 required
CustomRuleAction
object
2 properties
Accesscontrol_lockdownplan_EnableLockdownTestModeForLocationWSResponse
object
Response containing the updated lockdown state after enabling test mode.
1 property
BaseLockdownStateEventType
object
List of lockdown events found for the specified location.
7 properties
GenericRelayStateEnumType
string
AudioPlaybackActionType
object
4 properties
Accesscontrol_lockdownplan_EnableLockdownTestModeForLocationWSRequest
object
Request to enable test mode for lockdown at a specific location.
1 property
LocationLockdownPlanType
object
The updated location lockdown plan.
14 properties
Accesscontrol_lockdownplan_DisableLockdownTestModeForLocationWSRequest
object
Request to disable test mode for lockdown at a specific location.
1 property
Accesscontrol_lockdownplan_CreateLockdownRuleForLocationWSRequest
object
Request to create a new lockdown rule for a specific location.
1 property
ReportLookbackUnitEnum
string
ActivityEventData
object
4 properties
Accesscontrol_lockdownplan_ActivateLockdownForLocationWSResponse
object
Response containing the result of activating lockdown for a location.
2 properties
Accesscontrol_lockdownplan_FindLockdownPlansWSRequest
object
Request to search for lockdown plans across the organization.
TriggerComponentRelayActionType
object
7 properties
DeviceTypeEnum
string
Accesscontrol_lockdownplan_FindLocationLockdownStatesWSRequest
object
Request to find location lockdown states with optional filtering.
1 property
Accesscontrol_lockdownplan_GetOrCreateLocationLockdownStateWSRequest
object
Request to retrieve an existing lockdown state or create one for a specific location.
1 property
Accesscontrol_lockdownplan_DeleteLocationLockdownStateWSResponse
object
Response indicating successful deletion of location lockdown state.
LockdownTestPlanType
object
2 properties
Accesscontrol_lockdownplan_DeleteLockdownPlanWSResponse
object
Response confirming the deletion of a lockdown plan.
2 properties
NavigationTypeEnum
string
LockdownPlanScopeEnumType
string
EmailAuditLogExportActionType
object
7 properties
ConnectAudioDeviceToPhoneNumberActionType
object
5 properties
Accesscontrol_lockdownplan_GetLockdownRulesForLocationWSResponse
object
Response containing a list of lockdown rules for a specific location.
4 properties
ThirdPartyAudioPlaybackActionType
object
7 properties
LockdownActivationPlanType
object
3 properties
RobotActionTypeEnum
string
RobotAction
object
2 properties
Accesscontrol_lockdownplan_DeleteLockdownPlanWSRequest
object
Request to delete a specific lockdown plan by UUID.
1 property
Accesscontrol_lockdownplan_DeleteLockdownRuleForLocationWSResponse
object
Response indicating successful deletion of a lockdown rule.
3 properties
IntegrationCommandActionType
object
3 properties
LockdownDeactivationPlanType
object
3 properties
Accesscontrol_lockdownplan_FindLocationLockdownStatesWSResponse
object
Response containing a list of location lockdown states.
1 property
EmergencyContact
object
2 properties 2 required
Accesscontrol_lockdownplan_DisableLockdownTestModeForLocationWSResponse
object
Response containing the updated lockdown state after disabling test mode.
1 property
Accesscontrol_lockdownplan_DeleteLockdownRuleForLocationWSRequest
object
Request to delete a specific lockdown rule for a location.
2 properties
LockdownEventOriginatorEnumType
string
Accesscontrol_lockdownplan_CreateLocationLockdownPlanWSRequest
object
Request to create a new location lockdown plan.
1 property
LockdownPlanReference
object
3 properties
ClipBoundingBoxType
object
25 properties
LockdownPhysicalAccessType
object
2 properties
FootageSeekPointColorEnum
string
DoorLockdownStateEnumType
string
Accesscontrol_lockdownplan_DeactivateLockdownForLocationWSRequest
object
Request to deactivate lockdown for a specific location with optional optimistic locking.
2 properties
Accesscontrol_lockdownplan_GetOrCreateLocationLockdownStateWSResponse
object
Response containing the lockdown state for the specified location.
1 property
ToastCheckInfo
object
1 property
Accesscontrol_lockdownplan_GetLockdownPlanWSRequest
object
Request to retrieve a specific lockdown plan by UUID.
1 property
BaseLockdownPlanType
object
The requested lockdown plan.
13 properties
Accesscontrol_lockdownplan_ExternalLockdownPlanRuleType
object
External representation of a lockdown plan rule configuration.
6 properties
ThirdPartyStrobeSirenActionType
object
12 properties
WebhookActionType
object
8 properties
RemoteDoorUnlockSystemEnum
string
Accesscontrol_lockdownplan_FindLocationLockdownEventsWSResponse
object
Response containing a list of lockdown events for a specific location.
1 property
Accesscontrol_lockdownplan_FindLockdownPlansByLocationWSRequest
object
Request to search for lockdown plans for a specific location.
1 property
DeployRobotAction
objectnull
2 properties
Accesscontrol_lockdownplan_UpdateLocationLockdownPlanWSRequest
object
Request to update an existing location lockdown plan with selective field updates.
8 properties
Accesscontrol_lockdownplan_UpdateLocationLockdownPlanWSResponse
object
Response containing the updated location lockdown plan.
1 property
IntegrationEnum
string
Accesscontrol_lockdownplan_ActivateLockdownForLocationWSRequest
object
Request to activate lockdown for a specific location with optional optimistic locking.
3 properties
LocationLockdownStateType
object
The lockdown state for the location.
8 properties
RuleFilterType
object
Optional filters to apply to this lockdown rule.
2 properties
LockdownActivationResultEnumType
string
The result of the lockdown activation operation.
Pose
object
2 properties
Accesscontrol_lockdownplan_DeactivateLockdownForLocationWSResponse
object
Response containing the result of deactivating lockdown for a location.
2 properties
AMSirenSettingsType
object
4 properties 2 required
Accesscontrol_lockdownplan_FindLockdownPlansWSResponse
object
Response containing a list of lockdown plans found in the organization.
1 property
LockdownDeactivationResultEnumType
string
The result of the lockdown deactivation operation.
AccessControlledDoorStateEnumType
string
CustomLLMActionType
object
5 properties
CreateAlarmActionType
object
11 properties
RemoteDoorUnlockActionType
object
3 properties
Accesscontrol_lockdownplan_DeleteLocationLockdownStateWSRequest
object
Request to delete the lockdown state tracking for a specific location.
1 property
LockdownStateEventEnumType
string
Accesscontrol_lockdownplan_FindLockdownPlansByLocationWSResponse
object
Response containing a list of lockdown plans found for the specified location.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rhombus-systems-lockdown-plan-webservice-api-openapi.yml Raw ↑

Other APIs Rhombus Systems publishes across the network.

Rhombus Console WebSocket API
Rhombus Systems Access Control Integrations Webservice API
Rhombus Systems Access Control Webservice API
Rhombus Systems Alarm Monitoring Keypad Webservice API
Rhombus Systems Alert Monitoring Webservice API
Rhombus Systems AudioGateway Webservice API
Rhombus Systems AudioPlayback Webservice API
Rhombus Systems Badge Reader Webservice API
Rhombus Systems BLE Webservice API
Rhombus Systems Button Webservice API
Rhombus Systems Camera Webservice API
Rhombus Systems ClaimKey Webservice API
Where this information came from

This is an independent, third-party profile of Rhombus Systems Lockdown Plan Webservice API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.