Reference · Credentials
TheHive API credentials
Used by 2 BusyBot nodes.
theHiveApi 3 fields The TheHive credential holds an API key from your TheHive instance plus that instance's URL, since TheHive is self-hosted. The API version field matters because TheHive 3 and 4 differ enough that the wrong choice fails on real operations.
Fields
| Field | Type | Required | Notes |
|---|---|---|---|
API KeyapiKey | password | Yes | Your TheHive API key |
URLurl | string | Yes | The URL of your TheHive instance |
API VersionapiVersion | string | No | The API version |
Getting your credentials
- Sign in to your TheHive instance.
- Open the user profile or admin user management area and create an API key for the account the automation should act as.
- Copy the key into the credential’s API Key field.
- Set URL to your TheHive instance’s base URL.
- Set API Version to match your instance. If you run TheHive 5, use the separate TheHive 5 API credential instead.
Permissions and scopes
The key acts as the TheHive user it was created for, subject to that user’s organization and profile permissions. Create a dedicated automation user with a profile limited to the actions the workflow performs.
Troubleshooting
- 401 Unauthorized — the key is wrong or was revoked for that user.
- 404 or connection refused — the URL is wrong, or the instance is not reachable from the workflow environment.
- Operations failing with schema errors — the API version does not match the instance.
- 403 on a case or observable — the user’s profile does not permit that action in that organization.
Frequently asked questions
Which credential do I use for TheHive 5?
The separate TheHive 5 API credential. This one covers earlier versions, where the API version field selects between them.
Why do I need to supply a URL?
TheHive is self-hosted, so there is no fixed endpoint — the URL is how requests find your instance.
Whose permissions apply?
Those of the TheHive user the API key belongs to, including its organization and profile. Create a dedicated automation user rather than reusing an admin.
Nodes that use TheHive API
One credential works across every node below — create it once and reuse it.
Last updated . Spotted something wrong? Tell us.