VEverdun
sites

Generate Site Disarm Passcode

post/sites/{site_id}/disarm-passcode

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/sites/{site_id}/disarm-passcode
  • Auth
    HTTP bearer

Path parameters

site_idstring required

Request body

passcodestring password nullable

The code to set, e.g. 'Blue Tiger 7'. Letters, numbers and spaces; case, spaces and dashes are ignored when it is texted or spoken. Omit for six random digits.

Example request

{
  "passcode": "******"
}

Response

Successful Response

passcodestring required

The site's new passcode: six random digits, or the chosen code as typed. Readable again later through GET /sites/{id}/disarm-passcode. The example is redacted on purpose.

has_disarm_passcodeboolean required

Always true on this response; mirrors the site payload's field.

disarm_passcode_hintstring required

Last two characters, for rendering the stored code as '••••92'.

disarm_max_minutesinteger required

The site's current cap, echoed so the instructions panel can name it.

Example response

{
  "passcode": "******",
  "has_disarm_passcode": true,
  "disarm_passcode_hint": "92",
  "disarm_max_minutes": 120
}

Changes

No recorded changes to this operation across all 2 revisions of this API.