Server API Endpoints
This document lists the API endpoints provided by the Seq server. These can also be called using the C# API client.
HTTP API Endpoints
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 Project 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 Project 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 Project 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 |
Project |
||
api/alertstate/{id} |
DELETE |
Project |
||
api/alertstate/{id} |
GET |
Project |
||
api/alertstate/resources |
GET |
Public |
api/apikeys
Path | HTTP method | Permission demand | Additional requirements | Notes |
---|---|---|---|---|
api/apikeys |
GET |
Read |
Only Project 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 Project 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 Project principals can remove any key; others can only remove keys that they own. |
|
api/apikeys/{id} |
GET |
Read |
Only Project 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 Project 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 Project principals can view metrics for all keys; others can only request and view metrics for keys that they own. |
|
api/apikeys/metrics/{measurement} |
GET |
Project |
||
api/apikeys/resources |
GET |
Public |
||
api/apikeys/template |
GET |
Read |
api/appinstances
Path | HTTP method | Permission demand | Additional requirements | Notes |
---|---|---|---|---|
api/appinstances |
GET |
Read |
Principals without Project permissions can only access basic details of available app instances. |
|
api/appinstances |
POST |
System |
||
api/appinstances/{id} |
DELETE |
System |
||
api/appinstances/{id} |
GET |
Read |
Principals without Project permissions can only access basic details of available app instances. |
|
api/appinstances/{id} |
PUT |
System |
||
api/appinstances/{id}/icon |
GET |
Read |
Principals without Project permissions can only access basic details of available app instances. |
|
api/appinstances/{id}/invoke |
POST |
Write |
The app instance id must be an output, and either accept direct invocation, or the principal must have System permissions. |
|
api/appinstances/{id}/metrics/{measurement} |
GET |
Project |
||
api/appinstances/resources |
GET |
Public |
||
api/appinstances/template |
GET |
System |
api/apps
Path | HTTP method | Permission demand | Additional requirements | Notes |
---|---|---|---|---|
api/apps |
GET |
System |
||
api/apps/{id} |
DELETE |
System |
||
api/apps/{id} |
GET |
System |
||
api/apps/{id}/icon |
GET |
System |
||
api/apps/{id}/update |
POST |
System |
||
api/apps/install |
POST |
System |
||
api/apps/resources |
GET |
Public |
||
api/apps/template |
GET |
System |
api/backups
Path | HTTP method | Permission demand | Additional requirements | Notes |
---|---|---|---|---|
api/backups |
GET |
System |
||
api/backups/{id} |
GET |
System |
||
api/backups/files/{filename} |
GET |
System |
||
api/backups/immediate |
POST |
System |
Allows Cross-Site POSTs | |
api/backups/resources |
GET |
Public |
api/cluster
Path | HTTP method | Permission demand | Additional requirements | Notes |
---|---|---|---|---|
api/cluster |
GET |
System |
||
api/cluster/{id} |
GET |
System |
||
api/cluster/{id}/drain |
POST |
System |
||
api/cluster/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 Project 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 Project 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 Project 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/cluster/metrics |
GET |
System |
||
api/diagnostics/ingestion |
GET |
System |
||
api/diagnostics/metrics |
GET |
Project |
||
api/diagnostics/metrics/{measurement} |
GET |
Project |
||
api/diagnostics/report |
GET |
System |
||
api/diagnostics/resources |
GET |
Public |
||
api/diagnostics/status |
GET |
Read |
||
api/diagnostics/storage |
GET |
Project |
||
api/diagnostics/usage-telemetry |
POST |
Read |
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. |
Allows Cross-Site POSTs |
api/events/resources |
GET |
Public |
||
api/events/scan |
GET |
Read |
||
api/events/signal |
DELETE |
Project |
||
api/events/signal |
GET |
Read |
||
api/events/signal |
POST |
Read |
||
api/events/signal/{signalId} |
GET |
Read |
Obsolete | |
api/events/stream |
GET |
Read |
||
api/events/tabulate |
POST |
Read |
||
api/events/tabulate/{signalId} |
GET |
Read |
api/expressionindexes
Path | HTTP method | Permission demand | Additional requirements | Notes |
---|---|---|---|---|
api/expressionindexes |
GET |
Read |
||
api/expressionindexes |
POST |
Write |
||
api/expressionindexes/{id} |
DELETE |
Write |
||
api/expressionindexes/{id} |
GET |
Read |
||
api/expressionindexes/resources |
GET |
Public |
||
api/expressionindexes/template |
GET |
Write |
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 |
System |
||
api/feeds |
POST |
System |
||
api/feeds/{id} |
DELETE |
System |
||
api/feeds/{id} |
GET |
System |
||
api/feeds/{id} |
PUT |
System |
||
api/feeds/resources |
GET |
Public |
||
api/feeds/template |
GET |
System |
api/indexes
Path | HTTP method | Permission demand | Additional requirements | Notes |
---|---|---|---|---|
api/indexes |
GET |
Project |
||
api/indexes/{id} |
DELETE |
Project |
||
api/indexes/{id} |
GET |
Project |
||
api/indexes/resources |
GET |
Public |
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 |
System |
||
api/licenses/{id} |
GET |
Read |
Read principals can see license status but System is required for certificate details. |
|
api/licenses/{id} |
PUT |
System |
||
api/licenses/downgrade |
POST |
System |
||
api/licenses/resources |
GET |
Public |
api/permalinks
Path | HTTP method | Permission demand | Additional requirements | Notes |
---|---|---|---|---|
api/permalinks |
GET |
Read |
Non-Project principals can only view their own permalinks. |
|
api/permalinks |
POST |
Write |
Non-Project principals can only create permalinks for themselves. |
|
api/permalinks/{id} |
DELETE |
Write |
Non-Project principals can only remove their own permalinks. |
|
api/permalinks/{id} |
GET |
Read |
Non-Project 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 |
Project |
||
api/retentionpolicies |
POST |
Project |
||
api/retentionpolicies/{id} |
DELETE |
Project |
||
api/retentionpolicies/{id} |
GET |
Project |
||
api/retentionpolicies/{id} |
PUT |
Project |
||
api/retentionpolicies/resources |
GET |
Public |
||
api/retentionpolicies/template |
GET |
Project |
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 |
System |
||
api/runningtasks/{id} |
DELETE |
System |
||
api/runningtasks/{id} |
GET |
System |
||
api/runningtasks/resources |
GET |
Public |
api/settings
Path | HTTP method | Permission demand | Additional requirements | Notes |
---|---|---|---|---|
api/settings/{id} |
GET |
System |
||
api/settings/{id} |
PUT |
System |
||
api/settings/internal-error-reporting |
GET |
System |
||
api/settings/internal-error-reporting |
PUT |
System |
||
api/settings/resources |
GET |
Public |
||
api/settings/setting-authenticationprovider |
GET |
Public |
||
api/settings/setting-checkforupdates |
GET |
System |
||
api/settings/setting-checkforupdates |
PUT |
System |
||
api/settings/setting-instancetitle |
GET |
Public |
||
api/settings/setting-isactivedirectoryauthentication |
GET |
Public |
||
api/settings/setting-isauthenticationenabled |
GET |
Public |
||
api/settings/setting-isusagetelemetryenabled |
GET |
Read |
||
api/settings/setting-minimumfreestoragespace |
GET |
System |
||
api/settings/setting-minimumfreestoragespace |
PUT |
System |
||
api/settings/setting-newusershowdashboardids |
GET |
Organization |
||
api/settings/setting-newusershowdashboardids |
PUT |
Organization |
||
api/settings/setting-newusershowqueryids |
GET |
Organization |
||
api/settings/setting-newusershowqueryids |
PUT |
Organization |
||
api/settings/setting-newusershowsignalids |
GET |
Organization |
||
api/settings/setting-newusershowsignalids |
PUT |
Organization |
||
api/settings/setting-raweventmaximumcontentlength |
GET |
System |
||
api/settings/setting-raweventmaximumcontentlength |
PUT |
System |
||
api/settings/setting-rawpayloadmaximumcontentlength |
GET |
System |
||
api/settings/setting-rawpayloadmaximumcontentlength |
PUT |
System |
||
api/settings/setting-requireapikeyforwritingevents |
GET |
Project |
||
api/settings/setting-requireapikeyforwritingevents |
PUT |
Project |
||
api/settings/setting-searchdurationseconds |
GET |
Read |
||
api/settings/setting-searchdurationseconds |
PUT |
System |
||
api/settings/setting-servicenameexpression |
GET |
Read |
||
api/settings/setting-servicenameexpression |
PUT |
Project |
||
api/settings/setting-themestyles |
GET |
System |
||
api/settings/setting-themestyles |
PUT |
System |
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 Project 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 Project 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 Project 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 Project 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 Project 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 Project 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 |
System |
||
api/updates/{id} |
GET |
System |
||
api/updates/resources |
GET |
Public |
api/users
Path | HTTP method | Permission demand | Additional requirements | Notes |
---|---|---|---|---|
api/users |
GET |
Project |
Only System principals can access authentication provider information for a user. |
|
api/users |
POST |
Organization |
No principal can create a user with permissions that it does not itself have. | |
api/users/{id} |
DELETE |
Organization |
||
api/users/{id} |
GET |
Public |
Users can retrieve their own records. Only Project principals can retrieve other principals. Only System principals can access authentication provider information for a user. |
|
api/users/{id} |
PUT |
Public |
Users can update limited fields on their own records. Only Organization principals can update other principals. No principal can modify a user without holding all permissions held by the target user, and no principal can grant a user permissions that it does not itself have. |
|
api/users/{id}/searches |
DELETE |
Write |
Only the principal's own search history can be cleared. | |
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 |
System |
||
api/users/current |
GET |
Public |
Can only return logged-in user information. | |
api/users/login |
POST |
Public |
||
api/users/logout |
POST |
Public |
Allows Cross-Site POSTs | |
api/users/providers |
GET |
Public |
||
api/users/resources |
GET |
Public |
||
api/users/template |
GET |
Organization |
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 Project 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 Project 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 Project 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 |
health/cluster
Path | HTTP method | Permission demand | Additional requirements | Notes |
---|---|---|---|---|
health/cluster |
GET |
Public |
ingest/clef
Path | HTTP method | Permission demand | Additional requirements | Notes |
---|---|---|---|---|
ingest/clef |
POST |
Public |
If the RequireApiKeyForWritingEvents setting is enabled, requests must be authenticated and have the Ingest permission. |
Allows Cross-Site POSTs |
ingest/otlp
Path | HTTP method | Permission demand | Additional requirements | Notes |
---|---|---|---|---|
ingest/otlp/v1/logs |
POST |
Public |
If the RequireApiKeyForWritingEvents setting is enabled, requests must be authenticated and have the Ingest permission. |
Allows Cross-Site POSTs |
ingest/otlp/v1/metrics |
POST |
Public |
If the RequireApiKeyForWritingEvents setting is enabled, requests must be authenticated and have the Ingest permission. |
Allows Cross-Site POSTs |
ingest/otlp/v1/traces |
POST |
Public |
If the RequireApiKeyForWritingEvents setting is enabled, requests must be authenticated and have the Ingest permission. |
Allows Cross-Site POSTs |
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 |