Actions88
- Module Actions
- Platform Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Interface Actions
- Manufacturer Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Region Actions
- Site Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
Overview
This node integrates with the NetBox API, specifically allowing users to create a new Site resource within the DCIM domain. It is useful for network engineers and IT administrators who want to automate the management of physical sites in their infrastructure directly from n8n workflows. For example, when provisioning new data centers or office locations, this node can programmatically add site details such as name, status, location coordinates, contact information, and custom metadata.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to interact with. For creating a Site, this should be set to "DCIM". |
| Name | The name of the site to create. |
| Status | The operational status of the site. Options: Active, Planned, Staging, Decommissioning, Retired. |
| Additional Fields | A collection of optional fields to provide more detailed information about the site: |
| - Slug | URL-friendly slug for the site; if left blank, it will be generated automatically. |
| - Region ID | Numeric ID of the region the site belongs to. |
| - Site Group ID | Numeric ID of the site group. |
| - Tenant Name or ID | Tenant identifier (name, slug, or numeric ID) associated with the site; resolved automatically. |
| - Facility | Facility code or ID string. |
| - ASN | Autonomous System Number associated with the site. |
| - Time Zone | Time zone string, e.g., "America/New_York". |
| - Description | Text description of the site. |
| - Physical Address | Physical address of the site. |
| - Shipping Address | Shipping address of the site. |
| - Latitude | GPS latitude coordinate (decimal). |
| - Longitude | GPS longitude coordinate (decimal). |
| - Contact Name | Name of the contact person for the site. |
| - Contact Phone | Phone number of the contact person. |
| - Contact Email | Email address of the contact person. |
| - Comments | Additional comments about the site. |
| - Tags | Comma-separated list of tags for categorization. |
| - Custom Fields | JSON object containing any custom fields defined for the site. |
Output
The node outputs the JSON response returned by the NetBox API after creating the site. This typically includes all the details of the newly created site resource, such as its unique ID, timestamps, and all provided properties. There is no binary output.
Dependencies
- Requires an active connection to a NetBox instance via an API key credential configured in n8n.
- The node depends on the NetBox API being accessible and properly authenticated.
- No additional external dependencies beyond the NetBox API and the included helper function for executing operations.
Troubleshooting
Common issues:
- Authentication failures due to invalid or missing API credentials.
- Validation errors if required fields like site name are missing or if field values do not conform to expected formats.
- Network connectivity problems preventing access to the NetBox API endpoint.
Error messages:
- Errors thrown by the node will include the message from the NetBox API or internal execution errors.
- If "Continue on Fail" is enabled, errors will be returned as part of the output JSON under an
errorproperty instead of stopping workflow execution.
Resolutions:
- Verify API credentials and permissions.
- Ensure all required input fields are correctly filled.
- Check network connectivity and API endpoint URL.
- Use the error message details to adjust inputs or fix configuration issues.