These docs are for v5.0. Click to read the latest docs for v2024.3.

Server HTTP API

This is the Seq HTTP API reference, generated from Seq version 5.0.2119.

Endpoints

`aad/`

Path	HTTP method	Permission demand	Additional requirements	Notes
`aad/`	`GET`	`Public`

`api/`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/`	`GET`	`Public`

`api/apikeys`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/apikeys/`	`GET`	`Read`	Only `Setup` principals can view all keys; others can only request and view keys that they own.
`api/apikeys/`	`POST`	`Write`	A principal can only set the owner of a key to themselves. Only `Setup` principals can create keys without an owner. Principals can only delegate permissions to a key that they themselves hold.
`api/apikeys/{id}`	`DELETE`	`Write`	Only `Setup` principals can remove any key; others can only remove keys that they own.
`api/apikeys/{id}`	`GET`	`Read`	Only `Setup` principals can view all keys; others can only request and view keys that they own.
`api/apikeys/{id}`	`PUT`	`Write`	A principal can only set the owner of a key to themselves. Only `Setup` principals can create keys without an owner. Principals can only delegate permissions to a key that they themselves hold.
`api/apikeys/resources`	`GET`	`Public`
`api/apikeys/template`	`GET`	`Read`

`api/appinstances`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/appinstances/`	`GET`	`Write`	Principals that can invoke apps can access the basic details of available, invokable apps.
`api/appinstances/`	`POST`	`Setup`
`api/appinstances/{appInstanceId}/invoke`	`POST`	`Write`	The app instance `appInstanceId` must allow manual input.
`api/appinstances/{id}`	`DELETE`	`Setup`
`api/appinstances/{id}`	`GET`	`Write`	Principals that can invoke apps can access the basic details of available, invokable apps.
`api/appinstances/{id}`	`PUT`	`Setup`
`api/appinstances/resources`	`GET`	`Public`
`api/appinstances/template`	`GET`	`Setup`

`api/apps`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/apps/`	`GET`	`Setup`
`api/apps/`	`POST`	`Setup`
`api/apps/{id}`	`DELETE`	`Setup`
`api/apps/{id}`	`GET`	`Setup`
`api/apps/{id}`	`PUT`	`Setup`
`api/apps/{id}/update`	`POST`	`Setup`
`api/apps/install`	`POST`	`Setup`
`api/apps/resources`	`GET`	`Public`
`api/apps/template`	`GET`	`Setup`

`api/backups`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/backups/`	`GET`	`Setup`
`api/backups/{id}`	`GET`	`Setup`
`api/backups/files/{filename}`	`GET`	`Setup`
`api/backups/immediate`	`POST`	`Setup`
`api/backups/resources`	`GET`	`Public`

`api/dashboards`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/dashboards/`	`GET`	`Read`	Users can only read shared dashboards, and those that they own.
`api/dashboards/`	`POST`	`Write`	Users can only create shared dashboards or personally owned ones.
`api/dashboards/{id}`	`DELETE`	`Write`	The additional `Setup` permission can be used to remove any dashboard. Users can only update dashboards that they own.
`api/dashboards/{id}`	`GET`	`Read`	Users can only read shared dashboards, and those that they own.
`api/dashboards/{id}`	`PUT`	`Write`	The additional `Setup` permission is required to update shared dashboards. Users can only update dashboards that they own.
`api/dashboards/query/template`	`GET`	`Write`
`api/dashboards/resources`	`GET`	`Public`
`api/dashboards/template`	`GET`	`Write`

`api/data`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/data/`	`GET`	`Read`
`api/data/`	`POST`	`Read`
`api/data/{signalId}`	`GET`	`Read`		Obsolete
`api/data/resources`	`GET`	`Public`

`api/deferred`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/deferred/{deferredId}`	`GET`	`Read`

`api/diagnostics`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/diagnostics/ingestion`	`GET`	`Setup`
`api/diagnostics/metrics`	`GET`	`Setup`
`api/diagnostics/report`	`GET`	`Setup`
`api/diagnostics/resources`	`GET`	`Public`
`api/diagnostics/status`	`GET`	`Read`

`api/events`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/events/`	`GET`	`Read`
`api/events/{id}`	`GET`	`Read`
`api/events/histogram`	`POST`	`Read`		Obsolete
`api/events/histogram/{signalId}`	`GET`	`Read`		Obsolete
`api/events/raw/`	`OPTIONS`	`Public`	Required to support CORS.
`api/events/raw/`	`POST`	`Public`	If the `RequireApiKeyForWritingEvents` setting is enabled, requests must be authenticated and have the `Ingest` permission.
`api/events/resources`	`GET`	`Public`
`api/events/signal`	`DELETE`	`Setup`
`api/events/signal`	`GET`	`Read`
`api/events/signal`	`POST`	`Read`
`api/events/signal/{signalId}`	`GET`	`Read`		Obsolete
`api/events/tabulate`	`POST`	`Read`
`api/events/tabulate/{signalId}`	`GET`	`Read`

`api/expressions`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/expressions/resources`	`GET`	`Public`
`api/expressions/sql`	`GET`	`Read`
`api/expressions/strict`	`GET`	`Read`

`api/feeds`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/feeds/`	`GET`	`Setup`
`api/feeds/`	`POST`	`Setup`
`api/feeds/{id}`	`DELETE`	`Setup`
`api/feeds/{id}`	`GET`	`Setup`
`api/feeds/{id}`	`PUT`	`Setup`
`api/feeds/resources`	`GET`	`Public`
`api/feeds/template`	`GET`	`Setup`

`api/licenses`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/licenses/`	`GET`	`Setup`
`api/licenses/{id}`	`GET`	`Read`	`Read` principals can see license status but `Setup` is required for certificate details.
`api/licenses/{id}`	`PUT`	`Setup`
`api/licenses/downgrade`	`POST`	`Setup`
`api/licenses/resources`	`GET`	`Public`

`api/permalinks`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/permalinks/`	`GET`	`Read`	Non-`Setup` principals can only view their own permalinks.
`api/permalinks/`	`POST`	`Write`	Non-`Setup` principals can only create permalinks for themselves.
`api/permalinks/{id}`	`DELETE`	`Write`	Non-`Setup` principals can only remove their own permalinks.
`api/permalinks/{id}`	`GET`	`Read`	Non-`Setup` principals can only retrieve their own permalinks.
`api/permalinks/resources`	`GET`	`Public`
`api/permalinks/template`	`GET`	`Write`

`api/retentionpolicies`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/retentionpolicies/`	`GET`	`Setup`
`api/retentionpolicies/`	`POST`	`Setup`
`api/retentionpolicies/{id}`	`DELETE`	`Setup`
`api/retentionpolicies/{id}`	`GET`	`Setup`
`api/retentionpolicies/{id}`	`PUT`	`Setup`
`api/retentionpolicies/resources`	`GET`	`Public`
`api/retentionpolicies/template`	`GET`	`Setup`

`api/roles`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/roles/`	`GET`	`Read`
`api/roles/{id}`	`GET`	`Read`
`api/roles/resources`	`GET`	`Public`

`api/settings`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/settings/{id}`	`GET`	`Setup`
`api/settings/{id}`	`PUT`	`Setup`
`api/settings/internal-error-reporting`	`GET`	`Setup`
`api/settings/internal-error-reporting`	`PUT`	`Setup`
`api/settings/resources`	`GET`	`Public`
`api/settings/setting-instancetitle`	`GET`	`Public`
`api/settings/setting-isactivedirectoryauthentication`	`GET`	`Public`
`api/settings/setting-isauthenticationenabled`	`GET`	`Public`

`api/signals`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/signals/`	`GET`	`Read`
`api/signals/`	`POST`	`Write`	Only `Setup` principals can create protected signals.
`api/signals/{id}`	`DELETE`	`Write`	Only `Setup` principals can create protected signals.
`api/signals/{id}`	`GET`	`Read`
`api/signals/{id}`	`PUT`	`Write`	Only `Setup` principals can create protected signals.
`api/signals/{signalId}/watchers`	`DELETE`	`Write`
`api/signals/{signalId}/watchers`	`POST`	`Write`
`api/signals/resources`	`GET`	`Public`
`api/signals/template`	`GET`	`Write`

`api/sqlqueries`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/sqlqueries/`	`GET`	`Read`
`api/sqlqueries/`	`POST`	`Write`
`api/sqlqueries/{id}`	`DELETE`	`Write`
`api/sqlqueries/{id}`	`GET`	`Read`
`api/sqlqueries/{id}`	`PUT`	`Write`
`api/sqlqueries/{sqlQueryId}/users`	`DELETE`	`Write`
`api/sqlqueries/{sqlQueryId}/users`	`POST`	`Write`
`api/sqlqueries/resources`	`GET`	`Public`
`api/sqlqueries/template`	`GET`	`Write`

`api/updates`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/updates/`	`GET`	`Setup`
`api/updates/{id}`	`GET`	`Setup`
`api/updates/resources`	`GET`	`Public`

`api/users`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/users/`	`GET`	`Setup`
`api/users/`	`POST`	`Setup`
`api/users/{id}`	`DELETE`	`Setup`
`api/users/{id}`	`GET`	`Setup`
`api/users/{id}`	`PUT`	`Write`	Only `Setup` principals can update other principals.
`api/users/{id}/searches`	`GET`	`Read`	Only the principal's own search history can be retrieved.
`api/users/{id}/searches/update`	`POST`	`Write`	Only the principal's own search history can be updated.
`api/users/current`	`GET`	`Public`	Can only return logged-in user information.
`api/users/login`	`POST`	`Public`
`api/users/logout`	`POST`	`Public`
`api/users/providers`	`GET`	`Public`
`api/users/resources`	`GET`	`Public`
`api/users/template`	`GET`	`Setup`

`api/workspaces`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/workspaces/`	`GET`	`Read`	Users can only read shared workspaces, and those that they own.
`api/workspaces/`	`POST`	`Write`	Users can only create shared workspaces or personally owned ones.
`api/workspaces/{id}`	`DELETE`	`Write`	The additional `Setup` permission can be used to remove any workspace. Users can only update workspaces that they own.
`api/workspaces/{id}`	`GET`	`Read`	Users can only read shared workspaces, and those that they own.
`api/workspaces/{id}`	`PUT`	`Write`	The additional `Setup` permission is required to update shared workspaces. Users can only update workspaces that they own.
`api/workspaces/resources`	`GET`	`Public`
`api/workspaces/template`	`GET`	`Write`

`integrated/`

Path	HTTP method	Permission demand	Additional requirements	Notes
`integrated/`	`GET`	`Public`	The Windows identity must already be authenticated.

`theme/styles.css`

Path	HTTP method	Permission demand	Additional requirements	Notes
`theme/styles.css`	`GET`	`Public`

Updated almost 6 years ago