Redmine

A project management and issue tracking system that provides a web-based platform for managing projects, tracking tasks, and handling various types of project-related activities.
This integration was integrated and tested with version 5.1.2 of Redmine.

Configure Redmine on Cortex XSOAR

1. Navigate to Settings > Integrations > Servers & Services.
2. Search for Redmine.

3. Click Add instance to create and configure a new integration instance.

   Parameter	Required
   Server URL (e.g., https://1.1.1.1)	True
   Trust any certificate (not secure)	False
   API Key	True
   Project id	False

4. Getting your API key:
   • Use your server URL to enter your Redmine instance.
   • Authenticate with your username and password.
   • Navigate to My Account (at the top right corner).
   • Click API Access key > Show - This is your API key
5. Click Test to validate the URLs, token, and connection.

Commands

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

redmine-issue-create

• Create a new issue.
• The status of the newly created issue will be set to the default status of the Redmine instance.
• When attaching a file to an issue, include the entry ID in the request as file_entry_id=entry ID.
• To create a custom field, navigate to the server URL with administrative privileges, click Administration (located at the top left), select Custom fields, and then proceed to create a new custom field. Once created, you can add values as needed
• To create a category/version, navigate to the server URL > click Settings (top bar) > Versions tab and Issue categories tab.

Base Command

redmine-issue-create

Input

Context Output

Command example

!redmine-issue-create priority_id=High subject=helloExample tracker_id=1 project_id=1 watcher_user_ids=5,6 custom_fields=1:helloCustom priority_id=1

Context Example

{
    "Redmine": {
        "Issue": {
            "author": {
                "id": 6,
                "name": "Integration Test"
            },
            "closed_on": null,
            "created_on": "2024-04-07T11:59:34Z",
            "custom_fields": [
                {
                    "id": 1,
                    "name": "Team_of_workers",
                    "value": "helloCustom"
                }
            ],
            "description": null,
            "done_ratio": 0,
            "due_date": null,
            "estimated_hours": null,
            "id": "167",
            "is_private": false,
            "priority": {
                "id": 1,
                "name": "Low"
            },
            "project": {
                "id": 1,
                "name": "Cortex XSOAR"
            },
            "start_date": "2024-04-07",
            "status": {
                "id": 1,
                "is_closed": false,
                "name": "New"
            },
            "subject": "helloExample",
            "total_estimated_hours": null,
            "tracker": {
                "id": 1,
                "name": "Bug"
            },
            "updated_on": "2024-04-07T11:59:34Z"
        }
    }
}

Human Readable Output

The issue you created

Id	Project	Tracker	Status	Priority	Author	Created On	Subject	Start Date	Custom Fields
167	Cortex XSOAR	Bug	New	Low	Integration Test	2024-04-07T11:59:34Z	helloExample	2024-04-07	- name: Team_of_workers value: helloCustom

redmine-issue-list

Display a list of issues

Base Command

redmine-issue-list

Input

Context Output

Command example

!redmine-issue-list limit=2

Context Example

{
    "Redmine": {
        "Issue": [
            {
                "author": {
                    "id": 6,
                    "name": "Integration Test"
                },
                "closed_on": null,
                "created_on": "2024-03-11T09:16:47Z",
                "custom_fields": [
                    {
                        "id": 1,
                        "name": "Team_of_workers",
                        "value": "helloCustom"
                    }
                ],
                "description": null,
                "done_ratio": 0,
                "due_date": null,
                "estimated_hours": null,
                "id": "130",
                "is_private": false,
                "priority": {
                    "id": 3,
                    "name": "High"
                },
                "project": {
                    "id": 1,
                    "name": "Cortex XSOAR"
                },
                "spent_hours": 0,
                "start_date": "2024-03-11",
                "status": {
                    "id": 1,
                    "is_closed": false,
                    "name": "New"
                },
                "subject": "subjectChanged",
                "total_estimated_hours": null,
                "total_spent_hours": 0,
                "tracker": {
                    "id": 1,
                    "name": "Bug"
                },
                "updated_on": "2024-03-11T09:16:54Z"
            },
            {
                "author": {
                    "id": 6,
                    "name": "Integration Test"
                },
                "closed_on": null,
                "created_on": "2024-03-11T09:08:09Z",
                "custom_fields": [
                    {
                        "id": 1,
                        "name": "Team_of_workers",
                        "value": "helloCustom"
                    }
                ],
                "description": null,
                "done_ratio": 0,
                "due_date": null,
                "estimated_hours": null,
                "id": "129",
                "is_private": false,
                "priority": {
                    "id": 3,
                    "name": "High"
                },
                "project": {
                    "id": 1,
                    "name": "Cortex XSOAR"
                },
                "spent_hours": 0,
                "start_date": "2024-03-11",
                "status": {
                    "id": 1,
                    "is_closed": false,
                    "name": "New"
                },
                "subject": "helloExample",
                "total_estimated_hours": null,
                "total_spent_hours": 0,
                "tracker": {
                    "id": 1,
                    "name": "Bug"
                },
                "updated_on": "2024-03-11T09:08:09Z"
            }
        ]
    }
}

Human Readable Output

Showing 2 results from page 1

Issues Results

ID	Tracker	Status	Priority	Author	Subject	Start Date	done_ratio	Is Private	Custom Fields	Created On	updated_on
130	Bug	New	High	Integration Test	subjectChanged	2024-03-11	0	false	- name: Team_of_workers value: helloCustom	2024-03-11T09:16:47Z	2024-03-11T09:16:54Z
129	Bug	New	High	Integration Test	helloExample	2024-03-11	0	false	- name: Team_of_workers value: helloCustom	2024-03-11T09:08:09Z	2024-03-11T09:08:09Z

redmine-issue-update

Update an existing issue. When attaching a file to an issue, include the entry ID in the request as file_entry_id=entry ID. To create a custom field, navigate to the server URL with administrative privileges, click ‘Administration (located at the top left), select Custom fields, and proceed to create a new custom field. Once created, you can add values as needed.

Base Command

redmine-issue-update

Input

Context Output

There is no context output for this command.

Command example

!redmine-issue-update issue_id=130 subject=subjectChanged

Human Readable Output

Issue with id 130 was successfully updated.

redmine-issue-get

Show an issue by id

Base Command

redmine-issue-get

Input

Context Output

Command example

!redmine-issue-get issue_id=130 include=watchers

Context Example

{
    "Redmine": {
        "Issue": {
            "author": {
                "id": 6,
                "name": "Integration Test"
            },
            "closed_on": null,
            "created_on": "2024-03-11T09:16:47Z",
            "custom_fields": [
                {
                    "id": 1,
                    "name": "Team_of_workers",
                    "value": "helloCustom"
                }
            ],
            "description": null,
            "done_ratio": 0,
            "due_date": null,
            "estimated_hours": null,
            "id": "130",
            "is_private": false,
            "priority": {
                "id": 3,
                "name": "High"
            },
            "project": {
                "id": 1,
                "name": "Cortex XSOAR"
            },
            "spent_hours": 0,
            "start_date": "2024-03-11",
            "status": {
                "id": 1,
                "is_closed": false,
                "name": "New"
            },
            "subject": "subjectChanged",
            "total_estimated_hours": null,
            "total_spent_hours": 0,
            "tracker": {
                "id": 1,
                "name": "Bug"
            },
            "updated_on": "2024-03-11T09:16:54Z",
            "watchers": [
                {
                    "id": 5,
                    "name": "admin tests"
                },
                {
                    "id": 6,
                    "name": "Integration Test"
                }
            ]
        }
    }
}

Human Readable Output

Issues List

Id	Project	Tracker	Status	Priority	Author	Subject	StartDate	DoneRatio	IsPrivate	CustomFields	CreatedOn	Watchers
130	Cortex XSOAR	Bug	New	High	Integration Test	subjectChanged	2024-03-11	0	false	- name: Team_of_workers value: helloCustom	2024-03-11T09:16:47Z	- name: admin tests - name: Integration Test

redmine-issue-delete

Delete an issue by its ID

Base Command

redmine-issue-delete

Input

Context Output

There is no context output for this command.

Command example

!redmine-issue-delete issue_id=130

Human Readable Output

Issue with id 130 was deleted successfully.

redmine-issue-watcher-add

Add a watcher to the specified issue

Base Command

redmine-issue-watcher-add

Input

Context Output

There is no context output for this command.

Command example

!redmine-issue-watcher-add issue_id=130 watcher_id=1

Human Readable Output

Watcher with id 1 was added successfully to issue with id 130.

redmine-issue-watcher-remove

Remove a watcher of an issue

Base Command

redmine-issue-watcher-remove

Input

Context Output

There is no context output for this command.

Command example

!redmine-issue-watcher-remove issue_id=130 watcher_id=1

Human Readable Output

Watcher with id 1 was removed successfully from issue with id 130.

redmine-project-list

Retrieve a list of all projects, including both public and private ones that the user has access to.

Base Command

redmine-project-list

Input

Context Output

Command example

#### Context Example

```json
{
    "Redmine": {
        "Project": {
            "created_on": "2024-02-29T10:34:23Z",
            "custom_fields": [
                {
                    "id": 3,
                    "name": "second_custom_field",
                    "value": null
                }
            ],
            "description": "",
            "homepage": "",
            "id": "1",
            "identifier": "cortex-xsoar",
            "inherit_members": false,
            "is_public": "True",
            "name": "Cortex XSOAR",
            "status": "1",
            "updated_on": "2024-02-29T10:34:23Z"
        }
    }
}

Human Readable Output

Projects List

Id	Name	Identifier	Status	IsPublic	CreatedOn	UpdatedOn
1	Cortex XSOAR	cortex-xsoar	1	True	2024-02-29T10:34:23Z	2024-02-29T10:34:23Z

redmine-custom-field-list

Retrieve a list of all custom fields.

Base Command

redmine-custom-field-list

Input

There are no input arguments for this command.

Context Output

Command example

#### Context Example

```json
{
    "Redmine": {
        "CustomField": [
            {
                "customized_type": "issue",
                "default_value": "",
                "description": "specify the team of workers under this issue",
                "field_format": "string",
                "id": "1",
                "is_filter": "True",
                "is_required": "False",
                "max_length": null,
                "min_length": null,
                "multiple": false,
                "name": "Team_of_workers",
                "regexp": "",
                "roles": [],
                "searchable": true,
                "trackers": [
                    {
                        "id": 1,
                        "name": "Bug"
                    },
                    {
                        "id": 2,
                        "name": "Feature"
                    },
                    {
                        "id": 3,
                        "name": "Support"
                    }
                ],
                "visible": true
            },
            {
                "customized_type": "project",
                "default_value": "",
                "description": "",
                "field_format": "string",
                "id": "3",
                "is_filter": "False",
                "is_required": "False",
                "max_length": null,
                "min_length": null,
                "multiple": false,
                "name": "second_custom_field",
                "regexp": "",
                "searchable": false,
                "visible": true
            }
        ]
    }
}

Human Readable Output

Custom Fields List

Id	Name	CustomizedType	FieldFormat	IsRequired	IsFilter	Searchable	Trackers
1	Team_of_workers	issue	string	False	True		- id: 1 name: Bug - id: 2 name: Feature - id: 3 name: Support
3	second_custom_field	project	string	False	False

redmine-user-id-list

• Retrieve a list of users with optional filtering options.
• This command requires admin privileges in your Redmine account.

Base Command

redmine-user-id-list

Input

Context Output

Command example

#### Context Example

```json
{
    "Redmine": {
        "Users": [
            {
                "admin": "True",
                "created_on": "2024-02-28T19:47:56Z",
                "firstname": "admin",
                "id": "5",
                "last_login_on": "2024-02-29T10:25:08Z",
                "lastname": "tests",
                "login": "admin",
                "mail": "admin@redmine-test.local",
                "passwd_changed_on": "2024-02-28T19:49:17Z",
                "twofa_scheme": null,
                "updated_on": "2024-02-28T19:50:49Z"
            },
            {
                "admin": "True",
                "created_on": "2024-02-29T10:27:31Z",
                "firstname": "Integration",
                "id": "6",
                "last_login_on": "2024-02-29T10:55:25Z",
                "lastname": "Test",
                "login": "demiadmin",
                "mail": "demiadmin@redmine-test.local",
                "passwd_changed_on": "2024-02-29T10:27:31Z",
                "twofa_scheme": null,
                "updated_on": "2024-02-29T10:27:31Z"
            },
            {
                "admin": "True",
                "created_on": "2024-02-28T18:34:10Z",
                "firstname": "UserName",
                "id": "1",
                "last_login_on": "2024-02-29T09:50:10Z",
                "lastname": "LastName",
                "login": "user",
                "mail": "user@example.com",
                "passwd_changed_on": null,
                "twofa_scheme": null,
                "updated_on": "2024-02-28T18:34:10Z"
            }
        ]
    }
}

Human Readable Output

Users List

ID	Login	Admin	First Name	Last Name	Email	Created On	Last Login On
5	admin	True	admin	tests	admin@redmine-test.local	2024-02-28T19:47:56Z	2024-02-29T10:25:08Z
6	demiadmin	True	Integration	Test	demiadmin@redmine-test.local	2024-02-29T10:27:31Z	2024-02-29T10:55:25Z
1	user	True	UserName	LastName	user@example.com	2024-02-28T18:34:10Z	2024-02-29T09:50:10Z

redmine-priority-id-list

Returns a list of priorities (priority_name to priority_id).

Base Command

redmine-priority-id-list

Input

There are no input arguments for this command.

Context Output

Command example

#### Context Example

```json
{
    "Redmine": {
        "priorities": [
            {
                "ID": 1,
                "Name": "Low"
            },
            {
                "ID": 2,
                "Name": "Normal"
            },
            {
                "ID": 3,
                "Name": "High"
            },
            {
                "ID": 4,
                "Name": "Urgent"
            },
            {
                "ID": 5,
                "Name": "Immediate"
            }
        ]
    }
}

Human Readable Output

priorities name to id List

ID	Name
1	Low
2	Normal
3	High
4	Urgent
5	Immediate

redmine-status-id-list

Returns a list of statuses (status_name to status_id).

Base Command

redmine-status-id-list

Input

There are no input arguments for this command.

Context Output

Command example

#### Context Example

```json
{
    "Redmine": {
        "statuses": [
            {
                "ID": 1,
                "Name": "help"
            },
            {
                "ID": 2,
                "Name": "In Progress"
            },
            {
                "ID": 3,
                "Name": "Resolved"
            },
            {
                "ID": 4,
                "Name": "Feedback"
            },
            {
                "ID": 5,
                "Name": "Closed"
            },
            {
                "ID": 6,
                "Name": "Rejected"
            }
        ]
    }
}

Human Readable Output

statuses name to id List

ID	Name
1	help
2	In Progress
3	Resolved
4	Feedback
5	Closed
6	Rejected

redmine-tracker-id-list

Returns a list of trackers (tracker_name to tracker_id).

Base Command

redmine-tracker-id-list

Input

There are no input arguments for this command.

Context Output

Command example

#### Context Example

```json
{
    "Redmine": {
        "trackers": [
            {
                "ID": 1,
                "Name": "Bug111"
            },
            {
                "ID": 2,
                "Name": "Feature"
            },
            {
                "ID": 3,
                "Name": "Support"
            }
        ]
    }
}

Human Readable Output

trackers name to id List

ID	Name
1	Bug111
2	Feature
3	Support