sites

Get Site Disarm Passcode

get/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

Response

Successful Response

passcodestring nullable

The passcode (six digits, or a chosen code as typed), or null when the site has none or has one minted before codes were kept readable (reset it to view).

viewableboolean required

True when passcode is present.

has_disarm_passcodeboolean required

Whether the site has a working passcode at all, viewable or not.

disarm_passcode_hintstring nullable

Last two characters, present whenever a code exists.

Example response

{
  "passcode": "******",
  "viewable": true,
  "has_disarm_passcode": true,
  "disarm_passcode_hint": "92"
}

Changes

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