For the complete documentation index, see llms.txt. This page is also available as Markdown.

Community Package

Operations about community packages

List installed community packages

get

Retrieve all installed community packages with pending update info.

Authorizations
X-N8N-API-KEYstringRequired
Responses
200

Operation successful.

application/json
packageNamestringOptional

npm package name

installedVersionstringOptional

Currently installed version

authorNamestringOptional

Package author name

authorEmailstringOptional

Package author email

createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
updateAvailablestringOptional

Version available for update, if any

failedLoadingbooleanOptional

Whether the package failed to load

get/community-packages

Install a community package

post

Install a community package by npm name and optional version.

Authorizations
X-N8N-API-KEYstringRequired
Body
namestringRequired

npm package name (must start with n8n-nodes-)

versionstringOptional

Specific semver version to install

verifybooleanOptional

Whether to verify the package against the n8n-vetted package list. Required when the instance has N8N_UNVERIFIED_PACKAGES_ENABLED=false.

Responses
200

Package installed successfully.

application/json
packageNamestringOptional

npm package name

installedVersionstringOptional

Currently installed version

authorNamestringOptional

Package author name

authorEmailstringOptional

Package author email

createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
updateAvailablestringOptional

Version available for update, if any

failedLoadingbooleanOptional

Whether the package failed to load

post/community-packages

Uninstall a community package

delete

Uninstall a community package by name.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
namestringRequired

npm package name

Responses
204

Package uninstalled successfully.

No content

delete/community-packages/{name}

No content

Update a community package

patch

Update an installed community package to a new version.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
namestringRequired

npm package name

Body
versionstringOptional

Specific semver version to update to

verifybooleanOptional

Whether to verify the package against the n8n-vetted package list. Setting to false will allow installing or updating to an unverified version. Default is true.

Responses
200

Package updated successfully.

application/json
packageNamestringOptional

npm package name

installedVersionstringOptional

Currently installed version

authorNamestringOptional

Package author name

authorEmailstringOptional

Package author email

createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
updateAvailablestringOptional

Version available for update, if any

failedLoadingbooleanOptional

Whether the package failed to load

patch/community-packages/{name}

Last updated

Was this helpful?