> ## Documentation Index
> Fetch the complete documentation index at: https://docs.keephq.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Redmine

# Redmine Provider

`RedmineProvider` is a class that integrates with Redmine to manage issue tracking through Keep.

## Authentication

This provider requires authentication.

* **host**: Redmine Host (required: True, sensitive: False)
* **api\_access\_key**: Redmine API Access key (required: True, sensitive: True)
* **ticket\_creation\_url**: URL for creating new tickets (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:

* **authenticated**: Authenticated with Redmine API (mandatory)

## In workflows

This provider can be used in workflows.

As "action" to make changes or update data, example:

```yaml theme={null}
actions:
    - name: Query redmine
      provider: redmine
      config: "{{ provider.my_provider_name }}"
      with:
        project_id: {value}  
        subject: {value}  
        priority_id: {value}  
        description: {value}  
```

If you need workflow examples with this provider, please raise a [GitHub issue](https://github.com/keephq/keep/issues).

## Connecting with the Provider

To connect with the Redmine provider and manage issues through Keep, follow these steps:

1. Obtain a Redmine Personal Access Token: Visit the [Redmine API documentation](https://www.redmine.org/projects/redmine/wiki/rest_api#Authentication) to see the steps to get an API key.
2. Use the following YAML example to create an issue using the Redmine provider, all these are [valid arguments](https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Creating-an-issue):

```yaml title=examples/issue_creation_example.yml theme={null}
# Create an issue using the Redmine provider.
task:
  id: create-redmine-issue
  description: Create an issue in Redmine
  actions:
    - name: create-issue
      provider:
        type: redmine
        config: "{{ providers.redmine-provider }}"
        with:
          project_id: "example_project"
          subject: "Issue Subject"
          priority_id: "2"
          description: "This is the issue description."
```

## Useful Links

* [Redmine REST API](https://www.redmine.org/projects/redmine/wiki/rest_api)
* [Authentication Guide](https://www.redmine.org/projects/redmine/wiki/rest_api#Authentication)
* [Valid arguments while creating issue](https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Creating-an-issue)