get_portal_statuses
Retrieve the live status and current state of every access-control portal or door, with optional filters for portal, state, partition, or location.
Instructions
Returns the live status of portals (doors) — the current state of each door, not its configuration (wraps NBAPI GetPortalStatuses). Each PORTALSTATUS block carries PORTALKEY, PORTALNAME, STATEKEY, STATENAME, THREATLEVELNAME, LOCATIONKEY, LOCATIONNAME, TYPEKEY and PARTITIONKEY. Filter by portal, state, partition or location; use get_portal_states for the STATEKEY vocabulary and get_locations for LOCATIONKEY values.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| STATEKEY | No | Optional. Report only portals currently in this state (see get_portal_states). | |
| PORTALKEY | No | Optional. Report status for this portal only. | |
| LOCATIONKEY | No | Optional. Report status for portals at this location only (see get_locations). | |
| PARTITIONKEY | No | Optional. Report status for portals in this partition only. | |
| ALLPARTITIONS | No | Optional. "TRUE" to report portal status across all partitions. |