Nextended.Aspire.Hosting.N8n — API reference

🇩🇪 Diese Seite auf Deutsch

The complete public surface of Nextended.Aspire.Hosting.N8n, generated from the compiled assembly.

Generated

This page is generated by tools/ApiRef from the compiled assembly — it includes members with no XML comment and therefore cannot drift from the code. Do not edit by hand.

↩ Back to the package page

Nextended.Aspire.Hosting.N8n.Builders

N8nBuilderExtensions

static class

Provides the main extension method for adding n8n to an Aspire application.

N8nConfigurationExtensions

static class

Provides fluent configuration extensions for an N8nResource.

N8nDatabaseExtensions

static class

Provides extension methods for configuring the n8n database backend.

N8nGetterExtensions

static class

Provides accessor extension methods for an N8nResource.

N8nImportExtensions

static class

Provides extension methods to seed workflows and credentials into n8n on startup. A one-shot init container runs the n8n CLI import commands before the main instance starts. Intended for local development and integration tests (uses bind mounts); skipped in publish mode.

N8nQueueExtensions

static class

Provides extension methods for enabling n8n queue mode (Redis + worker containers).

N8nUserExtensions

static class

Provides extension methods to seed the n8n owner account on startup, so a freshly started instance is immediately usable (login + REST/public API) without the interactive setup screen.

Nextended.Aspire.Hosting.N8n.Client

N8nApiClient

class

A lightweight, ready-to-use client for the n8n REST API. Wraps a pre-configured HttpClient with the base URL and API key applied.

Constructors

• N8nApiClient(N8nClientSettings settings)
  Creates a new N8nApiClient from the given settings.

Methods

• Dispose() : void

Properties

• ApiBaseUri : Uri { get; }
  Returns the URI of the n8n public API (e.g. for calling /api/v1/workflows).
• Http : HttpClient { get; }
  Gets the configured HttpClient targeting the n8n instance.

Fields

• ApiBasePath : string
  The n8n public API base path (relative to the instance base URL).

N8nClientExtensions

static class

Extension methods for adding an n8n REST API client to service projects.

N8nClientSettings

class

Settings for configuring an n8n REST API client connection.

Constructors

• N8nClientSettings()

Properties

• ApiKey : string { get; set; }
  The n8n public API key (sent as the X-N8N-API-KEY header). Create one in n8n under Settings → n8n API.
• BaseUrl : string { get; set; }
  The base URL of the n8n instance (e.g. http://localhost:5678).

Nextended.Aspire.Hosting.N8n.Resources

N8nResource

class

Represents an n8n workflow-automation container resource. The resource exposes the n8n editor/REST endpoint as its connection string and acts as the visual parent for all related containers (database, redis, workers) in the Aspire dashboard.

Constructors

• N8nResource(string name)
  Creates a new instance of the N8nResource.

Properties

• BasicAuthPassword : string { get; }
  Gets the basic-auth password.
• BasicAuthUser : string { get; }
  Gets the basic-auth user (null = basic auth disabled).
• EditorBaseUrl : string { get; }
  Gets the public editor base URL.
• EncryptionKey : string { get; }
  Gets the n8n encryption key used to encrypt stored credentials. MUST stay stable across restarts, otherwise existing credentials can no longer be decrypted. Used when no EncryptionKeyParameter is configured.
• HostPort : int { get; }
  Gets the host port the n8n editor is exposed on for local development.
• Image : string { get; }
  Gets the n8n container image (without tag).
• ImageTag : string { get; }
  Gets the n8n container image tag.
• QueueModeEnabled : bool { get; }
  True when queue mode (Redis + workers) is enabled.
• Timezone : string { get; }
  Gets the timezone used by n8n (e.g. "Europe/Berlin"). Default: UTC.
• UsesSqlite : bool { get; }
  True when n8n uses the bundled SQLite backend instead of PostgreSQL.
• WebhookUrl : string { get; }
  Gets the public webhook base URL (used to build webhook URLs behind a proxy).

Fields

• HttpEndpointName : string
  The name of the primary HTTP endpoint exposed by n8n.

N8nWorkerResource

class

Represents an n8n worker container resource used in queue mode. Workers share the n8n image, encryption key, database and Redis with the main instance, but run the worker command to process executions from the queue.

Constructors

• N8nWorkerResource(string name)
  Creates a new instance of the N8nWorkerResource.

↩ Back to the package page