DocumentationDiscussions
DocumentationDiscussions
Hey! These docs are for version 5.1, which is no longer officially supported. Click here for the latest version, 2022.1!

Server HTTP API

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

Endpoints

aad/

PathHTTP methodPermission demandAdditional requirementsNotes
aad/GETPublic

api/

PathHTTP methodPermission demandAdditional requirementsNotes
api/GETPublic

api/apikeys

PathHTTP methodPermission demandAdditional requirementsNotes
api/apikeys/GETReadOnly Setup 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 Setup principals can create keys without an owner. Principals can only delegate permissions to a key that they themselves hold.
api/apikeys/{id}DELETEWriteOnly Setup principals can remove any key; others can only remove keys that they own.
api/apikeys/{id}GETReadOnly Setup 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 Setup principals can create keys without an owner. Principals can only delegate permissions to a key that they themselves hold.
api/apikeys/resourcesGETPublic
api/apikeys/templateGETRead

api/appinstances

PathHTTP methodPermission demandAdditional requirementsNotes
api/appinstances/GETWritePrincipals that can invoke apps can access the basic details of available, invokable apps.
api/appinstances/POSTSetup
api/appinstances/{appInstanceId}/invokePOSTWriteThe app instance appInstanceId must allow manual input.
api/appinstances/{id}DELETESetup
api/appinstances/{id}GETWritePrincipals that can invoke apps can access the basic details of available, invokable apps.
api/appinstances/{id}PUTSetup
api/appinstances/resourcesGETPublic
api/appinstances/templateGETSetup

api/apps

PathHTTP methodPermission demandAdditional requirementsNotes
api/apps/GETSetup
api/apps/POSTSetup
api/apps/{id}DELETESetup
api/apps/{id}GETSetup
api/apps/{id}PUTSetup
api/apps/{id}/updatePOSTSetup
api/apps/installPOSTSetup
api/apps/resourcesGETPublic
api/apps/templateGETSetup

api/backups

PathHTTP methodPermission demandAdditional requirementsNotes
api/backups/GETSetup
api/backups/{id}GETSetup
api/backups/files/{filename}GETSetup
api/backups/immediatePOSTSetup
api/backups/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 Setup permission is required to create protected dashboards.
api/dashboards/{id}DELETEWriteUsers can only remove shared dashboards and those that they own. The additional Setup 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 Setup 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/ingestionGETSetup
api/diagnostics/metricsGETSetup
api/diagnostics/reportGETSetup
api/diagnostics/resourcesGETPublic
api/diagnostics/statusGETRead

api/events

PathHTTP methodPermission demandAdditional requirementsNotes
api/events/GETRead
api/events/{id}GETRead
api/events/histogramPOSTReadObsolete
api/events/histogram/{signalId}GETReadObsolete
api/events/raw/OPTIONSPublicRequired to support CORS. Ingestion is always allowed from any origin.
api/events/raw/POSTPublicIf the RequireApiKeyForWritingEvents setting is enabled, requests must be authenticated and have the Ingest permission.
api/events/resourcesGETPublic
api/events/signalDELETESetup
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/GETSetup
api/feeds/POSTSetup
api/feeds/{id}DELETESetup
api/feeds/{id}GETSetup
api/feeds/{id}PUTSetup
api/feeds/resourcesGETPublic
api/feeds/templateGETSetup

api/licenses

PathHTTP methodPermission demandAdditional requirementsNotes
api/licenses/GETSetup
api/licenses/{id}GETReadRead principals can see license status but Setup is required for certificate details.
api/licenses/{id}PUTSetup
api/licenses/downgradePOSTSetup
api/licenses/resourcesGETPublic

api/permalinks

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

api/retentionpolicies

PathHTTP methodPermission demandAdditional requirementsNotes
api/retentionpolicies/GETSetup
api/retentionpolicies/POSTSetup
api/retentionpolicies/{id}DELETESetup
api/retentionpolicies/{id}GETSetup
api/retentionpolicies/{id}PUTSetup
api/retentionpolicies/resourcesGETPublic
api/retentionpolicies/templateGETSetup

api/roles

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

api/settings

PathHTTP methodPermission demandAdditional requirementsNotes
api/settings/{id}GETSetup
api/settings/{id}PUTSetup
api/settings/internal-error-reportingGETSetup
api/settings/internal-error-reportingPUTSetup
api/settings/resourcesGETPublic
api/settings/setting-instancetitleGETPublic
api/settings/setting-isactivedirectoryauthenticationGETPublic
api/settings/setting-isauthenticationenabledGETPublic

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 Setup permission is required to create protected signals.
api/signals/{id}DELETEWriteUsers can only remove shared signals and those that they own. The additional Setup 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 Setup 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 Setup 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 Setup 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 Setup permission is required to update protected SQL queries.
api/sqlqueries/resourcesGETPublic
api/sqlqueries/templateGETWrite

api/updates

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

api/users

PathHTTP methodPermission demandAdditional requirementsNotes
api/users/GETSetup
api/users/POSTSetup
api/users/{id}DELETESetup
api/users/{id}GETPublicUsers can retrieve their own records. Only Setup principals can retrieve other principals.
api/users/{id}PUTWriteUsers can update limited fields on their own records. Only Setup principals can update other principals.
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/currentGETPublicCan only return logged-in user information.
api/users/loginPOSTPublic
api/users/logoutPOSTPublic
api/users/providersGETPublic
api/users/resourcesGETPublic
api/users/templateGETSetup

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 Setup permission is required to create protected workspaces.
api/workspaces/{id}DELETEWriteUsers can only remove shared workspaces and those that they own. The additional Setup 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 Setup permission is required to update protected workspaces.
api/workspaces/resourcesGETPublic
api/workspaces/templateGETWrite

integrated/

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

theme/styles.css

PathHTTP methodPermission demandAdditional requirementsNotes
theme/styles.cssGETPublic

Did this page help you?