Skip to content
Control Plane API
Skip navigation

Read Your Fleet

The roster of everything the account holds, and the full record behind any single address.

Published

On this page (9)

Read Your Fleet Documentation

Two read operations. list returns the roster, agent returns one entry in full. Both need dns:zone:read.

list

Returns what the account holds, one row per item.

whisper-call
CALL whisper.agents({op: 'list', args: {kind: 'agents'}})

Arguments

ArgumentContract
kindagents for principals, identities for addresses on your own key, records for the DNS entries behind them.

Returns

Columns kind and item. Each item carries label, fqdn, address, agent, created and state.

agent

Returns the full record for one address.

whisper-call
CALL whisper.agents({op: 'agent', args: {address: '2a04:2a01:b69a:6717:e3b0:51ff:3bf7:f478'}})

agent and address are interchangeable. A value containing a : is read as an address, anything else as an identifier, so either argument name accepts either form.

Identity

ColumnHolds
agentThe agent identifier.
addressIts routable /128.
fqdnIts canonical name.
ptrIts reverse name.
labelThe short name you gave it.
stateWhether the allocation stands. This is registry state, not liveness.
allocated_atWhen the address was allocated.
contactThe contact published on its registry record.
last_seenWhen the plane last recorded activity for it.

Counters

ColumnHolds
dns_queriesLookups made through the resolver.
dns_blockedLookups policy refused.
dns_nxdomainLookups that resolved to nothing.
packetsPackets carried.
bytes_up, bytes_downBytes out and in.
connections_activeConnections open now.
connections_totalConnections opened so far.

Keys and publication

ColumnHolds
identity_spkiThe public key the identity is pinned to.
tlsa_digestThe digest published in the DANE pin.
sshfp_digestThe digest published for SSH.
key_sourceWhere the key came from.
key_bindingHow the key is bound to the address.
publicationWhat has been published in DNS for it.

Keys, signing and encryption covers what each of those records is for.

Nesting

ColumnHolds
parentThe identity this one egresses behind, when there is one.
childrenThe identities egressing behind this one.
depthHow far down the chain it sits.
roamWhether it may move between parents.

Nested identities explains what a chain means for policy.

Errors

CodeStatusMeaning
BAD_ARGS400kind is not one of the three values, or neither agent nor address was given.
NOT_FOUND404No such address or identifier under this account.
RESULT_TOO_LARGE413The roster does not fit in one answer. Read it by kind.