Actions243
- Cable Actions
- Cable Termination Actions
- Connected Device Actions
- Console Port Actions
- Console Port Template Actions
- Console Server Port Actions
- Console Server Port Template Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Front Port Actions
- Front Port Template Actions
- Interface Actions
- Interface Template Actions
- Inventory Item Actions
- Inventory Item Role Actions
- Inventory Item Template Actions
- Location Actions
- MAC Address Actions
- Manufacturer Actions
- Module Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Module Type Profile Actions
- Platform Actions
- Power Feed Actions
- Power Outlet Actions
- Power Outlet Template Actions
- Power Panel Actions
- Power Port Actions
- Power Port Template Actions
- Rack Actions
- Rack Reservation Actions
- Rack Role Actions
- Rack Type Actions
- Rear Port Actions
- Rear Port Template Actions
- Region Actions
- Site Actions
- Site Group Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
- Virtual Link Actions
Site → Update
AI-generatedOverview
This node updates a Site resource in the NetBox API within the DCIM domain. It is useful for automating the modification of site details such as name, slug, status, region, tenant, contact information, GPS coordinates, and custom fields. For example, it can be used to update the status of a site from 'planned' to 'active' or to change the contact details for a site automatically based on external data.
Use Case Examples
- Updating the status and contact information of a site in NetBox.
- Modifying the GPS coordinates and description of a site for accurate location tracking.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to interact with, here it is 'dcim' for data center infrastructure management. |
| Site ID | The unique identifier of the site to update. |
| Update Fields | A collection of fields to update on the site, including name, slug, status, region ID, site group ID, tenant ID, facility, ASN, time zone, description, physical address, shipping address, latitude, longitude, contact name, contact phone, contact email, comments, tags, and custom fields. |
Output
JSON
id- ID of the updated site recordname- Name of the updated siteslug- URL-friendly slug of the updated sitestatus- Status of the updated siteregion- Region ID of the updated sitegroup- Site group ID of the updated sitetenant- Tenant ID associated with the updated sitefacility- Facility code or ID of the updated siteasn- Autonomous System Number of the updated sitetime_zone- Time zone of the updated sitedescription- Description of the updated sitephysical_address- Physical address of the updated siteshipping_address- Shipping address of the updated sitelatitude- Latitude GPS coordinate of the updated sitelongitude- Longitude GPS coordinate of the updated sitecontact_name- Contact person's name for the updated sitecontact_phone- Contact person's phone number for the updated sitecontact_email- Contact person's email for the updated sitecomments- Additional comments for the updated sitetags- Tags associated with the updated sitecustom_fields- Custom JSON fields for the updated site
Dependencies
- NetBox API with appropriate credentials
Troubleshooting
- Common issues include providing an invalid Site ID or missing required fields in the update collection, which may result in API errors.
- Errors related to authentication can occur if the API credentials are incorrect or missing.
- If the update fields contain invalid data types or values not accepted by NetBox, the API will return validation errors.
Links
- NetBox API Documentation - Official documentation for the NetBox API endpoints and data models.