FoyerDevelopers

Generated · Live registry

ring tools

8 tools in this domain, generated from the running registry.

All tool domains

ring.connection.delete

writesconfirm

Delete a Ring connection by id. Tenant-scoped. Cascade-deletes its doorbells.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

ring.connection.upsert

writesconfirm

Create or update a Ring account connection. `ringType` is 'mock' (placeholder) or 'ring' (real cloud). `credentials.refreshToken` is stored encrypted. Pass `id` to update, omit to insert.

Input parameters

FieldTypeRequiredNotes
idstringno
labelstringyes
ringTypeenumnoOne of: ring, mock — Default: "mock"
credentialsobjectnoDefault: {}
credentials.refreshTokenstringno
activebooleannoDefault: true

Output fields

FieldTypeRequiredNotes
idstringyes

ring.doorbell.delete

writesconfirm

Delete a Ring doorbell by id. Tenant-scoped.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

ring.doorbell.upsert

writesconfirm

Create or update a Ring doorbell behind a connection. `deviceId` is the Ring camera id. Pass `id` to update, omit to insert.

Input parameters

FieldTypeRequiredNotes
idstringno
connectionIdstringyes
deviceIdstringyes
namestringyes
locationstringno
sortOrderintegernoDefault: 0
activebooleannoDefault: true

Output fields

FieldTypeRequiredNotes
idstringyes

ring.health

read-only

Health of the front-door Ring doorbell: online, battery, Wi-Fi signal, firmware. `null` if no doorbell camera is set up or the snap service does not answer. Owner only. Read-only.

Input parameters

Returns object.

Output fields

The whole object may be null.

FieldTypeRequiredNotes
namestringno
batterystring | number · nullableno
wifistring · nullableno
firmwarestring · nullableno
onlinebooleanno

ring.list

read-only

List Ring doorbells for this tenant (id, name, location, active). Credentials and device ids are NOT returned — view/edit via the operator settings UI.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
doorbellsarray of objectyes
doorbells.idstringyes
doorbells.namestringyes
doorbells.locationstring · nullableyes
doorbells.activebooleanyes
doorbells.connectionIdstringyes

ring.snapshot

writesconfirm

Current still image of one Ring doorbell (long side 1568 px). Doorbell ids from `ring.list`. Owner only, logged. Surveillance image: fetch only for a concrete operational reason. Requires confirmation.

Input parameters

FieldTypeRequiredNotes
doorbellIdstringyes

Output fields

FieldTypeRequiredNotes
aufgenommenUmstringyes
breiteintegeryes
hoeheintegeryes
bildobjectyes
bild.datastringyes
bild.mimeTypeliteralyesOne of: image/jpeg

ring.test_connection

read-only

Test a stored Ring connection: reachable or not, and which doorbells it sees. Connection ids from `ring.list`. Returns no credentials. Owner only. Read-only.

Input parameters

FieldTypeRequiredNotes
connectionIdstringyes

Output fields

FieldTypeRequiredNotes
okbooleanyes
doorbellsarray of objectyes
doorbells.idstringyes
doorbells.namestringyes
doorbells.kindstringno
errorstringno