---
openapi: 3.0.0
x-enable-proxy: false
info:
  title: n8n Public 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
externalDocs:
  description: n8n API documentation
  url: https://docs.n8n.io/api/
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
tags:
  - name: Audit
    description: Operations about security audit
  - name: CommunityPackage
    description: Operations about community packages
  - name: Credential
    description: Operations about credentials
  - name: CredentialTypePolicy
    description: Preview — breaking changes may still occur without major version bump.
  - name: DataTable
    description: Operations about data tables and their rows
  - name: Discover
    description: API capability discovery
  - name: Evaluation
    description: Operations about evaluation test runs
  - name: Executions
    description: Operations about executions
  - name: Folders
    description: Operations about folders
  - name: Insights
    description: Operations about insights
  - name: LogStreaming
    description: Operations about log streaming destinations
  - name: N8nPackage
    description: Beta — breaking changes may still occur without major version bump.
  - name: NodeTypePolicy
    description: Preview — breaking changes may still occur without major version bump.
  - name: Projects
    description: Operations about projects
  - name: Promotions
    description: Operations about promotion providers, environments, and package operations
  - name: Role
    description: Operations about roles
  - name: RoleMappingRule
    description: Operations about identity-provider role-mapping rules
  - name: SecurityPolicy
    description: Operations about the instance security policy settings
  - name: SettingsLdap
    description: Operations about LDAP settings
  - name: SettingsOtel
    description: Operations about OpenTelemetry settings
  - name: SettingsSsoOidc
    description: Operations about OIDC SSO settings
  - name: SettingsSsoSaml
    description: Operations about SAML SSO settings
  - name: SourceControl
    description: Operations about source control
  - name: Tags
    description: Operations about tags
  - name: User
    description: Operations about users
  - name: Variables
    description: Operations about variables
  - name: Workflow
    description: Operations about workflows

# Paths and components are generated from @PublicApiController routes. See openapi-gen/generate.ts.
paths: {}
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-N8N-API-KEY
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    CookieAuth:
      type: apiKey
      in: cookie
      # Must match AUTH_COOKIE_NAME in packages/cli/src/constants.ts
      name: n8n-auth

security:
  - ApiKeyAuth: []
  - BearerAuth: []
  - CookieAuth: []