Doorbell Camera

Get rules for all doorbell cameras in an org

Get rules for all doorbell cameras in an org.

POST/api/doorbellcamera/getDoorbellCameraRulesForOrg

Authorizations

x-auth-apikeystringheaderrequired

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

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

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

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request object for retrieving rules for all doorbell cameras in an organization.

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/doorbellcamera/getDoorbellCameraRulesForOrg' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api2.rhombussystems.com/api/doorbellcamera/getDoorbellCameraRulesForOrg"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/doorbellcamera/getDoorbellCameraRulesForOrg', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {}
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/doorbellcamera/getDoorbellCameraRulesForOrg"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "doorbellCameraUuidToRulesMap": {
    "<key>": [
      {
        "action": {
          "activateLocationLockdown": {},
          "alertAction": true,
          "audioPlaybackActions": [],
          "cancelLoopingAudioPlaybackAction": {},
          "changeComponentCompositeAccessStateActions": [],
          "connectAudioDeviceToMobileAppAction": {},
          "connectAudioDeviceToPhoneNumberAction": {},
          "createAlarmAction": {},
          "customActions": [],
          "customLLMActions": [],
          "emailAuditLogExportActions": [],
          "enableDisableAudioRecordActions": [],
          "integrationCommandActions": [],
          "integrationNotificationActions": [],
          "liveNotificationAction": true,
          "remoteDoorUnlockActions": [],
          "robotActions": [],
          "thirdPartyAudioPlaybackAction": {},
          "thirdPartyStrobeSirenAction": {},
          "triggerComponentRelayActions": [],
          "webhookActions": []
        },
        "doorbellCameraComponentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "doorbellCameraUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "ruleFilters": {
          "scheduleUuids": [],
          "triggerBackoffSecs": 0
        },
        "ruleName": "Motion Detection Rule",
        "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "triggerActivity": "SOUND_LOUD"
      }
    ]
  },
  "error": false,
  "errorCode": "<string>"
}

Response

200 OK

application/json · object

Response object containing rules for all doorbell cameras in an organization.

doorbellCameraUuidToRulesMapobject | null

Map of doorbell camera UUIDs to their component rules

Show child attributes

actionobject

The action to take when this lockdown rule is triggered.

Show child attributes

activateLocationLockdownobject

Show child attributes

locationLockdownPlanUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

alertActionboolean | null

audioPlaybackActionsobject[] | null

Show child attributes

audioClipUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

audioGatewaysstring<RUUID>[] | null

loopDurationSecinteger<int32> | null

playCountinteger<int32> | null

sourceenum<string>

Available options: ON_DEVICE, STREAM

cancelLoopingAudioPlaybackActionobject

Show child attributes

_audioDevicesstring<DeviceFacetUuid>[] | null

audioDevicesstring<DeviceFacetUuid>[] | null

changeComponentCompositeAccessStateActionsobject[] | null

Show child attributes

accessStateenum<string>

Available options: UNLOCKED, ACCESS_CONTROLLED

alwaysCreateOverrideIfNoFirstInboolean | null

componentCompositeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

expirationStrategyenum<string>

Available options: TIME_DELAY, TIME_OF_DAY_LOCAL, NONE

expireTimeDelaySecondsinteger<int64> | null

expireTimeOfDayLocalSecondsinteger<int64> | null

useFirstInRulesIfPossibleboolean | null

versioninteger<int32> | null

connectAudioDeviceToMobileAppActionobject

Show child attributes

audioDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceTypeenum<string>

Available options: BLE_TRACKER, CAMERA, DOOR_SENSOR, ENVIRONMENTAL_SENSOR, OCCUPANCY_SENSOR, AUDIO_GATEWAY, EXECUTABLE, BADGE_READER, DOOR_CONTROLLER, BLE_BUTTON, IO_BOARD, ENVIRONMENTAL_GATEWAY, NVR, ROBOT, UNKNOWN

doorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

targetDoorStationUuidsstring<RUUID>[] | null

targetUserUuidsstring<RUUID>[] | null

connectAudioDeviceToPhoneNumberActionobject

Show child attributes

audioDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceTypeenum<string>

doorUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

optionalGreetingstring | null

phoneNumberstring | null

createAlarmActionobject

Show child attributes

attachMediaToActiveAlarmboolean | null

entryInstructionsstring | null

exclusiveEmergencyContactboolean | null

exclusiveEntryInstructionsboolean | null

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

mediaDeviceUuidsstring<DeviceFacetUuid>[] | null

onsiteEmergencyContactobject

Show child attributes

namestring | nullrequired

The name of the emergency contact.

phoneNumberstring | nullrequired

The phone number for this emergency contact.

reasonstring | null

sirenSettingsobject

Show child attributes

audioGatewaysstring<RUUID>[] | nullrequired

UUIDs of audio gateways used to play this siren.

clipUuidstring<RUUID> | nullrequired

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

durationSecondsinteger<int32> | null

The duration (in seconds) to loop the clip audio for the siren.

playCountinteger<int32> | null

The number of times to play the clip audio for the siren.

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

triggerTypeenum<string>

Available options: PANIC_BUTTON, ALARM_INTEGRATION

customActionsobject[] | null

Show child attributes

headersobject | null

pathstring | null

customLLMActionsobject[] | null

Show child attributes

deviceActivityEventsobject | null

Show child attributes

activitiesenum<string>[] | null

boundingBoxesobject[] | null

Show child attributes

activityenum<string>

Available options: SOUND_LOUD, SOUND_GUN_SHOT, TAMPER, VISUAL_TAMPER, MOTION_TAMPER, MOTION, MOTION_HUMAN, MOTION_CAR, MOTION_ANIMAL, MOTION_PACKAGE, PACKAGE_ARRIVED, PACKAGE_DEPARTED, FACE, FACE_IDENTIFIED, FACE_UNIDENTIFIED, FACE_BLACKLISTED, FACE_ALERT, POSE_ANOMALOUS, POSE_FALL, LICENSEPLATE, LICENSEPLATE_IDENTIFIED, LICENSEPLATE_UNIDENTIFIED, LICENSEPLATE_ALERT, LICENSEPLATE_BLACKLISTED, LICENSEPLATE_TRUSTED, PEOPLECOUNT_HIGH, PEOPLECOUNT_HIGH_RESET, PEOPLECOUNT_LOW, PEOPLECOUNT_LOW_RESET, HUMAN_ENTER, HUMAN_EXIT, CAR_ENTER, CAR_EXIT, TEMPERATURE_EXCEEDED_HIGH, TEMPERATURE_EXCEEDED_LOW, HUMIDITY_EXCEEDED_HIGH, HUMIDITY_EXCEEDED_LOW, PM25_EXCEEDED_HIGH, TVOC_EXCEEDED_HIGH, ETOH_EXCEEDED_HIGH, IAQ_EXCEEDED_HIGH, CO2_EXCEEDED_HIGH, CO2_EXCEEDED_LOW, PROBE_TEMPERATURE_EXCEEDED_HIGH, PROBE_TEMPERATURE_EXCEEDED_LOW, PROBE_DISCONNECTED, PROBE_CONNECTED, HEAT_INDEX_EXCEEDED_HIGH, PRESSURE_EXCEEDED_HIGH, PRESSURE_EXCEEDED_LOW, PM10_EXCEEDED_HIGH, PM40_EXCEEDED_HIGH, PM100_EXCEEDED_HIGH, VOC_IDX_EXCEEDED_HIGH, NOX_IDX_EXCEEDED_HIGH, FORMALDEHYDE_EXCEEDED_HIGH, CARBON_MONOXIDE_EXCEEDED_HIGH, AQI_EXCEEDED_HIGH, DOOR_AJAR, DOOR_OPENED, DOOR_CLOSED, BUTTON_SINGLE_PRESSED, BUTTON_DOUBLE_PRESSED, BUTTON_LONG_PRESSED, TAG_ARRIVED, TAG_DEPARTED, TAG_MOVED, TAG_POSITIONING_CHANGED, TAG_BOUNDARY_INGRESS, TAG_BOUNDARY_EGRESS, TAG_PANIC, BADGE_AUTHORIZED, BADGE_UNAUTHORIZED, BADGE_UNAUTHORIZED_V2, BADGE_AJAR, BADGE_MANUAL, BADGE_FORCED_OPEN, BADGE_LOCKDOWN, BADGE_REQUEST_TO_EXIT, BADGE_DURESS, BADGE_SECURITY_BREACH, BADGE_TAMPER, BADGE_FACE_MISMATCH, POS_ORDER, GUN_DETECT_EVENT, IOT_SOUND_AGGRESSION, IOT_SOUND_HELP, IOT_AIR_CO, IOT_AIR_CO2, IOT_AIR_MASKING, IOT_AIR_THC, IOT_AIR_VAPE, IOT_AIR_VOC, IOT_AIR_TEMP, IOT_TAMPER, IOT_GUNSHOT, IOT_BUTTON_SINGLE_CLICK, IOT_BUTTON_DOUBLE_CLICK, IOT_BUTTON_HOLD, IOT_PANIC_BUTTON_TRIGGERED, AUDIO_SOUND_SIGNIFICANT, AUDIO_SOUND_LOUD, AUDIO_SOUND_ABUSIVE, AUDIO_SOUND_GREETING, AUDIO_SOUND_HELP, AUDIO_SOUND_GUN, AUDIO_SOUND_GLASS_BREAK, AUDIO_SOUND_ALARM_SMOKE_FIRE, AUDIO_SOUND_ALARM_CARBON_MONOXIDE, AUDIO_SOUND_SIREN, CLIMATE_VOC, CLIMATE_VAPE, CLIMATE_SMOKE, CLIMATE_THC, CLIMATE_CO2, CLIMATE_ETOH, CLIMATE_PM25, CLIMATE_IAQ, CLIMATE_LEAK, SOUND_AGGRESSION, SOUND_HELP, AIR_CO, AIR_CO2, AIR_MASKING, AIR_THC, AIR_VAPE, AIR_VOC, MASK_MISSING, HELMET_MISSING, GLOVES_MISSING, PIR_OCCUPIED, PIR_MOVEMENT, PIR_VACANT, CUSTOM, VISITOR_ARRIVED, VISITOR_DEPARTED, AC_DR_CONNECTED, AC_DR_DISCONNECTED, AC_DPI_DOOR_OPEN, AC_DPI_DOOR_CLOSED, AC_DPI_DOOR_AJAR, AC_DPI_DOOR_FORCED_OPEN, AC_DSR_UNLOCKED, AC_DSR_LOCKED, AC_DB_TRIGGERED, AC_PANIC_BUTTON_TRIGGERED, AC_REMOTE_UNLOCK, AC_BADGE_AUTHORIZED, AC_BADGE_UNAUTHORIZED, AC_BADGE_FACE_MISMATCH, AC_LOCKDOWN_ACTIVATED, AC_LOCKDOWN_DEACTIVATED, AC_LOCKDOWN_PLAN_SWITCHED, AC_TAMPER_PROX, AC_TAMPER_ACCEL, AC_TAMPER_SWITCH, AC_GR_ACTIVE, AC_GR_INACTIVE, AC_GI_ACTIVE, AC_GI_INACTIVE, AC_REX_ACTIVE, AC_REX_INACTIVE, AC_APERIO_DEVICE_DISCONNECTED, AC_APERIO_DEVICE_CONNECTED, AC_APERIO_DEVICE_REBOOT, AC_APERIO_DEVICE_TAMPER, AC_APERIO_LOW_BATTERY, AC_APERIO_FLAT_BATTERY, AC_APERIO_OK_BATTERY, AC_SCHLAGE_GW_DISCONNECTED, AC_SCHLAGE_GW_CONNECTED, AC_SCHLAGE_APM_DISCONNECTED, AC_SCHLAGE_APM_CONNECTED, AC_SCHLAGE_LOW_BATTERY, AC_SCHLAGE_CRITICAL_BATTERY, AC_SCHLAGE_OK_BATTERY, POWER_SWITCH_BATTERY, POWER_SWITCH_PRIMARY, AI_SEARCH_MATCH, AI_SEARCH_MATCH_PERSON_SMOKING, AI_SEARCH_MATCH_PERSON_ON_PHONE, AI_SEARCH_MATCH_PERSON_FALLING, CUSTOM_LLM_BOOLEAN_TRUE, CUSTOM_LLM_BOOLEAN_FALSE, CUSTOM_LLM_THRESHOLD_EXCEEDED_LOW, CUSTOM_LLM_THRESHOLD_EXCEEDED_HIGH, ALM_AUTHORITIES_CONTACTED, ALM_MONITORING_ENABLED, ALM_MONITORING_DISABLED, ALM_MONITORING_SETTINGS_CHANGE, ALM_THREAT_CASE_CLOSED, ALM_THREAT_DETECTED, ALM_MONITORING_EVENT_DETECTED, ROBOT_DOG_DETECTED, ROBOT_ARRIVED_AT_WAYPOINT, ROBOT_ARRIVED_AT_POSE, ROBOT_WAITING_AT_POSE, ROBOT_MANUAL_CMD_VEL, ROBOT_MANUAL_ACTION, ROBOT_MANUAL_POSTURE, ROBOT_NAVIGATE_TO_POSE_START, ROBOT_NAVIGATE_TO_POSE_END, ROBOT_NAVIGATE_TO_HOME_START, ROBOT_NAVIGATE_TO_HOME_END, ROBOT_NAVIGATE_TO_WAYPOINT_START, ROBOT_NAVIGATE_TO_WAYPOINT_END, ROBOT_ROUTE_RUN_START, ROBOT_ROUTE_RUN_END, ROBOT_LOW_BATTERY_DOCKING, ROBOT_IDLE_DOCKING, ROBOT_EMERGENCY, LOITER_HUMAN, INACTIVITY_HUMAN, INACTIVITY_CAR, GROUP_ENTRY, ONGUARD_BADGE_AUTHORIZED, ONGUARD_BADGE_ANOMALY, ONGUARD_NO_ENTRY_MADE, ELEMENTS_BADGE_AUTHORIZED, ELEMENTS_BADGE_ANOMALY, ELEMENTS_NO_ENTRY_MADE, NETBOX_BADGE_AUTHORIZED, NETBOX_BADGE_ANOMALY, NETBOX_NO_ENTRY_MADE, THERMAL_TEMPERATURE_ALARM, THERMAL_TEMPERATURE_WARNING, THERMAL_FIRE_DETECTED, THERMAL_SMOKING_DETECTED, THERMAL_FIRE_VERIFIED, THERMAL_HEAT_NO_THREAT, THERMAL_VISUAL_HOTSPOT, THERMAL_VISUAL_HEAT_RISE, THERMAL_VISUAL_WARM_BODY, UNKNOWN

alertboolean | null

bottominteger<int32> | null

confidencenumber<float> | null

croppedImageLocatorstring | null

customActivityColorenum<string>

Available options: BLUE, RED, PURPLE, TAN, ORANGE, TEAL, GRAY, BLACK

customActivityDescriptionstring | null

customActivityDisplayNamestring | null

dwellingboolean | null

faceNamestring | null

inMotionboolean | null

keypointsV2object | null

Show child attributes

xinteger<int32> | null

yinteger<int32> | null

leftinteger<int32> | null

licensePlatestring | null

loudnessinteger<int32> | null

objectIdinteger<int32> | null

posestring | null

relativeSecondnumber<float> | null

rightinteger<int32> | null

sensorValTypeobject

Show child attributes

sensorBooleanboolean | null

sensorDoublenumber<double> | null

sensorLonginteger<int64> | null

stableTrackIdinteger<int32> | null

toastOrderIdInfoobject

Show child attributes

employeeNamestring | null

guidstring | null

locationNamestring | null

restaurantNamestring | null

toastCheckInfoobject

Show child attributes

totalAmountnumber<double> | null

topinteger<int32> | null

unidentifiedFaceIdstring | null

vehicleNamestring | null

durationSecinteger<int32> | null

timestampMsinteger<int64> | null

deviceFacetUuidsstring<DeviceFacetUuid>[] | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

promptUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

timestampMsinteger<int64> | null

emailAuditLogExportActionsobject[] | null

Show child attributes

includeActionsstring[] | null

includeApiInvocationboolean | null

lookbackCountinteger<int32> | null

lookbackTypeenum<string>

Available options: ROLLING, PREVIOUS_DAY, PREVIOUS_WEEK, PREVIOUS_MONTH

lookbackUnitenum<string>

Available options: HOURS, DAYS, WEEKS

recipientEmailsstring[] | null

timezoneIdstring | null

enableDisableAudioRecordActionsobject[] | null

Show child attributes

audioDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

enableboolean | null

integrationCommandActionsobject[] | null

Show child attributes

commandPayloadstring | null

delaySecsinteger<int32> | null

integrationenum<string>

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationNotificationActionsobject[] | null

Show child attributes

integrationenum<string>

notificationEntitystring | null

notificationTargetstring | null

liveNotificationActionboolean | null

remoteDoorUnlockActionsobject[] | null

Show child attributes

doorIdstring | null

placeIdstring | null

systemenum<string>

Available options: BRIVO, OPENPATH, KISI, PLACEOS, GENEA, PDK, INNER_RANGE, RHOMBUS, HONEYWELL_ELEMENTS, UNKNOWN

robotActionsobject[] | null

Show child attributes

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

Available options: DEPLOY, UNKNOWN

One of:

Show Deploy Robot variant

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

Available options: DEPLOY, UNKNOWN

mapUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

navTypeenum<string>

Available options: ROUTE, PATROL, WAYPOINT, POSE

patrolUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

poseobject

Show child attributes

orientationnumber<double>[] | null

Items: 4 to 4

positionnumber<double>[] | null

Items: 3 to 3

routeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

waypointUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show No Op variant

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

Available options: DEPLOY, UNKNOWN

thirdPartyAudioPlaybackActionobject

Show child attributes

audioFileNamestring | null

ipAddressstring | null

loopDurationSecinteger<int32> | null

passwordstring | null

playCountinteger<int32> | null

proxyDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

usernamestring | null

thirdPartyStrobeSirenActionobject

Show child attributes

durationSecinteger<int32> | null

ipAddressstring | null

lightColorsstring[] | null

lightIntensityinteger<int32> | null

lightPatternstring | null

lightSpeedinteger<int32> | null

passwordstring | null

profileNamestring | null

proxyDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

sirenIntensityinteger<int32> | null

sirenPatternstring | null

usernamestring | null

triggerComponentRelayActionsobject[] | null

Show child attributes

componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

outputTypeenum<string>

Available options: TRANSIENT, STEADY

overrideRelayDurationMsinteger<int32> | null

overrideRelayDurationSecinteger<int32> | null

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

stateenum<string>

Available options: ACTIVE, INACTIVE, UNKNOWN

versioninteger<int32> | null

webhookActionsobject[] | null

Show child attributes

headersobject | null

oauthClientIdstring | null

oauthClientSecretstring | null

oauthGrantTypestring | null

oauthScopestring | null

oauthUrlstring | null

webhookSecretstring | null

webhookUrlstring | null

doorbellCameraComponentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

doorbellCameraUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ruleFiltersobject

Optional filters to apply to this lockdown rule.

Show child attributes

scheduleUuidsstring<RUUID>[] | null

List of schedules that apply to the rule. at least one schedule must be met to trigger this rule. If null, then this rule is enabled all the time.

triggerBackoffSecsinteger<int32> | null

Number of seconds to back off after rule is triggered before triggering again. I.e. this rule will only trigger once every X seconds regardless of how many triggering events occur within that window

ruleNamestring | null

Name of the rule

Example: "Motion Detection Rule"

ruleUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

triggerActivityenum<string>

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.