/inspect

The whitelisted /inspect JSON endpoints — the backend console's machine-readable projection, used by the test suite and by monitoring.

/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.

Instance

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

Instance overview (home dashboard).

get

Returns the instance overview. The whitelisted JSON exposes the compiled base configuration and the list of connected storage backends.

Header parameters

Acceptstring · enumRequired

Send application/json to receive the whitelisted JSON projection instead of the HTML dashboard. Equivalent to the ?accept=application/json query parameter.

Possible values:

Responses

200

The whitelisted instance overview.

application/json

BaseConfigobjectOptional

The compiled base configuration of the instance (sensitive values removed).

Backendsobject[]Optional

The connected storage backends (file / S3 / Azure).

200

The whitelisted instance overview.

{
  "BaseConfig": {},
  "Backends": [
    {}
  ]
}

Data & model

GET /inspect/config/ — Compiled base configuration.

Compiled base configuration.

get

Header parameters

Acceptstring · enumRequired

Send application/json to receive the whitelisted JSON projection instead of the HTML dashboard. Equivalent to the ?accept=application/json query parameter.

Possible values:

Responses

200

The whitelisted config dump.

application/json

ConfigobjectOptional

The effective, merged base configuration.

BaseConfigListobject[]Optional

The individual config layers that were merged.

200

The whitelisted config dump.

{
  "Config": {},
  "BaseConfigList": [
    {}
  ]
}

GET /inspect/plugins/ — Installed plugins.

Installed plugins.

get

Header parameters

Acceptstring · enumRequired

Send application/json to receive the whitelisted JSON projection instead of the HTML dashboard. Equivalent to the ?accept=application/json query parameter.

Possible values:

Responses

200

The whitelisted plugin dump.

application/json

Pluginsobject[]Optional

The installed plugins and their manifest metadata.

200

The whitelisted plugin dump.

{
  "Plugins": [
    {}
  ]
}

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

Tags and tag groups.

get

Header parameters

Acceptstring · enumRequired

Send application/json to receive the whitelisted JSON projection instead of the HTML dashboard. Equivalent to the ?accept=application/json query parameter.

Possible values:

Responses

200

The whitelisted tag dump.

application/json

Tagsobject[]Optional

The configured tags and tag groups.

200

The whitelisted tag dump.

{
  "Tags": [
    {}
  ]
}

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

Statistics for one objecttype.

get

Path parameters

objecttypestringRequired

Objecttype name or id.

Header parameters

Acceptstring · enumRequired

Send application/json for the whitelisted JSON projection.

Possible values:

Responses

200

The whitelisted objecttype stats.

application/json

OtStatsobjectOptional

Per-objecttype statistics (object counts, index state and related figures).

200

The whitelisted objecttype stats.

{
  "OtStats": {}
}

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

Statistics for one pool.

get

Path parameters

poolstringRequired

Pool id.

Header parameters

Acceptstring · enumRequiredPossible values:

Responses

200

The whitelisted pool stats.

application/json

PoolStatsobjectOptional

Statistics for the pool.

PoolStatsSubpoolsobject[]Optional

Statistics for each sub-pool.

200

The whitelisted pool stats.

{
  "PoolStats": {},
  "PoolStatsSubpools": [
    {}
  ]
}

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

Paged object id list for an objecttype.

get

Query parameters

objecttypestringOptional

Objecttype to list.

offsetintegerOptional

limitintegerOptional

Header parameters

Acceptstring · enumRequiredPossible values:

Responses

200

The whitelisted object-list dump.

application/json

SystemObjectIdsinteger[]Optional

The system object ids on this page.

ObjecttypestringOptional

FilterobjectOptional

VersionsobjectOptional

IndexstringOptional

OrderstringOptional

OffsetintegerOptional

LimitintegerOptional

PrevintegerOptional

Offset of the previous page, if any.

NextintegerOptional

Offset of the next page, if any.

ParseErrstringOptional

Set when the request parameters could not be parsed.

200

The whitelisted object-list dump.

{
  "SystemObjectIds": [
    1
  ],
  "Objecttype": "text",
  "Filter": {},
  "Versions": {},
  "Index": "text",
  "Order": "text",
  "Offset": 1,
  "Limit": 1,
  "Prev": 1,
  "Next": 1,
  "ParseErr": "text"
}

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

Objects indexed by read table.

get

Header parameters

Acceptstring · enumRequired

Send application/json to receive the whitelisted JSON projection instead of the HTML dashboard. Equivalent to the ?accept=application/json query parameter.

Possible values:

Responses

200

The whitelisted index read map.

application/json

IndexedByTableNameReadobjectOptional

Map of read table name to the objects indexed under it.

200

The whitelisted index read map.

{
  "IndexedByTableNameRead": {}
}

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

Render one object against a datamodel version.

get

Path parameters

systemObjectIdintegerRequired

System object id.

Header parameters

Acceptstring · enumRequiredPossible values:

Responses

200

The whitelisted single-object dump.

application/json

ReindexSystemObjectIdsinteger[]Optional

System object ids scheduled for re-index by this render.

DatamodelSelectobject[]Optional

The datamodel versions selectable for rendering.

CurrentDatamodelIdintegerOptional

The current (live) datamodel id.

RenderingDatamodelIdintegerOptional

The datamodel id used to render this response.

ObjectDatamodelIdintegerOptional

The datamodel id the object was last written with.

LatestLinkedobjectOptional

The latest linked-object state.

WarningstringOptional

A rendering warning, if any.

200

The whitelisted single-object dump.

{
  "ReindexSystemObjectIds": [
    1
  ],
  "DatamodelSelect": [
    {}
  ],
  "CurrentDatamodelId": 1,
  "RenderingDatamodelId": 1,
  "ObjectDatamodelId": 1,
  "LatestLinked": {},
  "Warning": "text"
}

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

Paged, searchable collection tree.

get

Query parameters

searchstringOptional

Filter collections by name or reference.

ownerstringOptional

offsetintegerOptional

limitintegerOptional

Header parameters

Acceptstring · enumRequiredPossible values:

Responses

200

The whitelisted collection-tree dump.

application/json

ColInfosobject[]Optional

The collections on this page, with parent/child links.

FilterobjectOptional

MarkersobjectOptional

UserTypestringOptional

OrderstringOptional

OffsetintegerOptional

LimitintegerOptional

TotalCountintegerOptional

LoadParentsbooleanOptional

LoadChildrenbooleanOptional

PrevintegerOptional

NextintegerOptional

200

The whitelisted collection-tree dump.

{
  "ColInfos": [
    {}
  ],
  "Filter": {},
  "Markers": {},
  "UserType": "text",
  "Order": "text",
  "Offset": 1,
  "Limit": 1,
  "TotalCount": 1,
  "LoadParents": true,
  "LoadChildren": true,
  "Prev": 1,
  "Next": 1
}

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

Custom-data-type event.

get

Path parameters

idstringRequired

Header parameters

Acceptstring · enumRequiredPossible values:

Responses

200

The whitelisted custom-data event.

application/json

EventobjectOptional

The custom-data-type event.

200

The whitelisted custom-data event.

{
  "Event": {}
}

System & maintenance

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

Server statistics.

get

Header parameters

Acceptstring · enumRequired

Send application/json to receive the whitelisted JSON projection instead of the HTML dashboard. Equivalent to the ?accept=application/json query parameter.

Possible values:

Responses

200

The whitelisted server statistics.

application/json

StatsobjectOptional

Object counts per objecttype and basetype, index- and file-queue depth and per-index storage sizes.

200

The whitelisted server statistics.

{
  "Stats": {}
}

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

Janitor events.

get

Header parameters

Acceptstring · enumRequired

Send application/json to receive the whitelisted JSON projection instead of the HTML dashboard. Equivalent to the ?accept=application/json query parameter.

Possible values:

Responses

200

The whitelisted janitor dump.

application/json

EventobjectOptional

The selected janitor event.

QueryobjectOptional

The query behind the current janitor view.

200

The whitelisted janitor dump.

{
  "Event": {},
  "Query": {}
}

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

Run an SQL query (debug builds only).

get

Query parameters

querystringOptional

The SQL statement to run.

Header parameters

Acceptstring · enumRequiredPossible values:

Responses

200

The whitelisted query result.

application/json

SqlQueryobjectOptional

The query, its columns and the result rows.

200

The whitelisted query result.

{
  "SqlQuery": {}
}

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

Term-recalculation status.

get

Header parameters

Acceptstring · enumRequired

Send application/json to receive the whitelisted JSON projection instead of the HTML dashboard. Equivalent to the ?accept=application/json query parameter.

Possible values:

Responses

200

The whitelisted recalculation status.

application/json

RecalcTermsobjectOptional

The current state of the term recalculation (running / idle, progress and per-objecttype detail).

200

The whitelisted recalculation status.

{
  "RecalcTerms": {}
}

GET /inspect/migration/ — List backups.

List backups.

get

Header parameters

Acceptstring · enumRequired

Send application/json to receive the whitelisted JSON projection instead of the HTML dashboard. Equivalent to the ?accept=application/json query parameter.

Possible values:

Responses

200

The whitelisted backup list.

application/json

Backupsobject[]Optional

The available backups.

200

The whitelisted backup list.

{
  "Backups": [
    {}
  ]
}

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

One backup and its file listing.

get

Path parameters

backupstringRequired

Backup name.

Header parameters

Acceptstring · enumRequiredPossible values:

Responses

200

The whitelisted backup detail.

application/json

BackupobjectOptional

The backup's metadata.

Filesobject[]Optional

Directory listing of the backup at SubPath.

SubPathstringOptional

The sub-path within the backup being listed.

200

The whitelisted backup detail.

{
  "Backup": {},
  "Files": [
    {}
  ],
  "SubPath": "text"
}