n8n 2.15.1 → 2.17.0

package/dist/public-api/v1/openapi.yml

@@ -13,6 +13,7 @@ servers:
   - url: /api/v1
 security:
   - ApiKeyAuth: []
+  - BearerAuth: []
 tags:
   - name: User
     description: Operations about users
@@ -34,8 +35,12 @@ tags:
     description: Operations about data tables and their rows
   - name: Projects
     description: Operations about projects
+  - name: CommunityPackage
+    description: Operations about community packages
   - name: Discover
     description: API capability discovery
+  - name: Insights
+    description: Operations about insights
 externalDocs:
   description: n8n API documentation
   url: https://docs.n8n.io/api/
@@ -117,7 +122,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/credential'
+              $ref: '#/components/schemas/credentialCreate'
       responses:
         '200':
           description: Operation successful.
@@ -126,9 +131,13 @@ paths:
               schema:
                 $ref: '#/components/schemas/create-credential-response'
         '400':
-          description: Bad request - invalid credential type or data.
+          $ref: '#/components/responses/badRequest'
         '401':
           $ref: '#/components/responses/unauthorized'
+        '403':
+          $ref: '#/components/responses/forbidden'
+        '404':
+          $ref: '#/components/responses/notFound'
         '415':
           description: Unsupported media type.
   /credentials/{id}:
@@ -285,6 +294,7 @@ paths:
       description: Retrieve all executions from your instance.
       parameters:
         - $ref: '#/components/parameters/includeData'
+        - $ref: '#/components/parameters/redactExecutionData'
         - name: status
           in: query
           description: Status to filter the executions by.
@@ -326,6 +336,8 @@ paths:
                 $ref: '#/components/schemas/executionList'
         '401':
           $ref: '#/components/responses/unauthorized'
+        '403':
+          $ref: '#/components/responses/forbidden'
         '404':
           $ref: '#/components/responses/notFound'
   /executions/{id}:
@@ -339,6 +351,7 @@ paths:
       parameters:
         - $ref: '#/components/parameters/executionId'
         - $ref: '#/components/parameters/includeData'
+        - $ref: '#/components/parameters/redactExecutionData'
       responses:
         '200':
           description: Operation successful.
@@ -348,6 +361,8 @@ paths:
                 $ref: '#/components/schemas/execution'
         '401':
           $ref: '#/components/responses/unauthorized'
+        '403':
+          $ref: '#/components/responses/forbidden'
         '404':
           $ref: '#/components/responses/notFound'
     delete:
@@ -668,7 +683,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/workflow'
+              $ref: '#/components/schemas/workflowCreate'
         required: true
       responses:
         '200':
@@ -681,6 +696,10 @@ paths:
           $ref: '#/components/responses/badRequest'
         '401':
           $ref: '#/components/responses/unauthorized'
+        '403':
+          $ref: '#/components/responses/forbidden'
+        '404':
+          $ref: '#/components/responses/notFound'
     get:
       x-eov-operation-id: getWorkflows
       x-eov-operation-handler: v1/handlers/workflows/workflows.handler
@@ -1967,6 +1986,118 @@ paths:
           $ref: '#/components/responses/forbidden'
         '404':
           $ref: '#/components/responses/notFound'
+  /community-packages:
+    post:
+      x-eov-operation-id: installPackage
+      x-eov-operation-handler: v1/handlers/community-packages/community-packages.handler
+      tags:
+        - CommunityPackage
+      summary: Install a community package
+      description: Install a community package by npm name and optional version.
+      requestBody:
+        description: Package to install.
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/installCommunityPackageRequest'
+      responses:
+        '200':
+          description: Package installed successfully.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/communityPackage'
+        '400':
+          $ref: '#/components/responses/badRequest'
+        '401':
+          $ref: '#/components/responses/unauthorized'
+      security:
+        - ApiKeyAuth: []
+    get:
+      x-eov-operation-id: getInstalledPackages
+      x-eov-operation-handler: v1/handlers/community-packages/community-packages.handler
+      tags:
+        - CommunityPackage
+      summary: List installed community packages
+      description: Retrieve all installed community packages with pending update info.
+      responses:
+        '200':
+          description: Operation successful.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/communityPackageList'
+        '401':
+          $ref: '#/components/responses/unauthorized'
+      security:
+        - ApiKeyAuth: []
+  /community-packages/{name}:
+    patch:
+      x-eov-operation-id: updatePackage
+      x-eov-operation-handler: v1/handlers/community-packages/community-packages.handler
+      tags:
+        - CommunityPackage
+      summary: Update a community package
+      description: Update an installed community package to a new version.
+      parameters:
+        - name: name
+          in: path
+          description: npm package name
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: Update options.
+        required: false
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                version:
+                  type: string
+                  description: Specific semver version to update to
+      responses:
+        '200':
+          description: Package updated successfully.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/communityPackage'
+        '400':
+          $ref: '#/components/responses/badRequest'
+        '401':
+          $ref: '#/components/responses/unauthorized'
+        '404':
+          $ref: '#/components/responses/notFound'
+      security:
+        - ApiKeyAuth: []
+    delete:
+      x-eov-operation-id: uninstallPackage
+      x-eov-operation-handler: v1/handlers/community-packages/community-packages.handler
+      tags:
+        - CommunityPackage
+      summary: Uninstall a community package
+      description: Uninstall a community package by name.
+      parameters:
+        - name: name
+          in: path
+          description: npm package name
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: Package uninstalled successfully.
+        '400':
+          $ref: '#/components/responses/badRequest'
+        '401':
+          $ref: '#/components/responses/unauthorized'
+        '404':
+          $ref: '#/components/responses/notFound'
+      security:
+        - ApiKeyAuth: []
   /discover:
     get:
       x-eov-operation-id: getDiscover
@@ -2058,6 +2189,49 @@ paths:
                         description: URL to the full OpenAPI specification
         '401':
           $ref: '#/components/responses/unauthorized'
+  /insights/summary:
+    get:
+      x-eov-operation-id: getInsightsSummary
+      x-eov-operation-handler: v1/handlers/insights/insights.handler
+      tags:
+        - Insights
+      summary: Retrieve insights summary
+      description: Retrieve the insights summary for the selected date range.
+      parameters:
+        - name: startDate
+          in: query
+          required: false
+          description: ISO 8601 start date. Defaults to 7 days ago.
+          schema:
+            type: string
+            format: date-time
+        - name: endDate
+          in: query
+          required: false
+          description: ISO 8601 end date. Defaults to now.
+          schema:
+            type: string
+            format: date-time
+        - name: projectId
+          in: query
+          required: false
+          description: Project identifier to filter insights by project.
+          schema:
+            type: string
+            example: VmwOO9HeTEj20kxM
+      responses:
+        '200':
+          description: Operation successful.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/insights'
+        '400':
+          $ref: '#/components/responses/badRequest'
+        '401':
+          $ref: '#/components/responses/unauthorized'
+        '403':
+          $ref: '#/components/responses/forbidden'
 components:
   schemas:
     audit:
@@ -2138,6 +2312,10 @@ components:
         - id
         - name
         - type
+        - isManaged
+        - isGlobal
+        - isResolvable
+        - resolvableAllowFallback
         - createdAt
         - updatedAt
       type: object
@@ -2152,6 +2330,32 @@ components:
         type:
           type: string
           example: githubApi
+        isManaged:
+          type: boolean
+          readOnly: true
+          description: Whether the credential is managed by n8n (managed credentials cannot be edited via the API).
+          example: false
+        isGlobal:
+          type: boolean
+          readOnly: true
+          description: Whether the credential is available for use by all users.
+          example: false
+        isResolvable:
+          type: boolean
+          readOnly: true
+          description: Whether the credential can be dynamically resolved by a resolver.
+          example: false
+        resolvableAllowFallback:
+          type: boolean
+          readOnly: true
+          description: Whether the credential resolver may fall back to static credentials if dynamic resolution fails.
+          example: false
+        resolverId:
+          type: string
+          nullable: true
+          readOnly: true
+          description: ID of the dynamic credential resolver associated with this credential, if any.
+          example: null
         createdAt:
           type: string
           format: date-time
@@ -2212,6 +2416,46 @@ components:
           description: Paginate through credentials by setting the cursor parameter to a nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection.
           nullable: true
           example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA
+    credentialCreate:
+      required:
+        - name
+        - type
+        - data
+      type: object
+      properties:
+        id:
+          type: string
+          readOnly: true
+          example: R2DjclaysHbqn778
+        name:
+          type: string
+          example: Joe's Github Credentials
+        type:
+          type: string
+          example: githubApi
+        data:
+          type: object
+          writeOnly: true
+          example:
+            accessToken: ada612vad6fa5df4adf5a5dsf4389adsf76da7s
+        isResolvable:
+          type: boolean
+          example: false
+          description: Whether this credential has resolvable fields
+        createdAt:
+          type: string
+          format: date-time
+          readOnly: true
+          example: '2022-04-29T11:02:29.842Z'
+        updatedAt:
+          type: string
+          format: date-time
+          readOnly: true
+          example: '2022-04-29T11:02:29.842Z'
+        projectId:
+          type: string
+          description: Project to create the credential in. Defaults to the user's personal project.
+          example: VmwOO9HeTEj20kxM
     credential:
       required:
         - name
@@ -2286,6 +2530,24 @@ components:
           example: 1000
         data:
           type: object
+          additionalProperties: true
+          description: |
+            Detailed execution data. Only included when `includeData` is `true`.
+          properties:
+            redactionInfo:
+              type: object
+              nullable: true
+              description: Present when execution data has been redacted.
+              properties:
+                isRedacted:
+                  type: boolean
+                  description: Whether the execution data was redacted.
+                reason:
+                  type: string
+                  description: The reason for redaction.
+                canReveal:
+                  type: boolean
+                  description: Whether the current user has permission to reveal the redacted data.
         finished:
           type: boolean
           example: true
@@ -2507,9 +2769,9 @@ components:
             - none
             - workflowsFromAList
             - workflowsFromSameOwner
-          default: workflowsFromSameOwner
           description: |
             Controls which workflows are allowed to call this workflow using the Execute Workflow node.
+            Defaults to workflowsFromSameOwner.
 
             Available options:
             - `any`: Any workflow can call this workflow (no restrictions)
@@ -2530,9 +2792,9 @@ components:
           description: Estimated time saved per execution in minutes
         availableInMCP:
           type: boolean
-          default: false
           description: |
             Controls whether this workflow is accessible via the Model Context Protocol (MCP).
+            Defaults to false.
 
             When enabled, this workflow can be called by MCP clients (AI assistants and other tools
             that support MCP). This allows external AI tools to discover and execute this workflow
@@ -2637,6 +2899,10 @@ components:
         name:
           type: string
           example: Workflow 1
+        description:
+          type: string
+          description: Description of the workflow
+          example: My workflow description
         active:
           type: boolean
           readOnly: true
@@ -2723,6 +2989,100 @@ components:
           description: Paginate through workflows by setting the cursor parameter to a nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection.
           nullable: true
           example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA
+    workflowCreate:
+      type: object
+      additionalProperties: false
+      required:
+        - name
+        - nodes
+        - connections
+        - settings
+      properties:
+        id:
+          type: string
+          readOnly: true
+          example: 2tUt1wbLX592XDdX
+        name:
+          type: string
+          example: Workflow 1
+        active:
+          type: boolean
+          readOnly: true
+        createdAt:
+          type: string
+          format: date-time
+          readOnly: true
+        updatedAt:
+          type: string
+          format: date-time
+          readOnly: true
+        isArchived:
+          type: boolean
+          readOnly: true
+        versionId:
+          type: string
+          readOnly: true
+          description: Current version identifier used for optimistic locking
+        triggerCount:
+          type: integer
+          readOnly: true
+          description: Number of active trigger nodes in the workflow
+        nodes:
+          type: array
+          items:
+            $ref: '#/components/schemas/node'
+        connections:
+          type: object
+          example:
+            Jira:
+              main:
+                - - node: Jira
+                    type: main
+                    index: 0
+        settings:
+          $ref: '#/components/schemas/workflowSettings'
+        staticData:
+          example:
+            lastId: 1
+          anyOf:
+            - type: string
+              format: jsonString
+              nullable: true
+            - type: object
+              nullable: true
+        pinData:
+          type: object
+          nullable: true
+          description: Pinned sample data for nodes, keyed by node name
+        projectId:
+          type: string
+          description: Target project to create the workflow in. Defaults to the user's personal project.
+          example: VmwOO9HeTEj20kxM
+        meta:
+          type: object
+          nullable: true
+          readOnly: true
+          description: Workflow metadata such as template information
+          properties:
+            onboardingId:
+              type: string
+            templateId:
+              type: string
+            instanceId:
+              type: string
+            templateCredsSetupCompleted:
+              type: boolean
+        tags:
+          type: array
+          items:
+            $ref: '#/components/schemas/tag'
+          readOnly: true
+        shared:
+          type: array
+          items:
+            $ref: '#/components/schemas/sharedWorkflow'
+        activeVersion:
+          $ref: '#/components/schemas/activeVersion'
     workflowVersion:
       type: object
       additionalProperties: false
@@ -3319,6 +3679,153 @@ components:
           description: Paginate through project members by setting the cursor parameter to the nextCursor attribute returned by a previous request. Default value fetches the first page of the collection.
           nullable: true
           example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA
+    communityPackage:
+      type: object
+      properties:
+        packageName:
+          type: string
+          description: npm package name
+        installedVersion:
+          type: string
+          description: Currently installed version
+        authorName:
+          type: string
+          description: Package author name
+        authorEmail:
+          type: string
+          description: Package author email
+        installedNodes:
+          type: array
+          description: Nodes included in this package
+          items:
+            type: object
+            properties:
+              name:
+                type: string
+              type:
+                type: string
+              latestVersion:
+                type: number
+        createdAt:
+          type: string
+          format: date-time
+        updatedAt:
+          type: string
+          format: date-time
+        updateAvailable:
+          type: string
+          description: Version available for update, if any
+        failedLoading:
+          type: boolean
+          description: Whether the package failed to load
+    communityPackageList:
+      type: array
+      items:
+        $ref: '#/components/schemas/communityPackage'
+    installCommunityPackageRequest:
+      type: object
+      required:
+        - name
+      properties:
+        name:
+          type: string
+          description: npm package name (must start with n8n-nodes-)
+        version:
+          type: string
+          description: Specific semver version to install
+        verify:
+          type: boolean
+          description: |
+            Whether to verify the package against the n8n-vetted package list. Required when the instance has N8N_UNVERIFIED_PACKAGES_ENABLED=false.
+    insights:
+      type: object
+      required:
+        - total
+        - failed
+        - failureRate
+        - timeSaved
+        - averageRunTime
+      properties:
+        total:
+          type: object
+          required:
+            - value
+            - deviation
+            - unit
+          properties:
+            value:
+              type: number
+            deviation:
+              type: number
+              nullable: true
+            unit:
+              type: string
+              enum:
+                - count
+        failed:
+          type: object
+          required:
+            - value
+            - deviation
+            - unit
+          properties:
+            value:
+              type: number
+            deviation:
+              type: number
+              nullable: true
+            unit:
+              type: string
+              enum:
+                - count
+        failureRate:
+          type: object
+          required:
+            - value
+            - deviation
+            - unit
+          properties:
+            value:
+              type: number
+            deviation:
+              type: number
+              nullable: true
+            unit:
+              type: string
+              enum:
+                - ratio
+        timeSaved:
+          type: object
+          required:
+            - value
+            - deviation
+            - unit
+          properties:
+            value:
+              type: number
+            deviation:
+              type: number
+              nullable: true
+            unit:
+              type: string
+              enum:
+                - minute
+        averageRunTime:
+          type: object
+          required:
+            - value
+            - deviation
+            - unit
+          properties:
+            value:
+              type: number
+            deviation:
+              type: number
+              nullable: true
+            unit:
+              type: string
+              enum:
+                - millisecond
     error:
       required:
         - message
@@ -3410,14 +3917,14 @@ components:
   responses:
     unauthorized:
       description: Unauthorized
-    notFound:
-      description: The specified resource was not found.
     badRequest:
       description: The request is invalid or provides malformed data.
-    conflict:
-      description: Conflict
     forbidden:
       description: Forbidden
+    notFound:
+      description: The specified resource was not found.
+    conflict:
+      description: Conflict
     NotFound:
       $ref: '#/components/responses/notFound'
     Unauthorized:
@@ -3461,6 +3968,14 @@ components:
       required: false
       schema:
         type: boolean
+    redactExecutionData:
+      name: redactExecutionData
+      in: query
+      description: |
+        Controls execution data redaction. When `true`, execution output data is always redacted. When `false`, requests unredacted (revealed) data — requires the `execution:reveal` scope. When omitted, follows the workflow redaction policy.
+      required: false
+      schema:
+        type: boolean
     executionId:
       name: id
       in: path
@@ -3526,6 +4041,8 @@ components:
       $ref: '#/components/parameters/tagId'
     IncludeData:
       $ref: '#/components/parameters/includeData'
+    RedactExecutionData:
+      $ref: '#/components/parameters/redactExecutionData'
     UserIdentifier:
       $ref: '#/components/parameters/userIdentifier'
     IncludeRole:
@@ -3537,3 +4054,7 @@ components:
       type: apiKey
       in: header
       name: X-N8N-API-KEY
+    BearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT

package/dist/public-api/v1/public-api-error-response.d.ts

@@ -0,0 +1,2 @@
+import type { Response } from 'express';
+export declare function sendPublicApiErrorResponse(res: Response, error: Error): void;