The Hudu admin area is accessible ONLY to admins and super admin users within your organization.
Hudu supports a RESTful API. You can use this API to automate your documentation processes and to customize Hudu assets, articles, and more via programmatic access.
In order to get started with the API, you must first make an API key. You can do this by going to the Hudu admin area → Account Administration → API Keys and selecting + New API Key.
You must first give the key a name before creating it. API key names must be unique, so choose a name that isn't already used by another key. A descriptive name, such as the script or tool that uses the key, also makes the key's activity easy to identify in your activity logs.
You have the option to allow access to Passwords, the option to prevent destructive actions, the option to allow export permissions, and the option to set allowed IP addresses.
Be sure to copy the key to a secure location, as the key is hidden after 5 minutes.
API keys for partner-built integrations, such as CyberQP, are created and deleted from the integration itself in Admin → Integrations. Each integration can have one API key, and the key is named automatically.
The documentation for our REST API can be found in your Hudu instance in the Hudu admin area → Account Administration → API Keys → View the API Documentation.
Authentication
All requests to the API must be authenticated with an API key. You can obtain an API key by going to the Hudu admin area → Account Administration → API Keys.
You will then send requests including the header to the API like so:
curl https://[YOUR_DOMAIN]/api/v1/companies?page=1 -H "x-api-key: YOUR_API_KEY_HERE"Click Authorize to authorize your API key and send requests directly from the API Documentation page. You will need to re-authorize your API key every time you leave the Documentation page.
You can create and delete an API key at any time.
Scoping API Keys
API keys are configurable in multiple aspects:
- Ability to access passwords (all REST actions, including creating password sharing links)
- Ability to perform destructive actions (DELETE actions)
- Ability to export (export permissions)
- Allowed IP addresses (enter one IP address per line)
- Ability to specify company scopes
- Ability to scope to Magic Dash use only
These can only be configured at the time of the key's creation.
We recommend being strict with these keys and allowing the least amount of access as is required for the application.
Company-scoped keys can only access data that belongs to their scoped company. As of version 2.48, company-scoped keys can also read asset layouts and create or delete relations between records within their scoped company.
Visit IP Access Control for additional information on restricting access by IP address.
Format
All requests to the API must be in JSON format unless otherwise specified.
Names in the API
Names in the API might differ from what you have in your Hudu application.
| Name in Hudu | Name in API |
| Company (but can be customizable) | Company |
| Password | Asset Password |
| Knowledge Base Article | Article |
| Process | Procedure |
Pagination
By default, requests to the API are paginated. Pagination is simple. Add ?page=X to your requests, and it will send you the next page of results. Pagination is in sets of 25 results.
Rate Limiting
The rate limit is set at 300 requests per minute.