Documentation
DocumentationDiscussions
Documentation
These docs are for v2022.1. Click to read the latest docs for v2024.3.

Server API Endpoints

This document lists the API endpoints provided by the Seq server. These can also be called using the C# API client.

api/

PathHTTP methodPermission demandAdditional requirementsNotes
api/GETPublic

api/alerts

PathHTTP methodPermission demandAdditional requirementsNotes
api/alerts/GETReadUsers can only read shared alerts, and those that they own.
api/alerts/POSTWriteUsers can only create shared alerts or personally owned ones. The additional Project permission is required to create protected alerts.
api/alerts/{id}DELETEWriteUsers can only remove shared alerts and those that they own. The additional Project permission is required to remove protected alerts.
api/alerts/{id}GETReadUsers can only read shared alerts, and those that they own.
api/alerts/{id}PUTWriteUsers can only update shared alerts and those that they own. The additional Project permission is required to update protected alerts.
api/alerts/resourcesGETPublic
api/alerts/templateGETWrite

api/alertstate

PathHTTP methodPermission demandAdditional requirementsNotes
api/alertstate/GETProject
api/alertstate/{id}DELETEProject
api/alertstate/{id}GETProject
api/alertstate/resourcesGETPublic

api/apikeys

PathHTTP methodPermission demandAdditional requirementsNotes
api/apikeys/GETReadOnly Project principals can view all keys; others can only request and view keys that they own.
api/apikeys/POSTWriteA 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}DELETEWriteOnly Project principals can remove any key; others can only remove keys that they own.
api/apikeys/{id}GETReadOnly Project principals can view all keys; others can only request and view keys that they own.
api/apikeys/{id}PUTWriteA 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}GETReadOnly Project principals can view metrics for all keys; others can only request and view metrics for keys that they own.
api/apikeys/resourcesGETPublic
api/apikeys/templateGETRead

api/appinstances

PathHTTP methodPermission demandAdditional requirementsNotes
api/appinstances/GETReadPrincipals without Project permissions can only access basic details of available app instances.
api/appinstances/POSTSystem
api/appinstances/{id}DELETESystem
api/appinstances/{id}GETReadPrincipals without Project permissions can only access basic details of available app instances.
api/appinstances/{id}PUTSystem
api/appinstances/{id}/iconGETReadPrincipals without Project permissions can only access basic details of available app instances.
api/appinstances/{id}/invokePOSTWriteThe app instance id must be an output, and either accept direct invocation, or the principal must have System permissions.
api/appinstances/{id}/metrics/{measurement}GETProject
api/appinstances/resourcesGETPublic
api/appinstances/templateGETSystem

api/apps

PathHTTP methodPermission demandAdditional requirementsNotes
api/apps/GETSystem
api/apps/{id}DELETESystem
api/apps/{id}GETSystem
api/apps/{id}/iconGETSystem
api/apps/{id}/updatePOSTSystem
api/apps/installPOSTSystem
api/apps/resourcesGETPublic
api/apps/templateGETSystem

api/backups

PathHTTP methodPermission demandAdditional requirementsNotes
api/backups/GETSystem
api/backups/{id}GETSystem
api/backups/files/{filename}GETSystem
api/backups/immediatePOSTSystem
api/backups/resourcesGETPublic

api/clusternodes

PathHTTP methodPermission demandAdditional requirementsNotes
api/clusternodes/GETSystem
api/clusternodes/{id}GETSystem
api/clusternodes/{id}/demotePOSTSystem
api/clusternodes/resourcesGETPublic

api/dashboards

PathHTTP methodPermission demandAdditional requirementsNotes
api/dashboards/GETReadUsers can only read shared dashboards, and those that they own.
api/dashboards/POSTWriteUsers can only create shared dashboards or personally owned ones. The additional Project permission is required to create protected dashboards.
api/dashboards/{id}DELETEWriteUsers can only remove shared dashboards and those that they own. The additional Project permission is required to remove protected dashboards.
api/dashboards/{id}GETReadUsers can only read shared dashboards, and those that they own.
api/dashboards/{id}PUTWriteUsers can only update shared dashboards and those that they own. The additional Project permission is required to update protected dashboards.
api/dashboards/query/templateGETWrite
api/dashboards/resourcesGETPublic
api/dashboards/templateGETWrite

api/data

PathHTTP methodPermission demandAdditional requirementsNotes
api/data/GETRead
api/data/POSTRead
api/data/{signalId}GETReadObsolete
api/data/resourcesGETPublic

api/deferred

PathHTTP methodPermission demandAdditional requirementsNotes
api/deferred/{deferredId}GETRead

api/diagnostics

PathHTTP methodPermission demandAdditional requirementsNotes
api/diagnostics/ingestionGETSystem
api/diagnostics/metricsGETProject
api/diagnostics/metrics/{measurement}GETProject
api/diagnostics/reportGETSystem
api/diagnostics/resourcesGETPublic
api/diagnostics/statusGETRead
api/diagnostics/storageGETProject

api/events

PathHTTP methodPermission demandAdditional requirementsNotes
api/events/GETRead
api/events/{id}GETRead
api/events/raw/POSTPublicIf the RequireApiKeyForWritingEvents setting is enabled, requests must be authenticated and have the Ingest permission.
api/events/resourcesGETPublic
api/events/signalDELETEProject
api/events/signalGETRead
api/events/signalPOSTRead
api/events/signal/{signalId}GETReadObsolete
api/events/tabulatePOSTRead
api/events/tabulate/{signalId}GETRead

api/expressions

PathHTTP methodPermission demandAdditional requirementsNotes
api/expressions/resourcesGETPublic
api/expressions/sqlGETRead
api/expressions/strictGETRead

api/feeds

PathHTTP methodPermission demandAdditional requirementsNotes
api/feeds/GETSystem
api/feeds/POSTSystem
api/feeds/{id}DELETESystem
api/feeds/{id}GETSystem
api/feeds/{id}PUTSystem
api/feeds/resourcesGETPublic
api/feeds/templateGETSystem

api/integrationtest

PathHTTP methodPermission demandAdditional requirementsNotes
api/integrationtest/resourcesGETPublic

api/licenses

PathHTTP methodPermission demandAdditional requirementsNotes
api/licenses/GETSystem
api/licenses/{id}GETReadRead principals can see license status but System is required for certificate details.
api/licenses/{id}PUTSystem
api/licenses/downgradePOSTSystem
api/licenses/resourcesGETPublic

api/permalinks

PathHTTP methodPermission demandAdditional requirementsNotes
api/permalinks/GETReadNon-Project principals can only view their own permalinks.
api/permalinks/POSTWriteNon-Project principals can only create permalinks for themselves.
api/permalinks/{id}DELETEWriteNon-Project principals can only remove their own permalinks.
api/permalinks/{id}GETReadNon-Project principals can only retrieve their own permalinks.
api/permalinks/resourcesGETPublic
api/permalinks/templateGETWrite

api/retentionpolicies

PathHTTP methodPermission demandAdditional requirementsNotes
api/retentionpolicies/GETProject
api/retentionpolicies/POSTProject
api/retentionpolicies/{id}DELETEProject
api/retentionpolicies/{id}GETProject
api/retentionpolicies/{id}PUTProject
api/retentionpolicies/resourcesGETPublic
api/retentionpolicies/templateGETProject

api/roles

PathHTTP methodPermission demandAdditional requirementsNotes
api/roles/GETRead
api/roles/{id}GETRead
api/roles/resourcesGETPublic

api/runningtasks

PathHTTP methodPermission demandAdditional requirementsNotes
api/runningtasks/GETSystem
api/runningtasks/{id}DELETESystem
api/runningtasks/{id}GETSystem
api/runningtasks/resourcesGETPublic

api/settings

PathHTTP methodPermission demandAdditional requirementsNotes
api/settings/{id}GETSystem
api/settings/{id}PUTSystem
api/settings/internal-error-reportingGETSystem
api/settings/internal-error-reportingPUTSystem
api/settings/resourcesGETPublic
api/settings/setting-authenticationproviderGETPublic
api/settings/setting-instancetitleGETPublic
api/settings/setting-isactivedirectoryauthenticationGETPublic
api/settings/setting-isauthenticationenabledGETPublic
api/settings/setting-newusershowdashboardidsGETOrganization
api/settings/setting-newusershowdashboardidsPUTOrganization
api/settings/setting-newusershowqueryidsGETOrganization
api/settings/setting-newusershowqueryidsPUTOrganization
api/settings/setting-newusershowsignalidsGETOrganization
api/settings/setting-newusershowsignalidsPUTOrganization
api/settings/setting-requireapikeyforwritingeventsGETProject
api/settings/setting-requireapikeyforwritingeventsPUTProject

api/signals

PathHTTP methodPermission demandAdditional requirementsNotes
api/signals/GETReadUsers can only read shared signals, and those that they own.
api/signals/POSTWriteUsers can only create shared signals or personally owned ones. The additional Project permission is required to create protected signals.
api/signals/{id}DELETEWriteUsers can only remove shared signals and those that they own. The additional Project permission is required to remove protected signals.
api/signals/{id}GETReadUsers can only read shared signals, and those that they own.
api/signals/{id}PUTWriteUsers can only update shared signals and those that they own. The additional Project permission is required to update protected signals.
api/signals/resourcesGETPublic
api/signals/templateGETWrite

api/sqlqueries

PathHTTP methodPermission demandAdditional requirementsNotes
api/sqlqueries/GETReadUsers can only read shared SQL queries, and those that they own.
api/sqlqueries/POSTWriteUsers can only create shared SQL queries or personally owned ones. The additional Project permission is required to create protected SQL queries.
api/sqlqueries/{id}DELETEWriteUsers 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}GETReadUsers can only read shared SQL queries, and those that they own.
api/sqlqueries/{id}PUTWriteUsers can only update shared SQL queries and those that they own. The additional Project permission is required to update protected SQL queries.
api/sqlqueries/resourcesGETPublic
api/sqlqueries/templateGETWrite

api/updates

PathHTTP methodPermission demandAdditional requirementsNotes
api/updates/GETSystem
api/updates/{id}GETSystem
api/updates/resourcesGETPublic

api/users

PathHTTP methodPermission demandAdditional requirementsNotes
api/users/GETProjectOnly System principals can access authentication provider information for a user.
api/users/POSTOrganizationNo principal can create a user with permissions that it does not itself have.
api/users/{id}DELETEOrganization
api/users/{id}GETPublicUsers 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}PUTWriteUsers 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}/searchesDELETEWriteOnly the principal's own search history can be cleared.
api/users/{id}/searchesGETReadOnly the principal's own search history can be retrieved.
api/users/{id}/searches/updatePOSTWriteOnly the principal's own search history can be updated.
api/users/{id}/unlinkauthenticationproviderPOSTSystem
api/users/currentGETPublicCan only return logged-in user information.
api/users/loginPOSTPublic
api/users/logoutPOSTPublic
api/users/providersGETPublic
api/users/resourcesGETPublic
api/users/templateGETOrganization

api/workspaces

PathHTTP methodPermission demandAdditional requirementsNotes
api/workspaces/GETReadUsers can only read shared workspaces, and those that they own.
api/workspaces/POSTWriteUsers can only create shared workspaces or personally owned ones. The additional Project permission is required to create protected workspaces.
api/workspaces/{id}DELETEWriteUsers can only remove shared workspaces and those that they own. The additional Project permission is required to remove protected workspaces.
api/workspaces/{id}GETReadUsers can only read shared workspaces, and those that they own.
api/workspaces/{id}PUTWriteUsers can only update shared workspaces and those that they own. The additional Project permission is required to update protected workspaces.
api/workspaces/resourcesGETPublic
api/workspaces/templateGETWrite

health/

PathHTTP methodPermission demandAdditional requirementsNotes
health/GETPublic

integrated/

PathHTTP methodPermission demandAdditional requirementsNotes
integrated/GETPublicThe Windows identity must already be authenticated.

oidc/challenge

PathHTTP methodPermission demandAdditional requirementsNotes
oidc/challengeGETPublic
oidc/challengePOSTPublic

theme/styles.css

PathHTTP methodPermission demandAdditional requirementsNotes
theme/styles.cssGETPublic