OpenAPI Specification
openapi: 3.0.0
info:
title: n8n Public Audit CommunityPackage API
description: The n8n public REST API provides programmatic access to n8n instance resources including workflows, executions, credentials, users, tags, variables, projects, source control, audit, data tables, community packages, folders, and insights.
termsOfService: https://n8n.io/legal/#terms
contact:
name: n8n
url: https://n8n.io/
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: https://app.n8n.cloud/api/v1
description: n8n Cloud
- url: '{baseUrl}/api/v1'
description: Self-hosted n8n
variables:
baseUrl:
default: http://localhost:5678
security:
- ApiKeyAuth: []
- BearerAuth: []
tags:
- name: CommunityPackage
description: Operations about community packages
paths:
/community-packages:
get:
tags:
- CommunityPackage
summary: List installed community packages
operationId: listCommunityPackages
responses:
'200':
description: Operation successful.
post:
tags:
- CommunityPackage
summary: Install a community package
operationId: installCommunityPackage
responses:
'201':
description: Installed
/community-packages/{name}:
delete:
tags:
- CommunityPackage
summary: Uninstall a community package
operationId: uninstallCommunityPackage
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
'204':
description: Uninstalled
patch:
tags:
- CommunityPackage
summary: Update a community package
operationId: updateCommunityPackage
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
'200':
description: Operation successful.
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-N8N-API-KEY
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
externalDocs:
description: n8n API documentation
url: https://docs.n8n.io/api/