> For the complete documentation index, see [llms.txt](https://docs.fylr.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fylr.io/for-developers/api/endpoints/api-inspect.md).

# /inspect

`/inspect` is fylr's backend introspection and maintenance console. Every page renders an HTML dashboard by default and returns **JSON** when the request sends `Accept: application/json` (or `?accept=application/json`). The JSON projection is **whitelisted per page** — the operations below expose exactly the whitelisted fields, never more.

These endpoints are **not** under `/api/v1` and are **not** token-authenticated. On the public **webapp port** /inspect is reverse-proxied behind a session check and requires the **`system.root`** right; on the **backend port** it is mounted with no authentication and must stay on a private network. For the console itself — the dashboards, filters and actions — see [The /inspect Backend](/for-system-administrators/inspect.md).

## Instance

### `GET /inspect/` — Instance overview (home dashboard).

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

## Data & model

### `GET /inspect/config/` — Compiled base configuration.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/config/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `GET /inspect/plugins/` — Installed plugins.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/plugins/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `GET /inspect/tags/` — Tags and tag groups.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/tags/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `GET /inspect/objecttypes/{objecttype}/` — Statistics for one objecttype.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/objecttypes/{objecttype}/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `GET /inspect/pools/{pool}/` — Statistics for one pool.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/pools/{pool}/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `GET /inspect/objects/` — Paged object id list for an objecttype.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/objects/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `GET /inspect/objects/list/` — Objects indexed by read table.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/objects/list/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `GET /inspect/objects/{systemObjectId}/` — Render one object against a datamodel version.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/objects/{systemObjectId}/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `GET /inspect/collections/` — Paged, searchable collection tree.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/collections/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `GET /inspect/customdata/{id}/` — Custom-data-type event.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/customdata/{id}/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

## System & maintenance

### `GET /inspect/system/status/` — Server statistics.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/system/status/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `GET /inspect/system/janitor/` — Janitor events.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/system/janitor/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `GET /inspect/sqlquery/` — Run an SQL query (debug builds only).

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/sqlquery/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `GET /inspect/recalcterms/` — Term-recalculation status.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/recalcterms/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `GET /inspect/migration/` — List backups.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/migration/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `GET /inspect/migration/{backup}/` — One backup and its file listing.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/inspect/migration/{backup}/" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-27a76749464f8079ac8ce2ee65518544084ed6fa%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}