ServicesConfig Store ServiceConfig Store APIadmin

Search devices by name with latest config info

View as Markdown
Search devices by name with their latest configuration metadata. If q is not provided, returns the 100 most recently updated devices from DB. If q is provided, uses Redis cache to find matching device names and their UUIDs, then fetches their latest config info from DB. Results are sorted by most recent update first. Results are filtered by file_type (intended or backup). Inactive devices (removed from nv_config_manager/Nautobot) are hidden unless include_inactive is True.

Authentication

AuthorizationBearer

Bearer JWT used by CLI and machine clients on svc-* endpoints. Authentication is required by default, but deployments may disable it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE identities, and trusted gateway identity headers may also satisfy authentication outside this generated client flow.

Query parameters

qstring or nullOptional
limitintegerOptionalDefaults to 100
file_typeenumOptional
Enum for config file types.
Allowed values:
include_inactivebooleanOptionalDefaults to false

Response

Successful Response
latest_authorstring
Author of latest change
latest_messagestring
Commit message of latest change
latest_updatestring
Latest config update timestamp
namestring
Device name
sitestring
Site name
uuidstring
Device UUID
activebooleanDefaults to true

Whether the device is currently active in nv-config-manager

Errors

422
Unprocessable Entity Error