list_netbox_servers

GET

/api/v1/netbox/servers

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

Authorizations

• bearer

Responses

200

Every configured NetBox server. The API token is never included; the CA certificate is, because it is not a secret

Media typeapplication/json

Array<object>

A configured server as the API exposes it.

🚨 credential_id is here but the token is not, and cannot be — the token lives sealed in credentials and this type has no field that could carry it. ca_cert_pem is returned, on purpose: a CA certificate is public-key material, and an operator who cannot read back what they pasted cannot tell a stored certificate from a lost one.

object

api_version

netbox-version learned from the last successful connection, so the screen can state the supported range rather than guessing at it.

string | null

base_url

required

string

ca_cert_pem

string | null

credential_id

required

string format: uuid

enabled

required

boolean

id

required

string format: uuid

last_sync_at

string | null

last_sync_error

string | null

last_sync_ok

boolean | null

last_sync_sites

Active sites the last successful run wrote as folders, or null before one has run. A site in any other status is not counted (ADR-100 decision 11).

integer | null format: int32

last_sync_sites_without_site_id

Of those, how many had no usable Site ID. 0 when no Site ID field is configured — nothing was asked for, so nothing is missing.

integer | null format: int32

missing_folders

required

Folders this server owns that the last successful run no longer synced: NetBox no longer lists the object, or lists the site as anything but Active (ADR-100 decision 11). Never auto-deleted (decision 5) — surfaced so the operator can decide.

integer

name

required

string

site_id_field

Which NetBox field prefixes a Site’s folder name, or null for none. Encoded as stored: a built-in name, or cf: and a custom field’s key.

string | null

sync

One of:

null

null

object

A “Sync now” not finished yet, or a run in flight; null when neither (ADR-172 decision 1).

object

requested_at

When “Sync now” asked; null when nothing is asked for. A second press keeps the first time.

string | null

started_at

When the run in flight began; null while the request waits for the leader’s loop.

string | null

sync_interval_secs

required

integer format: int32

Example^generated

[
  {
    "api_version": "example",
    "base_url": "example",
    "ca_cert_pem": "example",
    "credential_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "enabled": true,
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "last_sync_at": "example",
    "last_sync_error": "example",
    "last_sync_ok": true,
    "last_sync_sites": 1,
    "last_sync_sites_without_site_id": 1,
    "missing_folders": 1,
    "name": "example",
    "site_id_field": "example",
    "sync": {
      "requested_at": "example",
      "started_at": "example"
    },
    "sync_interval_secs": 1
  }
]

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 View

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

Inventory storage is unavailable (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"
  }
}