openapi: 3.2.0 info: title: n8n Public Log Streaming API description: n8n Public API termsOfService: https://n8n.io/legal/#terms contact: email: hello@n8n.io license: name: Sustainable Use License url: https://github.com/n8n-io/n8n/blob/master/LICENSE.md version: 1.1.1 servers: - url: /api/v1 description: Current n8n instance (self-hosted built-in playground) - url: '{url}/api/v1' description: Self-hosted n8n instance variables: url: default: https://example.com security: - ApiKeyAuth: [] - BearerAuth: [] - CookieAuth: [] tags: - name: LogStreaming description: Operations about log streaming destinations paths: /settings/log-streaming/event-types: get: x-eov-operation-id: getEventTypes x-required-scope: eventBusDestination:list x-eov-operation-handler: v1/handlers/log-streaming/log-streaming.handler tags: - LogStreaming summary: List streamable event types description: List the event types that can be streamed to a log streaming destination. Requires the `eventBusDestination:list` scope and the Log Streaming feature to be licensed. responses: '200': description: Operation successful. content: application/json: schema: type: object additionalProperties: false required: - data properties: data: type: array description: Event names that can be streamed to a destination. items: type: string example: - n8n.workflow.started - n8n.workflow.success - n8n.workflow.failed '401': description: Unauthorized '403': description: Forbidden operationId: getSettingsLogStreamingEventTypes x-operation-id-source: derived /settings/log-streaming/destinations: get: x-eov-operation-id: getDestinations x-required-scope: eventBusDestination:list x-eov-operation-handler: v1/handlers/log-streaming/log-streaming.handler tags: - LogStreaming summary: List log streaming destinations description: List the configured log streaming destinations. Requires the `eventBusDestination:list` scope and the Log Streaming feature to be licensed. responses: '200': description: Operation successful. content: application/json: schema: type: object additionalProperties: false required: - data properties: data: type: array description: The configured log streaming destinations. items: type: object oneOf: - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - url properties: type: type: string enum: - webhook description: Sends each event as an HTTP request to a URL. example: webhook url: type: string format: uri description: Target URL that receives the event payload. example: https://example.com/n8n-events method: type: string description: HTTP method used for the request. example: POST sendHeaders: type: boolean description: Whether to attach custom headers to the request. example: false specifyHeaders: type: string description: How custom headers are provided — `keypair` or `json`. example: keypair headerParameters: type: object additionalProperties: true description: Key-value pairs used when the matching `specify*` field is `keypair`. properties: parameters: type: array items: type: object required: - name - value properties: name: type: string example: Authorization value: description: 'Parameter value. Usually a string; numbers, booleans and null are also accepted. ' example: Bearer jsonHeaders: type: string description: Custom headers as a JSON string when `specifyHeaders` is `json`. sendQuery: type: boolean description: Whether to attach query parameters to the request. example: false specifyQuery: type: string description: How query parameters are provided — `keypair` or `json`. queryParameters: type: object additionalProperties: true description: Key-value pairs used when the matching `specify*` field is `keypair`. properties: parameters: type: array items: type: object required: - name - value properties: name: type: string example: Authorization value: description: 'Parameter value. Usually a string; numbers, booleans and null are also accepted. ' example: Bearer jsonQuery: type: string description: Query parameters as a JSON string when `specifyQuery` is `json`. options: type: object additionalProperties: true description: Additional HTTP request options. properties: timeout: type: integer description: Request timeout in milliseconds. allowUnauthorizedCerts: type: boolean description: Accept self-signed or otherwise invalid TLS certificates. queryParameterArrays: type: string enum: - indices - brackets - repeat description: How array-valued query parameters are serialized into the query string. redirect: type: object additionalProperties: true description: Redirect-following behaviour. properties: redirect: type: object additionalProperties: true properties: followRedirects: type: boolean description: Whether to follow HTTP redirects. maxRedirects: type: integer description: Maximum number of redirects to follow. proxy: type: object additionalProperties: true description: Outbound proxy configuration. properties: proxy: type: object additionalProperties: true properties: protocol: type: string enum: - https - http description: Proxy protocol. host: type: string description: Proxy host, without protocol or port. port: type: integer description: Proxy port. socket: type: object additionalProperties: true description: Connection socket options. properties: keepAlive: type: boolean description: Whether to keep sockets open for reuse. maxSockets: type: integer description: Maximum sockets per host kept open at once. maxFreeSockets: type: integer description: Maximum idle sockets per host kept open. - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - host properties: type: type: string enum: - syslog description: Sends each event to a syslog server. example: syslog host: type: string description: Syslog server host. example: syslog.example.com port: type: integer description: Syslog server port. example: 514 protocol: type: string enum: - udp - tcp - tls description: Transport protocol. example: udp facility: type: integer minimum: 0 maximum: 23 description: 'Syslog facility code (0–23, per RFC 5424). Common values: 0 Kernel, 1 User, 3 System, 13 Audit, 14 Alert, 16 Local0, 17 Local1, 18 Local2, 19 Local3, 20 Local4, 21 Local5, 22 Local6, 23 Local7. ' example: 16 app_name: type: string description: Application name reported in the syslog message. example: n8n tlsCa: type: string description: PEM-encoded CA certificate used when `protocol` is `tls`. - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - dsn properties: type: type: string enum: - sentry description: Sends each event to a Sentry project. example: sentry dsn: type: string format: uri description: Sentry DSN the events are sent to. example: https://examplePublicKey@o0.ingest.sentry.io/0 description: 'A log streaming destination. The `type` field selects the variant and its type-specific fields: `webhook`, `syslog`, or `sentry`. ' '401': description: Unauthorized '403': description: Forbidden operationId: getSettingsLogStreamingDestinations x-operation-id-source: derived post: x-eov-operation-id: createDestination x-required-scope: eventBusDestination:create x-eov-operation-handler: v1/handlers/log-streaming/log-streaming.handler tags: - LogStreaming summary: Create a log streaming destination description: Create a log streaming destination. The destination takes effect exactly as it would from the UI, using the same validation. Requires the `eventBusDestination:create` scope and the Log Streaming feature to be licensed. When destinations are managed via environment variables, the write is rejected with 409 and nothing is created; reads still return the current values. requestBody: description: The destination to create. required: true content: application/json: schema: type: object oneOf: - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - url properties: type: type: string enum: - webhook description: Sends each event as an HTTP request to a URL. example: webhook url: type: string format: uri description: Target URL that receives the event payload. example: https://example.com/n8n-events method: type: string description: HTTP method used for the request. example: POST sendHeaders: type: boolean description: Whether to attach custom headers to the request. example: false specifyHeaders: type: string description: How custom headers are provided — `keypair` or `json`. example: keypair headerParameters: type: object additionalProperties: true description: Key-value pairs used when the matching `specify*` field is `keypair`. properties: parameters: type: array items: type: object required: - name - value properties: name: type: string example: Authorization value: description: 'Parameter value. Usually a string; numbers, booleans and null are also accepted. ' example: Bearer jsonHeaders: type: string description: Custom headers as a JSON string when `specifyHeaders` is `json`. sendQuery: type: boolean description: Whether to attach query parameters to the request. example: false specifyQuery: type: string description: How query parameters are provided — `keypair` or `json`. queryParameters: type: object additionalProperties: true description: Key-value pairs used when the matching `specify*` field is `keypair`. properties: parameters: type: array items: type: object required: - name - value properties: name: type: string example: Authorization value: description: 'Parameter value. Usually a string; numbers, booleans and null are also accepted. ' example: Bearer jsonQuery: type: string description: Query parameters as a JSON string when `specifyQuery` is `json`. options: type: object additionalProperties: true description: Additional HTTP request options. properties: timeout: type: integer description: Request timeout in milliseconds. allowUnauthorizedCerts: type: boolean description: Accept self-signed or otherwise invalid TLS certificates. queryParameterArrays: type: string enum: - indices - brackets - repeat description: How array-valued query parameters are serialized into the query string. redirect: type: object additionalProperties: true description: Redirect-following behaviour. properties: redirect: type: object additionalProperties: true properties: followRedirects: type: boolean description: Whether to follow HTTP redirects. maxRedirects: type: integer description: Maximum number of redirects to follow. proxy: type: object additionalProperties: true description: Outbound proxy configuration. properties: proxy: type: object additionalProperties: true properties: protocol: type: string enum: - https - http description: Proxy protocol. host: type: string description: Proxy host, without protocol or port. port: type: integer description: Proxy port. socket: type: object additionalProperties: true description: Connection socket options. properties: keepAlive: type: boolean description: Whether to keep sockets open for reuse. maxSockets: type: integer description: Maximum sockets per host kept open at once. maxFreeSockets: type: integer description: Maximum idle sockets per host kept open. - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - host properties: type: type: string enum: - syslog description: Sends each event to a syslog server. example: syslog host: type: string description: Syslog server host. example: syslog.example.com port: type: integer description: Syslog server port. example: 514 protocol: type: string enum: - udp - tcp - tls description: Transport protocol. example: udp facility: type: integer minimum: 0 maximum: 23 description: 'Syslog facility code (0–23, per RFC 5424). Common values: 0 Kernel, 1 User, 3 System, 13 Audit, 14 Alert, 16 Local0, 17 Local1, 18 Local2, 19 Local3, 20 Local4, 21 Local5, 22 Local6, 23 Local7. ' example: 16 app_name: type: string description: Application name reported in the syslog message. example: n8n tlsCa: type: string description: PEM-encoded CA certificate used when `protocol` is `tls`. - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - dsn properties: type: type: string enum: - sentry description: Sends each event to a Sentry project. example: sentry dsn: type: string format: uri description: Sentry DSN the events are sent to. example: https://examplePublicKey@o0.ingest.sentry.io/0 description: 'A log streaming destination. The `type` field selects the variant and its type-specific fields: `webhook`, `syslog`, or `sentry`. ' responses: '200': description: Operation successful. content: application/json: schema: type: object oneOf: - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - url properties: type: type: string enum: - webhook description: Sends each event as an HTTP request to a URL. example: webhook url: type: string format: uri description: Target URL that receives the event payload. example: https://example.com/n8n-events method: type: string description: HTTP method used for the request. example: POST sendHeaders: type: boolean description: Whether to attach custom headers to the request. example: false specifyHeaders: type: string description: How custom headers are provided — `keypair` or `json`. example: keypair headerParameters: type: object additionalProperties: true description: Key-value pairs used when the matching `specify*` field is `keypair`. properties: parameters: type: array items: type: object required: - name - value properties: name: type: string example: Authorization value: description: 'Parameter value. Usually a string; numbers, booleans and null are also accepted. ' example: Bearer jsonHeaders: type: string description: Custom headers as a JSON string when `specifyHeaders` is `json`. sendQuery: type: boolean description: Whether to attach query parameters to the request. example: false specifyQuery: type: string description: How query parameters are provided — `keypair` or `json`. queryParameters: type: object additionalProperties: true description: Key-value pairs used when the matching `specify*` field is `keypair`. properties: parameters: type: array items: type: object required: - name - value properties: name: type: string example: Authorization value: description: 'Parameter value. Usually a string; numbers, booleans and null are also accepted. ' example: Bearer jsonQuery: type: string description: Query parameters as a JSON string when `specifyQuery` is `json`. options: type: object additionalProperties: true description: Additional HTTP request options. properties: timeout: type: integer description: Request timeout in milliseconds. allowUnauthorizedCerts: type: boolean description: Accept self-signed or otherwise invalid TLS certificates. queryParameterArrays: type: string enum: - indices - brackets - repeat description: How array-valued query parameters are serialized into the query string. redirect: type: object additionalProperties: true description: Redirect-following behaviour. properties: redirect: type: object additionalProperties: true properties: followRedirects: type: boolean description: Whether to follow HTTP redirects. maxRedirects: type: integer description: Maximum number of redirects to follow. proxy: type: object additionalProperties: true description: Outbound proxy configuration. properties: proxy: type: object additionalProperties: true properties: protocol: type: string enum: - https - http description: Proxy protocol. host: type: string description: Proxy host, without protocol or port. port: type: integer description: Proxy port. socket: type: object additionalProperties: true description: Connection socket options. properties: keepAlive: type: boolean description: Whether to keep sockets open for reuse. maxSockets: type: integer description: Maximum sockets per host kept open at once. maxFreeSockets: type: integer description: Maximum idle sockets per host kept open. - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - host properties: type: type: string enum: - syslog description: Sends each event to a syslog server. example: syslog host: type: string description: Syslog server host. example: syslog.example.com port: type: integer description: Syslog server port. example: 514 protocol: type: string enum: - udp - tcp - tls description: Transport protocol. example: udp facility: type: integer minimum: 0 maximum: 23 description: 'Syslog facility code (0–23, per RFC 5424). Common values: 0 Kernel, 1 User, 3 System, 13 Audit, 14 Alert, 16 Local0, 17 Local1, 18 Local2, 19 Local3, 20 Local4, 21 Local5, 22 Local6, 23 Local7. ' example: 16 app_name: type: string description: Application name reported in the syslog message. example: n8n tlsCa: type: string description: PEM-encoded CA certificate used when `protocol` is `tls`. - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - dsn properties: type: type: string enum: - sentry description: Sends each event to a Sentry project. example: sentry dsn: type: string format: uri description: Sentry DSN the events are sent to. example: https://examplePublicKey@o0.ingest.sentry.io/0 description: 'A log streaming destination. The `type` field selects the variant and its type-specific fields: `webhook`, `syslog`, or `sentry`. ' '400': description: The request is invalid or provides malformed data. '401': description: Unauthorized '403': description: Forbidden '409': description: Conflict operationId: postSettingsLogStreamingDestinations x-operation-id-source: derived /settings/log-streaming/destinations/{id}/test: post: x-eov-operation-id: testDestination x-required-scope: eventBusDestination:test x-eov-operation-handler: v1/handlers/log-streaming/log-streaming.handler tags: - LogStreaming summary: Send a test message to a log streaming destination description: Send a test message to the destination to verify it is reachable and configured correctly. Requires the `eventBusDestination:test` scope and the Log Streaming feature to be licensed. parameters: - name: id in: path description: The id of the log streaming destination. required: true schema: type: string responses: '200': description: Operation successful. content: application/json: schema: type: object additionalProperties: false required: - success properties: success: type: boolean description: Whether the test message was delivered to the destination successfully. example: true '401': description: Unauthorized '403': description: Forbidden '404': description: The specified resource was not found. operationId: postSettingsLogStreamingDestinationsByIdTest x-operation-id-source: derived /settings/log-streaming/destinations/{id}: get: x-eov-operation-id: getDestination x-required-scope: eventBusDestination:read x-eov-operation-handler: v1/handlers/log-streaming/log-streaming.handler tags: - LogStreaming summary: Retrieve a log streaming destination description: Retrieve a single log streaming destination by id. Requires the `eventBusDestination:read` scope and the Log Streaming feature to be licensed. parameters: - name: id in: path description: The id of the log streaming destination. required: true schema: type: string responses: '200': description: Operation successful. content: application/json: schema: type: object oneOf: - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - url properties: type: type: string enum: - webhook description: Sends each event as an HTTP request to a URL. example: webhook url: type: string format: uri description: Target URL that receives the event payload. example: https://example.com/n8n-events method: type: string description: HTTP method used for the request. example: POST sendHeaders: type: boolean description: Whether to attach custom headers to the request. example: false specifyHeaders: type: string description: How custom headers are provided — `keypair` or `json`. example: keypair headerParameters: type: object additionalProperties: true description: Key-value pairs used when the matching `specify*` field is `keypair`. properties: parameters: type: array items: type: object required: - name - value properties: name: type: string example: Authorization value: description: 'Parameter value. Usually a string; numbers, booleans and null are also accepted. ' example: Bearer jsonHeaders: type: string description: Custom headers as a JSON string when `specifyHeaders` is `json`. sendQuery: type: boolean description: Whether to attach query parameters to the request. example: false specifyQuery: type: string description: How query parameters are provided — `keypair` or `json`. queryParameters: type: object additionalProperties: true description: Key-value pairs used when the matching `specify*` field is `keypair`. properties: parameters: type: array items: type: object required: - name - value properties: name: type: string example: Authorization value: description: 'Parameter value. Usually a string; numbers, booleans and null are also accepted. ' example: Bearer jsonQuery: type: string description: Query parameters as a JSON string when `specifyQuery` is `json`. options: type: object additionalProperties: true description: Additional HTTP request options. properties: timeout: type: integer description: Request timeout in milliseconds. allowUnauthorizedCerts: type: boolean description: Accept self-signed or otherwise invalid TLS certificates. queryParameterArrays: type: string enum: - indices - brackets - repeat description: How array-valued query parameters are serialized into the query string. redirect: type: object additionalProperties: true description: Redirect-following behaviour. properties: redirect: type: object additionalProperties: true properties: followRedirects: type: boolean description: Whether to follow HTTP redirects. maxRedirects: type: integer description: Maximum number of redirects to follow. proxy: type: object additionalProperties: true description: Outbound proxy configuration. properties: proxy: type: object additionalProperties: true properties: protocol: type: string enum: - https - http description: Proxy protocol. host: type: string description: Proxy host, without protocol or port. port: type: integer description: Proxy port. socket: type: object additionalProperties: true description: Connection socket options. properties: keepAlive: type: boolean description: Whether to keep sockets open for reuse. maxSockets: type: integer description: Maximum sockets per host kept open at once. maxFreeSockets: type: integer description: Maximum idle sockets per host kept open. - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - host properties: type: type: string enum: - syslog description: Sends each event to a syslog server. example: syslog host: type: string description: Syslog server host. example: syslog.example.com port: type: integer description: Syslog server port. example: 514 protocol: type: string enum: - udp - tcp - tls description: Transport protocol. example: udp facility: type: integer minimum: 0 maximum: 23 description: 'Syslog facility code (0–23, per RFC 5424). Common values: 0 Kernel, 1 User, 3 System, 13 Audit, 14 Alert, 16 Local0, 17 Local1, 18 Local2, 19 Local3, 20 Local4, 21 Local5, 22 Local6, 23 Local7. ' example: 16 app_name: type: string description: Application name reported in the syslog message. example: n8n tlsCa: type: string description: PEM-encoded CA certificate used when `protocol` is `tls`. - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - dsn properties: type: type: string enum: - sentry description: Sends each event to a Sentry project. example: sentry dsn: type: string format: uri description: Sentry DSN the events are sent to. example: https://examplePublicKey@o0.ingest.sentry.io/0 description: 'A log streaming destination. The `type` field selects the variant and its type-specific fields: `webhook`, `syslog`, or `sentry`. ' '401': description: Unauthorized '403': description: Forbidden '404': description: The specified resource was not found. operationId: getSettingsLogStreamingDestinationsById x-operation-id-source: derived put: x-eov-operation-id: updateDestination x-required-scope: eventBusDestination:update x-eov-operation-handler: v1/handlers/log-streaming/log-streaming.handler tags: - LogStreaming summary: Update a log streaming destination description: Replace an existing log streaming destination. The update takes effect exactly as it would from the UI, using the same validation. Requires the `eventBusDestination:update` scope and the Log Streaming feature to be licensed. When destinations are managed via environment variables, the write is rejected with 409 and nothing is changed; reads still return the current values. parameters: - name: id in: path description: The id of the log streaming destination. required: true schema: type: string requestBody: description: The destination fields to apply. required: true content: application/json: schema: type: object oneOf: - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - url properties: type: type: string enum: - webhook description: Sends each event as an HTTP request to a URL. example: webhook url: type: string format: uri description: Target URL that receives the event payload. example: https://example.com/n8n-events method: type: string description: HTTP method used for the request. example: POST sendHeaders: type: boolean description: Whether to attach custom headers to the request. example: false specifyHeaders: type: string description: How custom headers are provided — `keypair` or `json`. example: keypair headerParameters: type: object additionalProperties: true description: Key-value pairs used when the matching `specify*` field is `keypair`. properties: parameters: type: array items: type: object required: - name - value properties: name: type: string example: Authorization value: description: 'Parameter value. Usually a string; numbers, booleans and null are also accepted. ' example: Bearer jsonHeaders: type: string description: Custom headers as a JSON string when `specifyHeaders` is `json`. sendQuery: type: boolean description: Whether to attach query parameters to the request. example: false specifyQuery: type: string description: How query parameters are provided — `keypair` or `json`. queryParameters: type: object additionalProperties: true description: Key-value pairs used when the matching `specify*` field is `keypair`. properties: parameters: type: array items: type: object required: - name - value properties: name: type: string example: Authorization value: description: 'Parameter value. Usually a string; numbers, booleans and null are also accepted. ' example: Bearer jsonQuery: type: string description: Query parameters as a JSON string when `specifyQuery` is `json`. options: type: object additionalProperties: true description: Additional HTTP request options. properties: timeout: type: integer description: Request timeout in milliseconds. allowUnauthorizedCerts: type: boolean description: Accept self-signed or otherwise invalid TLS certificates. queryParameterArrays: type: string enum: - indices - brackets - repeat description: How array-valued query parameters are serialized into the query string. redirect: type: object additionalProperties: true description: Redirect-following behaviour. properties: redirect: type: object additionalProperties: true properties: followRedirects: type: boolean description: Whether to follow HTTP redirects. maxRedirects: type: integer description: Maximum number of redirects to follow. proxy: type: object additionalProperties: true description: Outbound proxy configuration. properties: proxy: type: object additionalProperties: true properties: protocol: type: string enum: - https - http description: Proxy protocol. host: type: string description: Proxy host, without protocol or port. port: type: integer description: Proxy port. socket: type: object additionalProperties: true description: Connection socket options. properties: keepAlive: type: boolean description: Whether to keep sockets open for reuse. maxSockets: type: integer description: Maximum sockets per host kept open at once. maxFreeSockets: type: integer description: Maximum idle sockets per host kept open. - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - host properties: type: type: string enum: - syslog description: Sends each event to a syslog server. example: syslog host: type: string description: Syslog server host. example: syslog.example.com port: type: integer description: Syslog server port. example: 514 protocol: type: string enum: - udp - tcp - tls description: Transport protocol. example: udp facility: type: integer minimum: 0 maximum: 23 description: 'Syslog facility code (0–23, per RFC 5424). Common values: 0 Kernel, 1 User, 3 System, 13 Audit, 14 Alert, 16 Local0, 17 Local1, 18 Local2, 19 Local3, 20 Local4, 21 Local5, 22 Local6, 23 Local7. ' example: 16 app_name: type: string description: Application name reported in the syslog message. example: n8n tlsCa: type: string description: PEM-encoded CA certificate used when `protocol` is `tls`. - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - dsn properties: type: type: string enum: - sentry description: Sends each event to a Sentry project. example: sentry dsn: type: string format: uri description: Sentry DSN the events are sent to. example: https://examplePublicKey@o0.ingest.sentry.io/0 description: 'A log streaming destination. The `type` field selects the variant and its type-specific fields: `webhook`, `syslog`, or `sentry`. ' responses: '200': description: Operation successful. content: application/json: schema: type: object oneOf: - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - url properties: type: type: string enum: - webhook description: Sends each event as an HTTP request to a URL. example: webhook url: type: string format: uri description: Target URL that receives the event payload. example: https://example.com/n8n-events method: type: string description: HTTP method used for the request. example: POST sendHeaders: type: boolean description: Whether to attach custom headers to the request. example: false specifyHeaders: type: string description: How custom headers are provided — `keypair` or `json`. example: keypair headerParameters: type: object additionalProperties: true description: Key-value pairs used when the matching `specify*` field is `keypair`. properties: parameters: type: array items: type: object required: - name - value properties: name: type: string example: Authorization value: description: 'Parameter value. Usually a string; numbers, booleans and null are also accepted. ' example: Bearer jsonHeaders: type: string description: Custom headers as a JSON string when `specifyHeaders` is `json`. sendQuery: type: boolean description: Whether to attach query parameters to the request. example: false specifyQuery: type: string description: How query parameters are provided — `keypair` or `json`. queryParameters: type: object additionalProperties: true description: Key-value pairs used when the matching `specify*` field is `keypair`. properties: parameters: type: array items: type: object required: - name - value properties: name: type: string example: Authorization value: description: 'Parameter value. Usually a string; numbers, booleans and null are also accepted. ' example: Bearer jsonQuery: type: string description: Query parameters as a JSON string when `specifyQuery` is `json`. options: type: object additionalProperties: true description: Additional HTTP request options. properties: timeout: type: integer description: Request timeout in milliseconds. allowUnauthorizedCerts: type: boolean description: Accept self-signed or otherwise invalid TLS certificates. queryParameterArrays: type: string enum: - indices - brackets - repeat description: How array-valued query parameters are serialized into the query string. redirect: type: object additionalProperties: true description: Redirect-following behaviour. properties: redirect: type: object additionalProperties: true properties: followRedirects: type: boolean description: Whether to follow HTTP redirects. maxRedirects: type: integer description: Maximum number of redirects to follow. proxy: type: object additionalProperties: true description: Outbound proxy configuration. properties: proxy: type: object additionalProperties: true properties: protocol: type: string enum: - https - http description: Proxy protocol. host: type: string description: Proxy host, without protocol or port. port: type: integer description: Proxy port. socket: type: object additionalProperties: true description: Connection socket options. properties: keepAlive: type: boolean description: Whether to keep sockets open for reuse. maxSockets: type: integer description: Maximum sockets per host kept open at once. maxFreeSockets: type: integer description: Maximum idle sockets per host kept open. - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - host properties: type: type: string enum: - syslog description: Sends each event to a syslog server. example: syslog host: type: string description: Syslog server host. example: syslog.example.com port: type: integer description: Syslog server port. example: 514 protocol: type: string enum: - udp - tcp - tls description: Transport protocol. example: udp facility: type: integer minimum: 0 maximum: 23 description: 'Syslog facility code (0–23, per RFC 5424). Common values: 0 Kernel, 1 User, 3 System, 13 Audit, 14 Alert, 16 Local0, 17 Local1, 18 Local2, 19 Local3, 20 Local4, 21 Local5, 22 Local6, 23 Local7. ' example: 16 app_name: type: string description: Application name reported in the syslog message. example: n8n tlsCa: type: string description: PEM-encoded CA certificate used when `protocol` is `tls`. - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - dsn properties: type: type: string enum: - sentry description: Sends each event to a Sentry project. example: sentry dsn: type: string format: uri description: Sentry DSN the events are sent to. example: https://examplePublicKey@o0.ingest.sentry.io/0 description: 'A log streaming destination. The `type` field selects the variant and its type-specific fields: `webhook`, `syslog`, or `sentry`. ' '400': description: The request is invalid or provides malformed data. '401': description: Unauthorized '403': description: Forbidden '404': description: The specified resource was not found. '409': description: Conflict operationId: putSettingsLogStreamingDestinationsById x-operation-id-source: derived delete: x-eov-operation-id: deleteDestination x-required-scope: eventBusDestination:delete x-eov-operation-handler: v1/handlers/log-streaming/log-streaming.handler tags: - LogStreaming summary: Delete a log streaming destination description: Remove a log streaming destination. Requires the `eventBusDestination:delete` scope and the Log Streaming feature to be licensed. When destinations are managed via environment variables, the delete is rejected with 409 and nothing is removed; reads still return the current values. parameters: - name: id in: path description: The id of the log streaming destination. required: true schema: type: string responses: '200': description: Operation successful. content: application/json: schema: type: object oneOf: - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - url properties: type: type: string enum: - webhook description: Sends each event as an HTTP request to a URL. example: webhook url: type: string format: uri description: Target URL that receives the event payload. example: https://example.com/n8n-events method: type: string description: HTTP method used for the request. example: POST sendHeaders: type: boolean description: Whether to attach custom headers to the request. example: false specifyHeaders: type: string description: How custom headers are provided — `keypair` or `json`. example: keypair headerParameters: type: object additionalProperties: true description: Key-value pairs used when the matching `specify*` field is `keypair`. properties: parameters: type: array items: type: object required: - name - value properties: name: type: string example: Authorization value: description: 'Parameter value. Usually a string; numbers, booleans and null are also accepted. ' example: Bearer jsonHeaders: type: string description: Custom headers as a JSON string when `specifyHeaders` is `json`. sendQuery: type: boolean description: Whether to attach query parameters to the request. example: false specifyQuery: type: string description: How query parameters are provided — `keypair` or `json`. queryParameters: type: object additionalProperties: true description: Key-value pairs used when the matching `specify*` field is `keypair`. properties: parameters: type: array items: type: object required: - name - value properties: name: type: string example: Authorization value: description: 'Parameter value. Usually a string; numbers, booleans and null are also accepted. ' example: Bearer jsonQuery: type: string description: Query parameters as a JSON string when `specifyQuery` is `json`. options: type: object additionalProperties: true description: Additional HTTP request options. properties: timeout: type: integer description: Request timeout in milliseconds. allowUnauthorizedCerts: type: boolean description: Accept self-signed or otherwise invalid TLS certificates. queryParameterArrays: type: string enum: - indices - brackets - repeat description: How array-valued query parameters are serialized into the query string. redirect: type: object additionalProperties: true description: Redirect-following behaviour. properties: redirect: type: object additionalProperties: true properties: followRedirects: type: boolean description: Whether to follow HTTP redirects. maxRedirects: type: integer description: Maximum number of redirects to follow. proxy: type: object additionalProperties: true description: Outbound proxy configuration. properties: proxy: type: object additionalProperties: true properties: protocol: type: string enum: - https - http description: Proxy protocol. host: type: string description: Proxy host, without protocol or port. port: type: integer description: Proxy port. socket: type: object additionalProperties: true description: Connection socket options. properties: keepAlive: type: boolean description: Whether to keep sockets open for reuse. maxSockets: type: integer description: Maximum sockets per host kept open at once. maxFreeSockets: type: integer description: Maximum idle sockets per host kept open. - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - host properties: type: type: string enum: - syslog description: Sends each event to a syslog server. example: syslog host: type: string description: Syslog server host. example: syslog.example.com port: type: integer description: Syslog server port. example: 514 protocol: type: string enum: - udp - tcp - tls description: Transport protocol. example: udp facility: type: integer minimum: 0 maximum: 23 description: 'Syslog facility code (0–23, per RFC 5424). Common values: 0 Kernel, 1 User, 3 System, 13 Audit, 14 Alert, 16 Local0, 17 Local1, 18 Local2, 19 Local3, 20 Local4, 21 Local5, 22 Local6, 23 Local7. ' example: 16 app_name: type: string description: Application name reported in the syslog message. example: n8n tlsCa: type: string description: PEM-encoded CA certificate used when `protocol` is `tls`. - allOf: - type: object properties: id: type: string readOnly: true description: Server-generated unique id of the destination. Returned in responses; not accepted in requests. example: 88be6560-bfb4-455c-8aa1-06971e9e5522 label: type: string description: Human-readable name shown in the UI. example: My destination enabled: type: boolean description: Whether the destination currently receives events. example: true subscribedEvents: type: array items: type: string description: 'Event names (or group prefixes, e.g. `n8n.workflow`, which matches all `n8n.workflow.*` events) this destination receives. Retrieve the full list of streamable event names from `GET /settings/log-streaming/event-types`. ' example: - n8n.workflow - n8n.audit anonymizeAuditMessages: type: boolean description: Whether audit message payloads are anonymized before being sent. example: false circuitBreaker: type: object additionalProperties: true description: 'Circuit-breaker tuning for delivery. After repeated failures the destination stops sending for a cool-down window instead of hammering an unhealthy target. All fields are optional; sensible defaults apply when omitted. ' properties: maxFailures: type: integer description: Maximum failures within the sliding window before the breaker opens. failureWindow: type: integer description: Sliding window, in milliseconds, over which failures are counted. - type: object additionalProperties: true required: - type - dsn properties: type: type: string enum: - sentry description: Sends each event to a Sentry project. example: sentry dsn: type: string format: uri description: Sentry DSN the events are sent to. example: https://examplePublicKey@o0.ingest.sentry.io/0 description: 'A log streaming destination. The `type` field selects the variant and its type-specific fields: `webhook`, `syslog`, or `sentry`. ' '401': description: Unauthorized '403': description: Forbidden '404': description: The specified resource was not found. '409': description: Conflict operationId: deleteSettingsLogStreamingDestinationsById x-operation-id-source: derived components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-N8N-API-KEY BearerAuth: type: http scheme: bearer bearerFormat: JWT CookieAuth: type: apiKey in: cookie name: n8n-auth externalDocs: description: n8n API documentation url: https://docs.n8n.io/api/ x-enable-proxy: false