The deployment's adjacency-collection settings, with the accepted cadence range.
const url = 'https://example.com/api/v1/settings/neighbors';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/v1/settings/neighbors \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Whether adjacency is collected, how often, and the accepted range
How this deployment discovers connectivity: CDP/LLDP neighbours and interface addresses.
object
Whether ARP / IPv6-neighbour walks are issued at all. Omitted on update leaves it unchanged.
Off unless an operator turns it on: this walk reads a table sized by the network rather than by the device, and it is the only discovery walk here that costs a busy switch measurable work. What it buys is the only answer nothing else can give — which hosts are on your segments that Yagra is not monitoring.
How often each SNMP node’s ARP / IPv6-neighbour tables are walked, in seconds. Omitted on update leaves it unchanged.
Whether CDP/LLDP neighbour walks are issued at all.
How often each SNMP node’s neighbour tables are walked, in seconds.
Whether interface-address walks are issued at all. Omitted on update leaves it unchanged.
How often each SNMP node’s interface-address tables are walked, in seconds. Omitted on update leaves it unchanged.
Largest cadence this deployment accepts, in seconds.
Smallest cadence this deployment accepts, in seconds.
Whether routing-adjacency collection is issued at all. Omitted on update leaves it unchanged.
On unless an operator turns it off. This is what finds the links that share no subnet — a
point-to-point /32, an unnumbered OSPF link, an eBGP session across a segment — which the
shared-subnet rule structurally cannot see. The tables it reads are sized by the device’s own
peering mesh, and the routing table itself is never walked: it is probed one destination at a
time.
How often each SNMP node’s routing adjacency is collected, in seconds. Omitted on update leaves it unchanged.
Examplegenerated
{ "arp_enabled": true, "arp_interval_secs": 1, "enabled": true, "interval_secs": 1, "l3_enabled": true, "l3_interval_secs": 1, "max_interval_secs": 1, "min_interval_secs": 1, "routing_enabled": true, "routing_interval_secs": 1}No valid bearer token
The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI
document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies
undescribed — a client that has to guess the failure shape ends up parsing the success shape and
reading undefined.
object
object
Stable machine-readable code. Clients branch on this, never on the message.
Operator-facing sentence. Safe to display; never carries an internal error’s own text.
Examplegenerated
{ "error": { "code": "example", "message": "example" }}Role lacks View
The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI
document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies
undescribed — a client that has to guess the failure shape ends up parsing the success shape and
reading undefined.
object
object
Stable machine-readable code. Clients branch on this, never on the message.
Operator-facing sentence. Safe to display; never carries an internal error’s own text.
Examplegenerated
{ "error": { "code": "example", "message": "example" }}Inventory storage is unavailable (skeleton mode)
The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI
document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies
undescribed — a client that has to guess the failure shape ends up parsing the success shape and
reading undefined.
object
object
Stable machine-readable code. Clients branch on this, never on the message.
Operator-facing sentence. Safe to display; never carries an internal error’s own text.
Examplegenerated
{ "error": { "code": "example", "message": "example" }}