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

Server API Endpoints

This document lists the API endpoints provided by the Seq server.

`api/`

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

`api/alerts`

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

`api/alertstate`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/alertstate/`	`GET`	`Setup`
`api/alertstate/{id}`	`DELETE`	`Setup`
`api/alertstate/{id}`	`GET`	`Setup`
`api/alertstate/resources`	`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/{id}/metrics/{measurement}`	`GET`	`Read`	Only `Setup` principals can view metrics for all keys; others can only request and view metrics for keys that they own.
`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 app instances.
`api/appinstances/`	`POST`	`Setup`
`api/appinstances/{id}`	`DELETE`	`Setup`
`api/appinstances/{id}`	`GET`	`Write`	Principals that can invoke apps can access the basic details of available app instances.
`api/appinstances/{id}`	`PUT`	`Setup`
`api/appinstances/{id}/icon`	`GET`	`Write`	Principals that can invoke apps can access the basic details of available app instances.
`api/appinstances/{id}/invoke`	`POST`	`Write`	The app instance `id` must allow manual input.
`api/appinstances/{id}/metrics/{measurement}`	`GET`	`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}/icon`	`GET`	`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/clusternodes`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/clusternodes/`	`GET`	`Setup`
`api/clusternodes/{id}`	`GET`	`Setup`
`api/clusternodes/{id}/demote`	`POST`	`Setup`
`api/clusternodes/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. The additional `Setup` permission is required to create protected dashboards.
`api/dashboards/{id}`	`DELETE`	`Write`	Users can only remove shared dashboards and those that they own. The additional `Setup` permission is required to remove protected dashboards.
`api/dashboards/{id}`	`GET`	`Read`	Users can only read shared dashboards, and those that they own.
`api/dashboards/{id}`	`PUT`	`Write`	Users can only update shared dashboards and those that they own. The additional `Setup` permission is required to update protected dashboards.
`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/metrics/{measurement}`	`GET`	`Setup`
`api/diagnostics/report`	`GET`	`Setup`
`api/diagnostics/resources`	`GET`	`Public`
`api/diagnostics/status`	`GET`	`Read`
`api/diagnostics/storage`	`GET`	`Setup`

`api/events`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/events/`	`GET`	`Read`
`api/events/{id}`	`GET`	`Read`
`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/integrationtest`

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

`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/runningtasks`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/runningtasks/`	`GET`	`Setup`
`api/runningtasks/{id}`	`DELETE`	`Setup`
`api/runningtasks/{id}`	`GET`	`Setup`
`api/runningtasks/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-authenticationprovider`	`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`	Users can only read shared signals, and those that they own.
`api/signals/`	`POST`	`Write`	Users can only create shared signals or personally owned ones. The additional `Setup` permission is required to create protected signals.
`api/signals/{id}`	`DELETE`	`Write`	Users can only remove shared signals and those that they own. The additional `Setup` permission is required to remove protected signals.
`api/signals/{id}`	`GET`	`Read`	Users can only read shared signals, and those that they own.
`api/signals/{id}`	`PUT`	`Write`	Users can only update shared signals and those that they own. The additional `Setup` permission is required to update protected signals.
`api/signals/resources`	`GET`	`Public`
`api/signals/template`	`GET`	`Write`

`api/sqlqueries`

Path	HTTP method	Permission demand	Additional requirements	Notes
`api/sqlqueries/`	`GET`	`Read`	Users can only read shared SQL queries, and those that they own.
`api/sqlqueries/`	`POST`	`Write`	Users can only create shared SQL queries or personally owned ones. The additional `Setup` permission is required to create protected SQL queries.
`api/sqlqueries/{id}`	`DELETE`	`Write`	Users can only remove shared SQL queries and those that they own. The additional `Setup` permission is required to remove protected SQL queries.
`api/sqlqueries/{id}`	`GET`	`Read`	Users can only read shared SQL queries, and those that they own.
`api/sqlqueries/{id}`	`PUT`	`Write`	Users can only update shared SQL queries and those that they own. The additional `Setup` permission is required to update protected SQL queries.
`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`	`Public`	Users can retrieve their own records. Only `Setup` principals can retrieve other principals.
`api/users/{id}`	`PUT`	`Write`	Users can update limited fields on their own records. 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/{id}/unlinkauthenticationprovider`	`POST`	`Setup`
`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. The additional `Setup` permission is required to create protected workspaces.
`api/workspaces/{id}`	`DELETE`	`Write`	Users can only remove shared workspaces and those that they own. The additional `Setup` permission is required to remove protected workspaces.
`api/workspaces/{id}`	`GET`	`Read`	Users can only read shared workspaces, and those that they own.
`api/workspaces/{id}`	`PUT`	`Write`	Users can only update shared workspaces and those that they own. The additional `Setup` permission is required to update protected workspaces.
`api/workspaces/resources`	`GET`	`Public`
`api/workspaces/template`	`GET`	`Write`

`health/`

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

`integrated/`

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

`oidc/challenge`

Path	HTTP method	Permission demand	Additional requirements	Notes
`oidc/challenge`	`GET`	`Public`
`oidc/challenge`	`POST`	`Public`

`theme/styles.css`

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

Updated about 3 years ago