ring.connection.delete
Delete a Ring connection by id. Tenant-scoped. Cascade-deletes its doorbells.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
ring.connection.upsert
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
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | no | |
label | string | yes | |
ringType | enum | no | One of: ring, mock — Default: "mock" |
credentials | object | no | Default: {} |
credentials.refreshToken | string | no | |
active | boolean | no | Default: true |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
ring.doorbell.delete
Delete a Ring doorbell by id. Tenant-scoped.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
ring.doorbell.upsert
Create or update a Ring doorbell behind a connection. `deviceId` is the Ring camera id. Pass `id` to update, omit to insert.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | no | |
connectionId | string | yes | |
deviceId | string | yes | |
name | string | yes | |
location | string | no | |
sortOrder | integer | no | Default: 0 |
active | boolean | no | Default: true |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
ring.health
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.
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | no | |
battery | string | number · nullable | no | |
wifi | string · nullable | no | |
firmware | string · nullable | no | |
online | boolean | no |
ring.list
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
| Field | Type | Required | Notes |
|---|---|---|---|
doorbells | array of object | yes | |
doorbells.id | string | yes | |
doorbells.name | string | yes | |
doorbells.location | string · nullable | yes | |
doorbells.active | boolean | yes | |
doorbells.connectionId | string | yes |
ring.snapshot
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
| Field | Type | Required | Notes |
|---|---|---|---|
doorbellId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
aufgenommenUm | string | yes | |
breite | integer | yes | |
hoehe | integer | yes | |
bild | object | yes | |
bild.data | string | yes | |
bild.mimeType | literal | yes | One of: image/jpeg |
ring.test_connection
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
| Field | Type | Required | Notes |
|---|---|---|---|
connectionId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | boolean | yes | |
doorbells | array of object | yes | |
doorbells.id | string | yes | |
doorbells.name | string | yes | |
doorbells.kind | string | no | |
error | string | no |