Zabbix

​

Authentication

This provider requires authentication.

• zabbix_frontend_url: Zabbix Frontend URL (required: True, sensitive: False)
• auth_token: Zabbix Auth Token (required: True, sensitive: True)
• verify: Verify SSL certificates (required: False, sensitive: False)

Certain scopes may be required to perform specific actions or queries via the provider. Below is a summary of relevant scopes and their use cases:

• action.create: This method allows to create new actions. (mandatory) (Documentation)
• action.get: This method allows to retrieve actions. (mandatory) (Documentation)
• event.acknowledge: This method allows to update events. (mandatory) (Documentation)
• mediatype.create: This method allows to create new media types. (mandatory) (Documentation)
• mediatype.get: This method allows to retrieve media types. (mandatory) (Documentation)
• mediatype.update: This method allows to update media types. (mandatory) (Documentation)
• problem.get: The method allows to retrieve problems. (mandatory) (Documentation)
• script.create: This method allows to create new scripts. (mandatory) (Documentation)
• script.get: The method allows to retrieve scripts. (mandatory) (Documentation)
• script.update: This method allows to update scripts. (mandatory) (Documentation)
• user.get: This method allows to retrieve users. (mandatory) (Documentation)
• user.update: This method allows to update users. (mandatory) (Documentation)

​

In workflows

This provider can’t be used as a “step” or “action” in workflows. If you want to use it, please let us know by creating an issue in the GitHub repository.

​

Provider Methods

The provider exposes the following Provider Methods. They are available in the AI Assistant.

• close_problem No description. (action, scopes: event.acknowledge)

  • id: The problem id.

• change_severity No description. (action, scopes: event.acknowledge)

  • id: The problem id.
  • new_severity: The new severity, can be one of the following: Not classified, Information, Warning, Average, High, Disaster

• surrpress_problem No description. (action, scopes: event.acknowledge)

  • id: The problem id.
  • suppress_until: The datetime to suppress the problem until.

• unsurrpress_problem No description. (action, scopes: event.acknowledge)

  • id: The problem id.

• acknowledge_problem No description. (action, scopes: event.acknowledge)

  • id: The problem id.

• unacknowledge_problem No description. (action, scopes: event.acknowledge)

  • id: The problem id.

• add_message_to_problem No description. (action, scopes: event.acknowledge)

  • id: The problem id.
  • message_text: The message text.

• get_problem_messages No description. (view, scopes: problem.get)

  • id: The problem id.

​

Connecting with the Provider

​

API Key

To obtain Zabbix authentication token, follow the following steps, divided in to 3 categories (Docs):

First, login in to your Zabbix account (the provided zabbix_frontend_url) with a privileged user.

​

Create a User Role

1. Navigate to Users -> User Roles section.
2. In the top right corner of the screen, click Create user role
3. Give the role an indicative name (e.g. Keep Role)
4. In the User type selectbox, select Super Admin

• This is because some of the scopes we need are available to Super Admin user type only. See here

5. Remove all the checkboxes from everything, except 1 random Access to UI elements which is required for any role.
6. In the API methods section, select Allow list and fill with these scopes:

• action.create
• action.get
• event.acknowledge
• mediatype.create
• mediatype.get
• mediatype.update
• problem.get
• script.create
• script.get
• script.update
• user.get
• user.update

​

Create a user

1. Navigate to Users -> Users section.
2. Follow the instructions to add a new user. Give it an indicative username (e.g. KeepUser)
3. In the Permissions tab, select the Role you have just created.
4. Click Add

​

Create API token

1. Navigate to Users -> API tokens section.
2. In the top right corner of the screen, click Create API token
3. Give the API token an indicative name (e.g. Keep Token)
4. Select the user you have just created
5. Unselect the Set expiration date and time checkbox and click Add
6. Copy the generated API token and keep it for further use in Keep.

​

Notes

​

Webhook Integration Modifications

The automatic webhook integration grants Keep access to the following scopes within the Zabbix instance:

• mediatype.get
• mediatype.update
• mediatype.create
• user.get
• user.update

You can view the webhook settings under Alerts > Media Types

​

Useful Links

• Zabbix API