NetBox icon

NetBox

Consume NetBox API

Actions243

Platform → Delete

AI-generated

Overview

This node interacts with the NetBox API to delete a platform record within the specified domain. It is useful for automating the removal of platform entries in NetBox, such as when cleaning up outdated or incorrect platform data in the DCIM domain.

Use Case Examples

  1. Deleting a platform by its ID in the DCIM domain to maintain an up-to-date inventory of device platforms.
  2. Automating platform record cleanup in NetBox as part of a larger infrastructure management workflow.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to target, e.g., DCIM, IPAM, Tenancy, etc.
Platform ID The unique identifier of the platform record to delete within the DCIM domain.

Output

JSON

  • success - Indicates whether the platform deletion was successful.
  • message - Additional information or confirmation message about the deletion operation.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the Platform ID provided is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API credentials have sufficient permissions to delete platform records.
  • Check network connectivity to the NetBox API endpoint.
  • If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message as JSON.

Discussion