Skip to content

List a Realm's declared watches

GET
/api/v1/realms/{realmName}/watch-approvals
curl --request GET \
--url http://localhost:11044/api/v1/realms/example/watch-approvals \
--header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Each watch the admitted capture declares and whether it is approved.

realmName
required
string

Name of a realm with a live admitted installation in the signed-in owner’s world: non-blank, at most 256 UTF-8 bytes, no control characters and not all asterisks, or 400

OK

Media type*/*

A captured realm’s declared watches and their approvals, as GET /realms/{realmName}/watch-approvals and the grant and revoke routes answer, with the installation and revision the next change must name back

object
digest
required

Digest of the realm content this installation admitted

string
installationId
required

The realm installation the watches belong to; a grant or revoke must send it back

string
revision
required

The installation’s revision, after the change on a grant or revoke; the next grant or revoke must send it back as expectedRevision

integer format: int64
watches
required

Every watch the admitted realm declares, each with whether it is approved

Array<object>

One watch a captured realm declares: the lens it re-reads, its cron schedule, and whether the owner has approved it

object
approved
required

True when the owner has approved this watch, so its schedule runs; approving it grants nothing on the lens or its handler

boolean
lens
required

Id of the realm’s own lens the watch re-reads

string
schedule
required

Cron expression it re-reads the lens on, already checked against the host’s minimum interval

string
watch
required

The watch’s name, as the grant and revoke routes take it

string