BusyBot

Reference · Credentials

TheHive 5 API credentials

Used by 2 BusyBot nodes.

Type theHiveProjectApi 2 fields

The TheHive 5 credential holds an API key from your TheHive 5 instance plus that instance's URL. It is deliberately separate from the credential for earlier versions, because TheHive 5's API differs enough that they cannot share one.

Fields

FieldTypeRequiredNotes
API Key
apiKey		 password Yes Your TheHive 5 API key.
URL
url		 string Yes The URL of your TheHive 5 instance.

Getting your credentials

  1. Sign in to your TheHive 5 instance.
  2. Open the user profile or admin user management area and create an API key for the account the automation should act as.
  3. Copy the key into the credential’s API Key field.
  4. Set URL to your TheHive 5 instance’s base URL.

If you run TheHive 3 or 4, use the separate TheHive API credential instead.

Permissions and scopes

The key acts as the TheHive user it belongs to, within that user’s organization and subject to its profile permissions. Create a dedicated automation user with a profile scoped 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 unreachable from the workflow environment.
  • 403 on a case or alert — the user’s profile does not permit that action, or the object belongs to a different organization.

Frequently asked questions

Why is this separate from the TheHive credential?

TheHive 5's API differs enough from earlier versions that one credential cannot serve both. Match the credential to your instance's major version.

Where is the API key created?

In the user profile or admin user management area of your own TheHive 5 instance.

Whose permissions apply?

Those of the TheHive user the key belongs to, including its organization and profile — objects in another organization stay invisible.

Nodes that use TheHive 5 API

One credential works across every node below — create it once and reuse it.

Last updated . Spotted something wrong? Tell us.