Skip to main content
POST
/
api
/
accesscontrol
/
lockdownPlan
/
findLocationLockdownStates
Find location lockdown states
curl --request POST \
  --url https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/findLocationLockdownStates \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "stateFilter": [
    "STANDARD_SECURITY"
  ]
}
'
{
  "states": [
    {
      "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 find location lockdown states with optional filtering.

​
stateFilter
enum<string>[] | null

Optional filter to limit results to specific lockdown states.

Available options:
STANDARD_SECURITY,
LOCKED_DOWN

Response

200 - application/json

OK

Response containing a list of location lockdown states.

​
states
object[] | null

List of location lockdown states found for the organization.