What you are making
An n8n API credential lets one workflow ask the n8n API to read or change workflows. This is powerful access, so treat it like an admin key—not a normal app password.
Create the API key
- In n8n, open Settings → n8n API.
- Select Create an API key.
- Give it a clear label and an expiry date.
- If your n8n plan offers scopes, grant only the workflow permissions the automation needs.
- Copy the key once and store it directly in an n8n credential.
The n8n API is not available during the n8n Cloud free trial.
Connect the n8n node
Create an n8n API credential. Paste the key and use the API base URL for your instance:
- n8n Cloud:
https://YOUR-NAME.app.n8n.cloud/api/v1 - Self-hosted:
https://YOUR-N8N-DOMAIN/api/v1
Use the n8n node’s Get workflow operation first. Select a harmless test workflow and confirm the node can read its name, nodes, connections, and settings.
Treat workflow updates as dangerous
An Update workflow operation can replace the saved canvas. A malformed payload can disconnect nodes, remove settings, or break an active workflow.
- Keep a manual export before the first update test.
- Test on an inactive copy.
- Preserve the workflow name, nodes, connections, and settings.
- Never let an unsigned public webhook reach an Update workflow node.
- Prefer an expiring, narrowly scoped key when your plan supports it.
Verify and rotate
After a test update, reopen the workflow in n8n and compare the canvas. Confirm that credentials still point to the intended nodes and that the workflow remains inactive until you deliberately publish it.
Delete and replace the API key when the automation changes owner, the key appears in logs or screenshots, or the self-management feature is removed.
Official references: n8n API authentication and the n8n node.