Skip to main content
POST
/
api
/
accesscontrol
/
lockdownPlan
/
activateLockdownForLocation
Activate lockdown for the specified location
curl --request POST \
  --url https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/activateLockdownForLocation \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "lockdownPlanUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "stateUpdatedAtMillis": 123
}
'
{
  "result": "SUCCESS",
  "state": {
    "activeLockdownPlans": [
      {
        "lockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "scope": "ORG_LOCKDOWN",
        "scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "createdAtMillis": 123,
    "followingTestPlan": true,
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "state": "STANDARD_SECURITY",
    "stateChangedAtMillis": 123,
    "updatedAtMillis": 123
  }
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request to activate lockdown for a specific location with optional optimistic locking.

locationUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

lockdownPlanUuids
(string<RUUID> | null)[] | null

Set of lockdown plan UUIDs to activate for the location.

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

stateUpdatedAtMillis
integer<int64> | null

Optional timestamp for optimistic locking to ensure the user is updating the latest record.

Response

200 - application/json

OK

Response containing the result of activating lockdown for a location.

result
enum<string>

The result of the lockdown activation operation.

Available options:
SUCCESS,
INVALID_LOCKDOWN_PLANS,
OPTIMISTIC_CONCURRENCY
state
object

The lockdown state for the location.