Openpath orgs/lockdownPlans API

The orgs/lockdownPlans API from Openpath — 4 operation(s) for orgs/lockdownplans.

Operations 7

GET /orgs/{orgId}/lockdownPlans List all lockdown plans #
POST /orgs/{orgId}/lockdownPlans Create a lockdown plan #
GET /orgs/{orgId}/lockdownPlans/{lockdownPlanId} Describe a lockdown plan #
DELETE /orgs/{orgId}/lockdownPlans/{lockdownPlanId} Delete a lockdown plan #
PATCH /orgs/{orgId}/lockdownPlans/{lockdownPlanId} Update a lockdown plan #
PUT /orgs/{orgId}/lockdownPlans/{lockdownPlanId}/permissions Set a lockdown plan's user and group permissions #
PUT /orgs/{orgId}/lockdownPlans/{lockdownPlanId}/zoneStates Set a lockdown plan's zone states #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/openpath-orgs-lockdownplans-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openpath-orgs-lockdownplans-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Openpath API Documentation auth Orgs/lockdown Plans API
  version: 1.0.0
  description: Authentication and Login
servers:
- url: https://api.openpath.com
tags:
- name: orgs/lockdownPlans
paths:
  /orgs/{orgId}/lockdownPlans:
    get:
      summary: List all lockdown plans
      operationId: listLockdownPlans
      description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-account:r,o{params.orgId}-account:w,o{params.orgId}-admin:r,o{params.orgId}-admin:w,o{params.orgId}-advancedOxygenReports:r,o{params.orgId}-advancedOxygenReports:w,o{params.orgId}-alarmActions:w,o{params.orgId}-alarmConfigurations:r,o{params.orgId}-alarmConfigurations:w,o{params.orgId}-alertSettings:r,o{params.orgId}-alertSettings:w,o{params.orgId}-badgePrinting:r,o{params.orgId}-badgePrinting:w,o{params.orgId}-building:r,o{params.orgId}-building:w,o{params.orgId}-cert:r,o{params.orgId}-cert:w,o{params.orgId}-cert{params.authCertId}:r,o{params.orgId}-cert{params.authCertId}:w,o{params.orgId}-cleanupMsiAware:w,o{params.orgId}-cobalt:r,o{params.orgId}-cobalt:w,o{params.orgId}-configurations:r,o{params.orgId}-configurations:w,o{params.orgId}-credential:r,o{params.orgId}-credential:w,o{params.orgId}-dash:r,o{params.orgId}-dash:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dashActivity:w,o{params.orgId}-dashAlarm:r,o{params.orgId}-dashAlarm:w,o{params.orgId}-dashCust:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashEntry:r,o{params.orgId}-dashEntry:w,o{params.orgId}-entryAccessAudit:r,o{params.orgId}-entryAccessAudit:w,o{params.orgId}-entryState:r,o{params.orgId}-entryState:w,o{params.orgId}-erpParentCenter:w,o{params.orgId}-erpParentStore:w,o{params.orgId}-eventsMsiAware:w,o{params.orgId}-exportClips:w,o{params.orgId}-haloAdmin:w,o{params.orgId}-haloUser:w,o{params.orgId}-haloViewer:r,o{params.orgId}-hw:r,o{params.orgId}-hw:w,o{params.orgId}-idp-scim:r,o{params.orgId}-idp-scim:w,o{params.orgId}-integrations:r,o{params.orgId}-integrations:w,o{params.orgId}-ipRestriction:r,o{params.orgId}-ipRestriction:w,o{params.orgId}-ldp:r,o{params.orgId}-ldp:w,o{params.orgId}-map:r,o{params.orgId}-map:w,o{params.orgId}-mobileAppSettings:r,o{params.orgId}-mobileAppSettings:w,o{params.orgId}-musterReport:r,o{params.orgId}-musterReport:w,o{params.orgId}-occupancyReport:r,o{params.orgId}-occupancyReport:w,o{params.orgId}-opvideoDevice:r,o{params.orgId}-opvideoDevice:w,o{params.orgId}-opvideoIntercom:r,o{params.orgId}-opvideoIntercom:w,o{params.orgId}-outboundWebhooks:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o{params.orgId}-portalAudit:r,o{params.orgId}-portalAudit:w,o{params.orgId}-policy:r,o{params.orgId}-policy:w,o{params.orgId}-policySection:r,o{params.orgId}-policySection:w,o{params.orgId}-presence:r,o{params.orgId}-presence:w,o{params.orgId}-quickStart:r,o{params.orgId}-quickStart:w,o{params.orgId}-realUserGroup:r,o{params.orgId}-realUserGroup:w,o{params.orgId}-restriction:r,o{params.orgId}-restriction:w,o{params.orgId}-role:r,o{params.orgId}-role:w,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-rptAlarm:r,o{params.orgId}-rptAlarm:w,o{params.orgId}-rptDownload:r,o{params.orgId}-rptGeneral:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-serviceCancellation:w,o{params.orgId}-site:r,o{params.orgId}-site:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-sos:w,o{params.orgId}-timeRestriction:r,o{params.orgId}-timeRestriction:w,o{params.orgId}-user:r,o{params.orgId}-user:w,o{params.orgId}-videoAdmin:w,o{params.orgId}-videoProviderLive:w,o{params.orgId}-videoProviderPlayback:w,o:w,o:r,s-o:w,s-o:r,o{params.orgId}-sos:w<br/><br/>__Endpoint name__: listLockdownPlans'
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: integer
      - name: limit
        in: query
        schema:
          type: integer
          maximum: 1000
          minimum: 1
      - name: offset
        in: query
        schema:
          type: integer
          default: 0
          minimum: 0
      - name: sort
        in: query
        schema:
          type: string
          default: ordinal
          pattern: ^[a-zA-Z0-9.]+(,\s*[a-zA-Z0-9.]+)*$
      - name: order
        in: query
        schema:
          type: string
          default: asc
          pattern: ^(asc|desc)+(,\s*(asc|desc)+)*$
      - name: q
        in: query
        schema:
          type: string
      - name: filter
        in: query
        schema:
          type: string
      - name: preFilter
        in: query
        schema:
          type: string
      - name: options
        in: query
        schema:
          type: string
          default: ''
      tags:
      - orgs/lockdownPlans
      security:
      - jwt: []
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalCount:
                    type: integer
                  filteredCount:
                    type: integer
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        opal:
                          type: string
                        name:
                          type: string
                        ordinal:
                          type: integer
                        autoRevertAfterSeconds:
                          type:
                          - integer
                          - 'null'
                        isStandard:
                          type: boolean
                        isActive:
                          type: boolean
                        activeUntil:
                          type:
                          - string
                          - 'null'
                          format: date
                        stateChangedAt:
                          type:
                          - string
                          - 'null'
                          format: date
                        stateChangedRequestId:
                          type:
                          - string
                          - 'null'
                        org:
                          type: object
                          properties:
                            id:
                              type: integer
                            opal:
                              type: string
                            name:
                              type: string
                          required:
                          - id
                        zoneStates:
                          type: array
                          items:
                            type: object
                            properties:
                              zone:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                required:
                                - id
                              entryState:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                required:
                                - id
                        triggerUsers:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              identity:
                                type: object
                                properties:
                                  firstName:
                                    type:
                                    - string
                                    - 'null'
                                  middleName:
                                    type:
                                    - string
                                    - 'null'
                                  lastName:
                                    type:
                                    - string
                                    - 'null'
                                  fullName:
                                    type:
                                    - string
                                    - 'null'
                                  initials:
                                    type:
                                    - string
                                    - 'null'
                                  email:
                                    type: string
                                  namespace:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      nickname:
                                        type:
                                        - string
                                        - 'null'
                                      namespaceType:
                                        type: object
                                        properties:
                                          id:
                                            type: number
                                          name:
                                            type: string
                                          modelName:
                                            type:
                                            - string
                                            - 'null'
                                        required:
                                        - id
                                    required:
                                    - id
                              sites:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: number
                                    name:
                                      type: string
                                  required:
                                  - id
                            required:
                            - id
                        triggerGroups:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              sites:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: number
                                    name:
                                      type: string
                                  required:
                                  - id
                            required:
                            - id
                        revertUsers:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              identity:
                                type: object
                                properties:
                                  firstName:
                                    type:
                                    - string
                                    - 'null'
                                  middleName:
                                    type:
                                    - string
                                    - 'null'
                                  lastName:
                                    type:
                                    - string
                                    - 'null'
                                  fullName:
                                    type:
                                    - string
                                    - 'null'
                                  initials:
                                    type:
                                    - string
                                    - 'null'
                                  email:
                                    type: string
                                  namespace:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      nickname:
                                        type:
                                        - string
                                        - 'null'
                                      namespaceType:
                                        type: object
                                        properties:
                                          id:
                                            type: number
                                          name:
                                            type: string
                                          modelName:
                                            type:
                                            - string
                                            - 'null'
                                        required:
                                        - id
                                    required:
                                    - id
                              sites:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: number
                                    name:
                                      type: string
                                  required:
                                  - id
                            required:
                            - id
                        revertGroups:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              sites:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: number
                                    name:
                                      type: string
                                  required:
                                  - id
                            required:
                            - id
                      required:
                      - id
                  meta:
                    type: object
                    properties:
                      accessToken:
                        type:
                        - object
                        - 'null'
                        properties:
                          scopeUpdatedAt:
                            type: string
                            format: date
                      siteSpecificAccess:
                        type:
                        - object
                        - 'null'
                        properties:
                          isSiteSpecific:
                            type: boolean
                          siteIds:
                            type:
                            - array
                            - 'null'
                            items:
                              type: integer
                          siteIdsByScope:
                            type:
                            - object
                            - 'null'
                            properties:
                              string:
                                type:
                                - array
                                - 'null'
                                items:
                                  type: integer
      x-op-scopes:
      - o{params.orgId}-account:r
      - o{params.orgId}-account:w
      - o{params.orgId}-admin:r
      - o{params.orgId}-admin:w
      - o{params.orgId}-advancedOxygenReports:r
      - o{params.orgId}-advancedOxygenReports:w
      - o{params.orgId}-alarmActions:w
      - o{params.orgId}-alarmConfigurations:r
      - o{params.orgId}-alarmConfigurations:w
      - o{params.orgId}-alertSettings:r
      - o{params.orgId}-alertSettings:w
      - o{params.orgId}-badgePrinting:r
      - o{params.orgId}-badgePrinting:w
      - o{params.orgId}-building:r
      - o{params.orgId}-building:w
      - o{params.orgId}-cert:r
      - o{params.orgId}-cert:w
      - o{params.orgId}-cert{params.authCertId}:r
      - o{params.orgId}-cert{params.authCertId}:w
      - o{params.orgId}-cleanupMsiAware:w
      - o{params.orgId}-cobalt:r
      - o{params.orgId}-cobalt:w
      - o{params.orgId}-configurations:r
      - o{params.orgId}-configurations:w
      - o{params.orgId}-credential:r
      - o{params.orgId}-credential:w
      - o{params.orgId}-dash:r
      - o{params.orgId}-dash:w
      - o{params.orgId}-dashActivity:r
      - o{params.orgId}-dashActivity:w
      - o{params.orgId}-dashAlarm:r
      - o{params.orgId}-dashAlarm:w
      - o{params.orgId}-dashCust:r
      - o{params.orgId}-dashCust:w
      - o{params.orgId}-dashEntry:r
      - o{params.orgId}-dashEntry:w
      - o{params.orgId}-entryAccessAudit:r
      - o{params.orgId}-entryAccessAudit:w
      - o{params.orgId}-entryState:r
      - o{params.orgId}-entryState:w
      - o{params.orgId}-erpParentCenter:w
      - o{params.orgId}-erpParentStore:w
      - o{params.orgId}-eventsMsiAware:w
      - o{params.orgId}-exportClips:w
      - o{params.orgId}-haloAdmin:w
      - o{params.orgId}-haloUser:w
      - o{params.orgId}-haloViewer:r
      - o{params.orgId}-hw:r
      - o{params.orgId}-hw:w
      - o{params.orgId}-idp-scim:r
      - o{params.orgId}-idp-scim:w
      - o{params.orgId}-integrations:r
      - o{params.orgId}-integrations:w
      - o{params.orgId}-ipRestriction:r
      - o{params.orgId}-ipRestriction:w
      - o{params.orgId}-ldp:r
      - o{params.orgId}-ldp:w
      - o{params.orgId}-map:r
      - o{params.orgId}-map:w
      - o{params.orgId}-mobileAppSettings:r
      - o{params.orgId}-mobileAppSettings:w
      - o{params.orgId}-musterReport:r
      - o{params.orgId}-musterReport:w
      - o{params.orgId}-occupancyReport:r
      - o{params.orgId}-occupancyReport:w
      - o{params.orgId}-opvideoDevice:r
      - o{params.orgId}-opvideoDevice:w
      - o{params.orgId}-opvideoIntercom:r
      - o{params.orgId}-opvideoIntercom:w
      - o{params.orgId}-outboundWebhooks:r
      - o{params.orgId}-outboundWebhooks:w
      - o{params.orgId}-parcelMgmtParcels:r
      - o{params.orgId}-parcelMgmtParcels:w
      - o{params.orgId}-portalAudit:r
      - o{params.orgId}-portalAudit:w
      - o{params.orgId}-policy:r
      - o{params.orgId}-policy:w
      - o{params.orgId}-policySection:r
      - o{params.orgId}-policySection:w
      - o{params.orgId}-presence:r
      - o{params.orgId}-presence:w
      - o{params.orgId}-quickStart:r
      - o{params.orgId}-quickStart:w
      - o{params.orgId}-realUserGroup:r
      - o{params.orgId}-realUserGroup:w
      - o{params.orgId}-restriction:r
      - o{params.orgId}-restriction:w
      - o{params.orgId}-role:r
      - o{params.orgId}-role:w
      - o{params.orgId}-rpt:r
      - o{params.orgId}-rpt:w
      - o{params.orgId}-rptAlarm:r
      - o{params.orgId}-rptAlarm:w
      - o{params.orgId}-rptDownload:r
      - o{params.orgId}-rptGeneral:r
      - o{params.orgId}-rptGeneral:w
      - o{params.orgId}-serviceCancellation:w
      - o{params.orgId}-site:r
      - o{params.orgId}-site:w
      - o{params.orgId}-siteGeneral:r
      - o{params.orgId}-siteGeneral:w
      - o{params.orgId}-sos:w
      - o{params.orgId}-timeRestriction:r
      - o{params.orgId}-timeRestriction:w
      - o{params.orgId}-user:r
      - o{params.orgId}-user:w
      - o{params.orgId}-videoAdmin:w
      - o{params.orgId}-videoProviderLive:w
      - o{params.orgId}-videoProviderPlayback:w
      - o:w
      - o:r
      - s-o:w
      - s-o:r
      - o{params.orgId}-sos:w
    post:
      summary: Create a lockdown plan
      operationId: createLockdownPlan
      description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-ldp:w,o:w,s-o:w<br/><br/>__Endpoint name__: createLockdownPlan'
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: integer
      tags:
      - orgs/lockdownPlans
      security:
      - jwt: []
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      opal:
                        type: string
                      name:
                        type: string
                      ordinal:
                        type: integer
                      autoRevertAfterSeconds:
                        type:
                        - integer
                        - 'null'
                      isStandard:
                        type: boolean
                      isActive:
                        type: boolean
                      activeUntil:
                        type:
                        - string
                        - 'null'
                        format: date
                      stateChangedAt:
                        type:
                        - string
                        - 'null'
                        format: date
                      stateChangedRequestId:
                        type:
                        - string
                        - 'null'
                      org:
                        type: object
                        properties:
                          id:
                            type: integer
                          opal:
                            type: string
                          name:
                            type: string
                        required:
                        - id
                      zoneStates:
                        type: array
                        items:
                          type: object
                          properties:
                            zone:
                              type: object
                              properties:
                                id:
                                  type: integer
                              required:
                              - id
                            entryState:
                              type: object
                              properties:
                                id:
                                  type: integer
                              required:
                              - id
                      triggerUsers:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            identity:
                              type: object
                              properties:
                                firstName:
                                  type:
                                  - string
                                  - 'null'
                                middleName:
                                  type:
                                  - string
                                  - 'null'
                                lastName:
                                  type:
                                  - string
                                  - 'null'
                                fullName:
                                  type:
                                  - string
                                  - 'null'
                                initials:
                                  type:
                                  - string
                                  - 'null'
                                email:
                                  type: string
                                namespace:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    nickname:
                                      type:
                                      - string
                                      - 'null'
                                    namespaceType:
                                      type: object
                                      properties:
                                        id:
                                          type: number
                                        name:
                                          type: string
                                        modelName:
                                          type:
                                          - string
                                          - 'null'
                                      required:
                                      - id
                                  required:
                                  - id
                            sites:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: number
                                  name:
                                    type: string
                                required:
                                - id
                          required:
                          - id
                      triggerGroups:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            sites:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: number
                                  name:
                                    type: string
                                required:
                                - id
                          required:
                          - id
                      revertUsers:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            identity:
                              type: object
                              properties:
                                firstName:
                                  type:
                                  - string
                                  - 'null'
                                middleName:
                                  type:
                                  - string
                                  - 'null'
                                lastName:
                                  type:
                                  - string
                                  - 'null'
                                fullName:
                                  type:
                                  - string
                                  - 'null'
                                initials:
                                  type:
                                  - string
                                  - 'null'
                                email:
                                  type: string
                                namespace:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    nickname:
                                      type:
                                      - string
                                      - 'null'
                                    namespaceType:
                                      type: object
                                      properties:
                                        id:
                                          type: number
                                        name:
                                          type: string
                                        modelName:
                                          type:
                                          - string
                                          - 'null'
                                      required:
                                      - id
                                  required:
                                  - id
                            sites:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: number
                                  name:
                                    type: string
                                required:
                                - id
                          required:
                          - id
                      revertGroups:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            sites:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: number
                                  name:
                                    type: string
                                required:
                                - id
                          required:
                          - id
                    required:
                    - id
                  meta:
                    type: object
                    properties:
                      accessToken:
                        type:
                        - object
                        - 'null'
                        properties:
                          scopeUpdatedAt:
                            type: string
                            format: date
                      siteSpecificAccess:
                        type:
                        - object
                        - 'null'
                        properties:
                          isSiteSpecific:
                            type: boolean
                          siteIds:
                            type:
                            - array
                            - 'null'
                            items:
                              type: integer
                          siteIdsByScope:
                            type:
                            - object
                            - 'null'
                            properties:
                              string:
                                type:
                                - array
                                - 'null'
                                items:
                                  type: integer
      x-op-scopes:


# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-lockdownplans-api-openapi.yml