Skip to main content
POST
/
api
/
accesscontrol
/
lockdownPlan
/
createLocationLockdownPlan
Create location lockdown plan
curl --request POST \
  --url https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/createLocationLockdownPlan \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "lockdownPlan": {
    "activationPlan": {
      "groupUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "rhombusKeyNotificationMessage": "<string>",
      "userUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "createdAtMillis": 123,
    "deactivationPlan": {
      "groupUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "rhombusKeyNotificationMessage": "<string>",
      "userUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "defaultLockdownState": "LOCKED_DOWN",
    "doorLockdownStateMap": {},
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "name": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "physicalAccess": {
      "groupUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "userUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "testPlan": {
      "doorStateOverrideEnabled": true,
      "userAccessOverrideEnabled": true
    },
    "type": "ORG_LOCKDOWN",
    "updatedAtMillis": 123,
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}
'
{
  "lockdownPlan": {
    "activationPlan": {
      "groupUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "rhombusKeyNotificationMessage": "<string>",
      "userUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "createdAtMillis": 123,
    "deactivationPlan": {
      "groupUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "rhombusKeyNotificationMessage": "<string>",
      "userUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "defaultLockdownState": "LOCKED_DOWN",
    "doorLockdownStateMap": {},
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "name": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "physicalAccess": {
      "groupUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "userUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "testPlan": {
      "doorStateOverrideEnabled": true,
      "userAccessOverrideEnabled": true
    },
    "type": "ORG_LOCKDOWN",
    "updatedAtMillis": 123,
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-auth-apikey
string
header
required

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

Headers

​
x-auth-scheme
enum<string>
default:api-token
required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

Request to create a new location lockdown plan.

​
lockdownPlan
object

The updated location lockdown plan.

Response

200 - application/json

OK

Response containing the created location lockdown plan.

​
lockdownPlan
object

The updated location lockdown plan.

Last modified on May 7, 2026