hudu_* — Hudu IT Documentation
The Hudu tool namespace — IT documentation CRUD scoped by company, archive/unarchive semantics, and the special integration lookup.
Hudu is the IT documentation platform — companies, assets, articles, passwords,
and the relationships between them. The tools are entity-typed CRUD with two
Hudu-specific wrinkles: most operations scope to a company_id, and
“delete” on a record is usually an archive, handled through hudu_update.
Reading
hudu_get
Get or list records by entity type, with rich filtering.
hudu_get(entity_type, id=None, name=None, company_id=None,
integration_id=None, data=None, page=1, page_size=25)
| Param | Notes |
|---|---|
entity_type | Required — company, asset, article, etc. |
id | Fetch a single record |
name | Filter by name |
company_id | Scope to one company — the usual way to narrow assets/articles |
integration_id | Cross-reference an external integration’s identifier |
hudu_search
Free-text search across Hudu entities.
hudu_search(query)
hudu_lookup
A special lookup keyed by lookup_type — used for integration-bridge resolution
(mapping an external system’s identifier to a Hudu resource and back).
hudu_lookup(lookup_type, company_id=None, integration_id=None,
integration_slug=None, integration_identifier=None,
resource_type=None, resource_id=None, user_id=None, page=1)
lookup_type is required; supply whichever identifier fields the lookup needs.
This is the tool to reach for when correlating a Hudu asset with its record in
another system rather than browsing by name.
Writing
hudu_create
hudu_create(entity_type, name, company_id=None, data=None)
name is required; data carries the rest of the record. Scope to a company
with company_id for company-owned entities.
hudu_update
Update and archive/unarchive flow through this one tool via action.
hudu_update(entity_type, id, action="update", company_id=None, data=None)
action | Effect |
|---|---|
"update" | Apply the fields in data (default) |
"archive" | Archive the record (the usual “soft delete”) |
"unarchive" | Restore an archived record |
Prefer action="archive" over a hard hudu_delete for anything you might want
back — Hudu documentation is reference material, and archiving is reversible.
hudu_delete
Hard delete by ID. Irreversible — see the archive note above before using it.
hudu_delete(entity_type, id)
Related pages
- Hudu Documentation Workflows — the conventions around these tools
- cwa — the RMM whose managed assets are documented here
- Tools — catalog overview and routing rules
- Service Map — where Hudu sits among the IT systems