list_node_groups

GET

/api/v1/node-groups

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

Authorizations

• bearer

Responses

200

Every folder group in the inventory tree

Media typeapplication/json

Array<object>

One group row returned by the API. group_type is the snake_case key.

object

effective_latitude

Where this group sits on the map after inheritance: its own coordinates, else the nearest ancestor’s, else null. Computed on every read; never stored.

These do not add a pin. A group is drawn on the map only when geo_source is own; for every other group this says which pin its nodes are counted at (geo_group).

number | null format: double

effective_longitude

number | null format: double

geo_group

The group that supplied the effective position: this group when geo_source is own, the ancestor it inherited from when inherited, null when unset. This is the pin the group’s nodes belong to, so a client never has to walk the folder tree itself.

string | null format: uuid

geo_source

required

Whether the effective position is the group’s own, inherited from an ancestor, or absent.

string

Allowed values: own inherited unset

group_type

required

string

id

required

string format: uuid

latitude

The group’s own geo coordinates, as stored (both set ⇒ drawn as a pin). A descendant folder normally leaves these null and inherits — see the effective_* pair below.

number | null format: double

longitude

number | null format: double

name

required

string

parent_id

string | null format: uuid

pool

Poll-pool this folder assigns to its nodes (ADR-009/020, migration 0054). null ⇒ inherit from the nearest ancestor that sets one, else the default pool. A node’s own pool still wins — see [crate::poolres].

string | null

sort_order

required

Manual order within the parent scope (the UI sorts siblings by this, then by name).

number format: double

Example

[
  {
    "geo_source": "own"
  }
]

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

Example^generated

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

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

Example^generated

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

503

This core has no write side (skeleton mode)

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

Example^generated

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