NetBox icon

NetBox

Consume NetBox API

Actions243

Location → Update

AI-generated

Overview

This node updates a Location resource in the NetBox API within the DCIM domain. It is useful for scenarios where you need to modify details of an existing location, such as changing its name, status, parent location, or other attributes. For example, updating the description or tags of a data center location to reflect current information.

Use Case Examples

  1. Updating the name and status of a location in a data center management system.
  2. Modifying the parent location ID to reorganize location hierarchy.
  3. Adding or changing custom fields or tags for a specific location.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is 'dcim' for data center infrastructure management.
Location ID The unique identifier of the location to update.
Update Fields A collection of fields to update on the location, such as site ID, name, slug, parent ID, status, tenant ID, facility, description, tags, and custom fields.

Output

JSON

  • id - The unique identifier of the updated location.
  • name - The name of the updated location.
  • status - The operational status of the updated location.
  • description - Description of the updated location.
  • tags - Tags associated with the updated location.
  • custom_fields - Custom fields of the updated location.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the Location ID is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential has sufficient permissions to update location resources.
  • Check that the update fields are valid and conform to expected data types to prevent validation errors.
  • If the node throws an error, enabling 'Continue on Fail' allows the workflow to proceed and outputs the error message for debugging.

Links

  • NetBox API Documentation - Official documentation for the NetBox API, useful for understanding resource fields and operations.

Discussion