IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Index connector and action Microsoft Teams connector and action »
Elastic Docs ›Kibana Guide [8.8] ›Stack Management ›Connectors

Jira connector and action

edit

Jira connector and action

edit

The Jira connector uses the REST API v2 to create Atlassian Jira issues.

Compatibility

edit

Jira on-premise deployments (Server and Data Center) are not supported.

Create connectors in Kibana

edit

You can create connectors in Stack Management > Connectors or as needed when you’re creating a rule. For example:

Jira connector
Connector configuration
edit

Jira connectors have the following configuration properties:

Name
The name of the connector.
URL
Jira instance URL.
Project key
Jira project key.
Email
The account email for HTTP Basic authentication.
API token
Jira API authentication token for HTTP Basic authentication.

Create preconfigured connectors

edit

If you are running Kibana on-prem, you can define connectors by adding xpack.actions.preconfigured settings to your kibana.yml file. For example:

xpack.actions.preconfigured:
  my-jira:
    name: preconfigured-jira-connector-type
    actionTypeId: .jira
    config:
      apiUrl: https://elastic.atlassian.net
      projectKey: ES
    secrets:
      email: testuser
      apiToken: tokenkeystorevalue

Config defines information for the connector type.

apiUrl
An address that corresponds to URL.
projectKey
A key that corresponds to Project Key.

Secrets defines sensitive information for the connector type.

email
A string that corresponds to Email.
apiToken
A string that corresponds to API Token. Should be stored in the Kibana keystore.

Test connectors

edit

You can test connectors with the run connector API or as you’re creating or editing the connector in Kibana. For example:

Jira params test

Jira actions have the following configuration properties.

Issue type
The type of the issue.
Priority
The priority of the incident.
Labels
The labels for the incident.
Title
A title for the issue, used for searching the contents of the knowledge base.
Description
The details about the incident.
Parent
The ID or key of the parent issue. Only for Subtask issue types.
Additional comments
Additional information for the client, such as how to troubleshoot the issue.

Connector networking configuration

edit

Use the Action configuration settings to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use xpack.actions.customHostSettings to set per-host configurations.

« Index connector and action Microsoft Teams connector and action »