i-doit icon

i-doit

i-doit JSON-RPC API

Actions7

Purge

AI-generated

Overview

The i-doit n8n node provides integration with the i-doit JSON-RPC API, enabling users to manage and interact with Configuration Management Database (CMDB) resources.
For the Default resource and Purge operation, this node allows you to permanently delete a record from the i-doit database, either at the object or category entry level.

Common scenarios:

  • Irreversibly removing obsolete or sensitive CMDB objects or category entries.
  • Automating cleanup of test data or decommissioned assets in IT asset management workflows.

Practical example:
You might use this node in an automation that purges all records related to retired servers after a certain period, ensuring your CMDB remains up-to-date and compliant with data retention policies.

Properties

Name Type Meaning
Namespace options The type of resource to operate on (e.g., CMDB Object, CMDB Category).
Category options The specific category within the namespace (required for some namespaces).
Object Type options The type of object (used in some operations, not required for Purge).
Id string The unique identifier of the resource to purge.
Category entry Id string The identifier of the category entry to purge (required when purging a category entry).
Search String string Not used for Purge operation.
Retrieve and Split Data Items boolean Not used for Purge operation.

Notes:

  • For Namespace = cmdb.object, only the Id is required.
  • For Namespace = cmdb.category, both Id (object id), Category, and Category entry Id are required.

Output

  • The node outputs a single item per input, with the result of the purge operation in the json field.
  • The structure of the json output depends on the i-doit API response, but typically includes confirmation of deletion or error details.
  • Example output:
{
  "result": {
    // ... API-specific fields confirming purge
  },
  "id": 1,
  "jsonrpc": "2.0"
}
  • If an error occurs and "Continue On Fail" is enabled, the output will include:
{
  "error": "Error message from API"
}

Dependencies

  • External Service: Requires access to an i-doit instance with JSON-RPC API enabled.
  • API Key: You must provide valid i-doit API credentials in the n8n node's credentials section (idoit).
  • n8n Configuration: No special environment variables beyond standard credential setup.

Troubleshooting

Common issues:

  • Missing or invalid Id/Category entry Id: The node will throw an error if required identifiers are missing or incorrect.
  • Insufficient permissions: The API key provided must have rights to perform purge operations; otherwise, the API may return an authorization error.
  • Irrecoverable action: Purge is permanent. Ensure you are targeting the correct records.

Common error messages:

  • "Invalid object ID": Check that the Id matches an existing object.
  • "Entry identifier required": For category purges, ensure Category entry Id is provided.
  • "Permission denied": Verify API key permissions in i-doit.
  • "Resource not found": The specified object or category entry does not exist.

Resolution steps:

  • Double-check all IDs and parameters.
  • Confirm API key has sufficient privileges.
  • Use "Continue On Fail" to capture errors without stopping workflow execution.

Links and References

Discussion