Skip to content
Yagra

Server-side node search for the node-picker typeahead: case-insensitive substring over name or address, capped, so a picker never loads the whole inventory into the browser (ui-conventions: search is server-side at fleet scale). Also backs the Nodes tree name filter and the Troubleshoot scope picker. Routes through the shared `NodeListing`, so it works in skeleton mode.

GET
/api/v1/nodes/search
curl --request GET \
  --url https://example.com/api/v1/nodes/search \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
string
limit
integer format: int64

Responses

Section titled “Responses”

200

Section titled “200”

Matching nodes, capped

Media typeapplication/json
Array<object>

One node-picker result: id + display name + address. Deliberately excludes credentials and bindings (security.md — the picker only needs to show and select a node).

object
address
required
string
id
required
string format: uuid
name
required
string
Examplegenerated
[
  {
    "address": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example"
  }
]

401

Section titled “401”

No valid bearer token

Media typeapplication/json

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
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Section titled “403”

Role lacks the View permission

Media typeapplication/json

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
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}