Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

iTechGuides is reader-supported. When you buy through links on our site, we may earn an affiliate commission. As an Amazon Associate I earn from qualifying purchases. Learn more

The n8n API node lets one n8n workflow manage another part of the n8n installation: it can create, read, publish, unpublish, and delete workflows; inspect or remove executions; manage credentials; and generate a security audit. To use it, create an API key in Settings > n8n API, give the node that key, and select the operation you need. Requests use the X-N8N-API-KEY header and versioned paths such as /api/v1/workflows. This guide explains the setup, supported operations, safe automation patterns, direct-HTTP alternatives, and the checks that prevent a successfully submitted request from producing an unusable workflow.

What the n8n API node actually automates

Most n8n nodes call an outside service so that a workflow can move data or trigger an action. The n8n API node is different: it calls the n8n public REST API, allowing a workflow to administer the n8n instance that runs it or another instance you are authorized to manage. You can use it for repeatable deployment, housekeeping, monitoring, and governance instead of performing the same actions manually in the editor.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

The node covers a defined set of common API operations. The public REST API itself is broader, so an operation that is not exposed by the node can still be reached with a generic HTTP client node or an external script, provided you follow the endpoint reference for your n8n version.

  • Lifecycle automation: create, retrieve, publish, unpublish, or delete workflows.
  • Execution administration: retrieve execution information and delete executions.
  • Credential administration: create, retrieve, or delete credentials.
  • Security checks: generate a security audit.

Because these actions can change an instance, treat the node as an administrative integration rather than as an ordinary data-processing step. Limit the key’s scope where your edition supports scopes, keep the key out of workflow output, and test destructive operations against a non-production instance first.

#1 Best Overall
Sale
Compressed Air Duster,130000RPM Super Power Cordless Air Duster,Rechargeable Brushless Blower,3 Gear Adjustable Blower with LED Light,Dust Remover for Computer/House/Outdoor/Car
  • Powerful Turbo Fan:CAGIWIRU Electric Air Duster have reached speed up to 130000RPM,Can efficient remove dust and debris.With LED light and Three Adjustable Speed to meet with different cleaning tasks.
  • With Attached USB C Fasting Charging cable.Charing 3 hours,Enjoy up to 240 minutes of use on the lowest setting, For third speed can use for 25mins.with four charging options to meet with your needs.
  • Wide Application:Upgraded attached 5 different nozzles,making it suitable for a variety of scenes, such as car,pet, pc, keyboards, and other electronic devices. It also serves for office and home clean duster.
  • Handy Design & Portable:Cordless air duster electric nozzle is Light weight and small size, design and comfortable to hold and space saving, convenient to carry around. You can put it in your room or inside the car without taking up space.
  • Warranty & Support: Our Electric air duster comes with 5 years warranty and 24/7 customer service. During this period, if you have any questions,pls kindly feel free to contact us.

Check availability before building anything

The n8n API node is available on n8n Cloud Starter, Pro, and Enterprise plans and on all self-hosted editions. It is not available on the n8n free trial. A workflow designed around this node therefore needs a paid Cloud plan or a self-hosted installation before it can run.

Environment API node availability Important distinction
n8n Cloud Starter Available Use the Cloud instance’s API base URL and a key created in that instance.
n8n Cloud Pro Available Use the Cloud instance’s API base URL and a key created in that instance.
n8n Cloud Enterprise Available API-key scopes are available for Enterprise keys.
Self-hosted editions Available The API playground is available only in self-hosted n8n.
Free trial Not available The node cannot be used while the account is on the free trial.

Availability of an operation can also depend on the n8n release running your instance. When the node’s operation list and the REST endpoint reference differ, use the endpoint reference generated from the OpenAPI specification for that release and verify the request in a test instance.

Free tools Windows power users keep installed

One-click scans. No signup required.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Create an n8n API key

The key authenticates requests made by the node. Create a separate key for each automation or environment when practical, so that you can revoke one integration without interrupting unrelated jobs.

  1. Sign in to the n8n instance that the workflow will administer.
  2. Open Settings > n8n API.
  3. Choose a descriptive Label, such as deployment-automation or execution-cleanup. A label helps you identify the key during rotation.
  4. Set an Expiration time. Use the shortest period that fits the automation’s maintenance cycle and record the renewal date.
  5. If the account is on Enterprise, choose the minimum required API Scopes. Consult the API Scopes reference for the available permissions; do not grant broad access when the workflow only reads executions or publishes a known workflow.
  6. Create the key and copy it immediately into the n8n credential used by the API node. Do not place it in a Set node, a plain-text expression, a repository, or a notification message.

Keys are instance-specific. A key created on one Cloud or self-hosted instance does not automatically authorize requests to another. When an automation targets multiple instances, create and manage a key for each target and make the base URL an environment-specific setting.

Configure the n8n API node

Node labels and credential-field wording can change between n8n releases, so use the current node panel as the authority for the visible field names. The underlying authentication requirement is stable: the request must carry the key in the X-N8N-API-KEY header.

Rank #2
EVEO® Screen Cleaner Spray Kit (Streak-Free) TV Screen Cleaner for Smart TV, Lcd, LEd, Oled | Computer Screen Cleaner Spray and Wipe Microfiber Cloth - TV, Monitor, Laptop, iPad, Car - 6.7oz 1 Pack
  • Screen Cleaner is Your Screen’s New Bestfriend! - EVEO is proud to present a screen cleaner that’s perfectly suited for your TV. Meet your new screen cleaner, computer screen cleaner, laptop cleaner, iPad cleaner, Macbook,tv cleaner or any other electronic device. Our screen cleaner spray and wipe along with the included plush microfiber cloth, easily removes dust, fingerprints & other smudges on the screen’s surface. Clean effectively for a streak-free screen
  • Gentle on your Screens - Our screen cleaner spray and wipes is compatible to be used even for the most sensitive LCD, LED, CRT, and OLED screens in proper use. Be at ease knowing that this product is compatible with all the major brands: LG, SONY, Samsung, Sharp, iPad, iPhone, Android screens, Kindle, PC monitors - we’ve got you covered! Can be used as LCD screen cleaner, tv cleaner, smart tv screen cleaner, and more
  • Premium Super Soft Plush Microfiber Cloth - Included in this efficient screen cleaning kit. This screen cleaner spray and wipe has our signature plush microfiber cloth specially designed to comply with screens and monitors and leave them streak-free. Has been shown to effectively absorbs stubborn stains, zero streaks, and no fiber shedding. Always use this together with our screen cleaner for the best results
  • Easy-to-Use Screen Cleaner Kit + microfiber cleaning cloth - The EVEO Screen Cleaning Kit will easily be your new favorite tool when it comes to taking care of the things you love most, quick and easy solution for a streak-free screen. Simply screw on the sprayer gun on the screen cleaner bottle. Spray the cleaning liquid onto the microfiber cloth, then wipe the screen until desired cleanliness & shine is achieved.
  • Quality Screen Care Kit Worth Purchasing - Enjoy a convenient Screen Cleaner anytime, anywhere you need it. Your satisfaction is our top priority. We stand behind the quality of our products and that’s why, you shouldn’t be worrying at all. We manufacture the Best Screen Cleaner. and can be used for laptop cleaning kit, laptop screen cleaner, tv screen cleaner for smart tv. MacBook screen cleaner, monitor cleaner or screen cleaner spray for electronic devices with microfiber cleaning cloth
  1. Create a new workflow or open the workflow that will perform the administration task.
  2. Add the built-in n8n API node from the node picker.
  3. Create or select an API credential and enter the key generated in Settings > n8n API. Save the credential with a name that identifies the target instance, not the secret itself.
  4. Choose the API resource and operation. The node documentation lists operations for security audits, credentials, executions, and workflows.
  5. Enter the target identifier or request data required by that operation. For example, a get, publish, unpublish, or delete action normally needs the target workflow or execution identifier. The exact field names and required payload fields should be checked in the node panel for your release.
  6. Connect a trigger, such as a schedule, webhook, or another workflow event, and add guards before destructive operations. A condition that confirms the target ID, environment, or status is safer than allowing arbitrary input to flow directly into delete.
  7. Run the node with a harmless read operation first. Inspect the returned item and HTTP status before enabling create, publish, unpublish, or delete actions.
  8. Save, activate, and monitor the workflow only after the test confirms that it is calling the intended instance.

Use expressions for values that legitimately vary, such as a workflow ID from a previous lookup, but keep the API key in the credential layer. If a field is not shown by the node, do not guess its name: consult the endpoint reference or use an HTTP Request node for that endpoint.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Operations exposed by the node

The documented operation groups are summarized below. A release may add, rename, or adjust fields, so treat the table as a capability map rather than a substitute for the version-specific parameter reference.

Resource or action Operations Typical automation use Risk to consider
Security audit Generate a security audit Run a scheduled check and route findings to an internal review queue. Audit output can reveal sensitive configuration details; restrict who can read it.
Credentials Create, get, delete Provision a credential during controlled environment setup, retrieve metadata, or remove a retired credential. Credential administration is highly privileged. Avoid logging returned secret material.
Executions Get, delete Inspect a run from a monitoring workflow or remove old execution records according to a retention policy. Deletion can remove information needed for incident analysis or compliance.
Workflows Publish, unpublish, create, delete, get Promote a tested workflow, pause it during maintenance, create an instance-specific copy, or inspect its definition. Publishing changes live behavior; deletion is irreversible unless you have a saved export.

Use versioned API paths and the correct header

The public REST API uses versioned paths. A representative workflow path is /api/v1/workflows; the complete URL combines that path with the base URL of the Cloud or self-hosted instance. Keep the version segment explicit instead of relying on an unversioned shortcut, because versioning makes upgrades easier to audit.

Every authenticated request must send the API key as X-N8N-API-KEY. If you use the n8n API node’s credential, the node should construct this header for you. If you use an HTTP Request node or an external script, add the header yourself and ensure that the secret is masked in execution data and logs.

For a self-hosted installation, confirm the public URL, reverse-proxy path, and TLS configuration before troubleshooting the node. A proxy that strips the /api/v1 path or blocks the custom header can produce an authentication or not-found error even when the key is valid. For Cloud, use the instance URL shown by your account rather than a different team’s URL.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Rank #3
BladeHawks RGB Gaming Mouse Pad Extra Large Extended 31.5x12 Inch-Black
  • 【Large size】:Measuring 800 x 300 mm/ 31. 5×12 inches, which is wider and taller than others. Large mouse pad can perfectly fit your keyboard and mouse of any size, and there is also ample space for peripherals such as phones, tablets, etc.
  • 【LED backlight mouse pad】:Blade Hawks RGB mouse pad provides 7 static modes and 7 dynamic modes will give you the options you are looking for. Power-off memory function remembers the last lighting mode you selected. The super glow fiber Chroma will give you a colorful gaming setup that you want.
  • 【Anti-slip rubber base】:Made from Natural rubber, this gaming mousepad will firmly grip your desktop, allowing you to enjoy the ultimate precision in the games you are most passionate about. It also comes with a texture that enhances this ability even further.
  • 【Smooth and waterproof surface】: Micro-textured cloth surface, for extremely precise mouse control and a smooth movement. When liquid splashes on the gaming mouse pad, it forms water droplets and slides down. Will not delay your work or gameplay.
  • 【Plug and play】: This mouse and keyboard pad is powered by USB, plug and play, no driver required. One button control light modes. Press one time to change the lighting mode, press twice to change the brightness, press and hold about 3 seconds turn ON/OFF.

Automate common administration patterns

Promote a tested workflow

A deployment workflow can receive a workflow identifier and a release approval, call the API node’s get operation to confirm the target, and then call publish. Put the approval and environment check before publish; do not allow a webhook parameter alone to decide which production workflow becomes active. Capture the API response and notify the release channel with the identifier and resulting status, while omitting credential values or full sensitive definitions.

Pause and resume during maintenance

Use unpublish before a planned migration or maintenance window, then publish after a health check succeeds. Store the original target ID and maintenance ticket in the execution data so that a retry cannot accidentally act on a different workflow. A timeout or failed health check should leave the workflow unpublished and alert an operator rather than repeatedly toggling it.

Inspect and retain executions

A scheduled workflow can retrieve execution records, filter them by age or status, and send a summary to an internal dashboard. If your retention policy permits deletion, place the delete operation after an explicit age check and preserve the minimum audit record required by your organization. Test the filter on a read-only run because deleting executions removes troubleshooting context.

Run a security audit

Schedule the security-audit operation at a cadence appropriate to your change rate. Store the result in a restricted destination, compare it with the previous run, and route only the differences to responders. Do not expose the raw audit response through a public webhook or a broadly readable execution log.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Provision a controlled credential

Credential creation can be part of a tightly governed environment bootstrap, but it should not be an open self-service endpoint. Validate the requesting project, use an Enterprise scope limited to the required operation when available, and send any resulting identifier to a secure secret-management process. Delete the credential through a separate, approval-protected path when the environment is retired.

Rank #4
Sale
Vaydeer Wrist Rest for Keyboard and Mouse, Computer Ergonomic Wrist Support Pad, Soft Memory Foam Arm Cushion for Desk, Palm Hand Office Laptop Typing
  • 【Softer and More Comfortable】Vaydeer wrist rest has unique diamond pattern, which is the combination of softness and aesthetics. The materials of wrist rest are improved into higher quality memory foam and covered with silky smooth lycra. The computer wrist rest makes you as comfortable and cushiony as like rest your wrists on clouds.
  • 【Ergonomic Wrist Saver】The wrist rests for keyboard and mouse comes with a 17.32×3.15×0.83 inch keyboard wrist pad and a 5.94×3.15×0.83 inch mouse wrist support. Based on ergonomic design, the unique concave shape is the perfect fit for your wrist joints. The wrist rest pad fits most computer keyboards and laptops, improve hand and wrist posture, release your wrist and arm stress.
  • 【Non-Slip Rubber Bottom】Featuring an anti-skid silicone base on the bottom, this wrist keyboard support stays firmly in place on your desk, preventing the padding from sliding around, ensuring stable and consistent wrist support during extended computer sessions.
  • 【Better Experience & Pain Relief】Our keyboard arm rest is beneficial to alleviate the soreness caused by direct contact and friction between your arm and a hard desk surface, reducing the risk of wrist fatigue or carpal tunnel. The soft texture of memory foam can evenly distribute the pressure around your wrists and provide good support with just enough give.
  • 【Helpful in Multiple Scenarios】Whether you're working, studying, writing, typing, gaming, this keyboard and mouse rest combo is an essential accessory to add comfort and support to your hands and wrists. It’s also a great gift for men, women, family, friend, coworker, gamer, teacher, etc.

Create workflows safely through the API

The create operation is useful for templated deployments, but it is also the operation most likely to appear successful while producing an unusable result if the request body is wrong. Build the workflow definition from a known-good export or a version-controlled template that matches the n8n release. Include the complete node definitions, connections, and other fields required by that release instead of sending only a name or partial object.

  1. Start with a workflow that runs correctly in a disposable or staging instance.
  2. Retrieve or export that definition and remove environment-specific IDs, secrets, and URLs that must be supplied at deployment time.
  3. Use the API node’s create operation, or an HTTP Request node if the required endpoint is not exposed by the API node.
  4. Supply the target-specific values through credentials and environment variables rather than hard-coding them in the template.
  5. After the request returns, call get for the new workflow and inspect its node list and connections.
  6. Only publish after the verification step confirms that the expected nodes are present and the definition is appropriate for the target environment.

A community report described a workflow created through the public REST API that appeared empty even though the request succeeded. No resolution was established in that report. Treat a successful HTTP response as confirmation that the request was accepted, not proof that the workflow is usable; the post-create get-and-inspect step is essential.

When to use the API node versus a direct HTTP call

You can call the n8n public REST API from a script, CI/CD system, or any HTTP client. The built-in node is convenient when the administration task belongs inside an n8n workflow; direct HTTP is preferable when deployment must run before n8n is available or when you need an endpoint the node does not expose.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Decision point n8n API node Direct HTTP client or script
Setup effort Choose a credential and a predefined resource/operation in the editor. Construct the URL, method, headers, body, retries, and error handling yourself.
Coverage Convenient access to the documented audit, credential, execution, and workflow operations. Can reach the full public REST surface described by the endpoint reference.
Best location Inside an n8n workflow that already has a trigger, approvals, or downstream notifications. CI/CD, migration utilities, infrastructure jobs, or tooling that must run independently of n8n.
Cloud and self-hosted behavior Available on supported Cloud plans and all self-hosted editions; the node runs in the selected instance. Works from any permitted client that can reach the instance and send the API-key header.
API-key governance Uses an n8n credential; Enterprise keys can be assigned scopes. Secret storage and rotation are handled by the calling system; Enterprise scopes still apply to the key.
Interactive testing Test by executing the node in the editor. The API playground is available on self-hosted n8n only; otherwise use your HTTP tool or script.
Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Support on Ko-Fi

Pagination, endpoint discovery, and release changes

Handle large result sets

List-style API responses can be paginated. When retrieving many workflows or executions, follow the pagination fields documented for your API version instead of assuming one response contains every item. In n8n, use a loop with a stop condition based on the returned page metadata; in a script, continue requesting pages until the API reports that no more results exist. Set a sensible page size and add a delay or retry policy if the instance is under load.

Find parameters that the node does not expose

The endpoint reference is generated from the OpenAPI specification and is the authoritative place to check methods, paths, required fields, response shapes, and pagination details for your release. The self-hosted API playground can help you try calls interactively. It is not available on n8n Cloud, so Cloud users should use the endpoint reference and a non-production test workflow.

Best Value
Sale
Under Desk Cable Management Tray No Drill, Metal Mesh Cable Management Under Desk with Clamp Mount, 2 Hole Cable Tray with Wire Management and Cord Organizer for Home Office Standing Desk
  • 【No Drill Mounted】Cable management tray can be assembled in as little as 3 minutes or less-simply. Side clips easily clampe the edge of desk, pass through the holes on the sides, and secure excess cables with baskets. Desk cable management supports inward or outward installation to meet your needs in different scenarios, and provides you with great convenience when collecting and organizing wires.
  • 【Rubber Pad Protects Desk】Wire organizer under desk built-in soft rubber pads on the clamp protect your desk from scratches, so you will not damage your furniture or office.
  • 【Sturdy and Beautiful】Cord management under desk is made of high-quality carbon steel and holds about 15 lbs. The wire basket has 2 holes on each side of the tray to enable your cables to pass freely. Cable baskets are suitable for desk thickness use from 0.4" to 2.4".
  • 【Space Saving & Keep Organized】Desk cable management tray holds all your power cords, outlet strips, USB hubs and computer transformers hidden from your feet, and the data cables will not enter the vacuum cleaner to keep your desk clean and tidy. Desk wire organizer is also suitable for use in the kitchen and outdoors.
  • 【Reduce Safety Risks】Cable tray under desk keeps all plugs away from your kids, no more worry about tripping. Using 2 holes wire tray saves extra space, helps you easily cabling and wire protection. The mesh design is not easy to accumulate dust, but avoids safety accidents caused by messy wires.

Account for n8n 2.31 changes

In n8n 2.31, instance-level settings beginning with the security policy can be read and updated through the public REST API. If you automate those settings, treat them as a separate change-management stream: require approval, record the previous value, and verify the result after updating it.

The same changelog notes that workflows can be bundled into a portable .n8np package and moved between instances through the Public API or matching CLI commands. A package-based migration can be more reliable than constructing a workflow object field by field, but still validate imported nodes, connections, credentials, and environment-specific values before publishing.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Troubleshoot failed or misleading requests

“The node is missing”

  • Confirm that the account is not on the free trial.
  • Check that the instance is on a Cloud Starter, Pro, or Enterprise plan, or is self-hosted.
  • Refresh the editor after an upgrade and verify that you are working in the intended instance.

401 or 403 responses

  • Regenerate or re-copy the key if it may have expired or been revoked.
  • Confirm that the key belongs to the instance named in the node credential.
  • Check that the request sends X-N8N-API-KEY exactly and that a proxy has not removed it.
  • On Enterprise, review the key’s scopes and request only the permissions required by the operation.

404 or “not found” responses

  • Check the base URL and the versioned path, such as /api/v1/workflows.
  • Verify that the workflow or execution ID belongs to the target instance.
  • Check reverse-proxy routing on self-hosted installations, especially when n8n is served below a path prefix.

The request succeeds but the result is wrong

  • For create, immediately call get and inspect the returned node and connection data.
  • For publish or unpublish, read the workflow status after the mutation and record it.
  • For delete, confirm the target with a preceding get and require an explicit environment or approval check.
  • For list operations, implement pagination so that a valid first page is not mistaken for a complete result.

Secrets appear in execution data

Move the key into an n8n credential, redact sensitive fields in downstream notifications, restrict execution-data access, and rotate the key immediately if it has been exposed. Expiration is a control, not a substitute for least privilege and log hygiene.

A production-readiness checklist

  • The target account is on a supported plan or self-hosted edition, not the free trial.
  • The key has a clear label, an expiration date, and only the necessary Enterprise scopes.
  • The node uses a credential and the request targets the correct instance and versioned API path.
  • A read-only test has confirmed authentication before any mutation runs.
  • Create operations are followed by a get-and-inspect verification of nodes and connections.
  • Publish, unpublish, credential deletion, execution deletion, and setting updates have approval or environment guards.
  • Pagination and retry behavior are defined for list and monitoring workflows.
  • Audit output, workflow definitions, and credential responses are restricted and redacted in notifications.
  • A rotation procedure exists for expired or revoked keys, and the next expiration date is monitored.
  • The automation is retested after an n8n upgrade, especially when it depends on fields not visible in the API node.

Bottom line

Use the n8n API node when an n8n workflow needs to administer n8n itself. Set up the key in Settings > n8n API, authenticate with X-N8N-API-KEY, use versioned paths, and choose the predefined operation that matches the job. For endpoints outside the node’s list, use the OpenAPI-based endpoint reference with an HTTP client. The decisive safety practice is verification: after every create or other state-changing call, read the resulting object and confirm that the instance changed exactly as intended before publishing or proceeding.

Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.