Redmine

Publisher: Splunk Community
Connector Version: 1.0.1
Product Vendor: Redmine
Product Name: Redmine
Minimum Product Version: 4.9.39220

This app integrates with Redmine to perform several ticket management actions

Configuration variables

This table lists the configuration variables required to operate Redmine. These variables are specified when configuring a Redmine asset in Splunk SOAR.

VARIABLE	REQUIRED	TYPE	DESCRIPTION
base_url	required	string	Server URL
verify_server_cert	optional	boolean	Verify Server Certificate
username	optional	string	Username
password	optional	password	Password
project_id	required	string	Redmine Project ID
custom_fields	optional	string	Comma-separated list of custom fields to extract from tickets

Supported Actions

test connectivity - Validate the asset configuration for connectivity using supplied configuration
on poll - Ingest tickets from Redmine
create ticket - Create a ticket (issue)
update ticket - Update ticket (issue)
add comment - Add a comment to a ticket
list tickets - Get a list of tickets (issues) in a project
get ticket - Get ticket (issue) information
delete ticket - Delete ticket (issue)
set status - Set ticket (issue) status

action: 'test connectivity'

Validate the asset configuration for connectivity using supplied configuration

Type: test
Read only: True

Action Parameters

No parameters are required for this action

Action Output

No Output

action: 'on poll'

Ingest tickets from Redmine

Type: ingest
Read only: True

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE
start_time	optional	Parameter ignored in this app	numeric
end_time	optional	Parameter ignored in this app	numeric
container_id	optional	Parameter ignored in this app	string
container_count	optional	Maximum number of tickets to be ingested during poll now	numeric
artifact_count	optional	Parameter ignored in this app	numeric

Action Output

No Output

action: 'create ticket'

Create a ticket (issue)

Type: generic
Read only: False

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE
subject	required	Title	string
description	required	Description of the ticket	string
priority	optional	Priority of the ticket	string
tracker	optional	Tracker type the ticket	string
custom_fields	optional	JSON array containing custom field objects containing custom field id and value to set	string

Action Output

DATA PATH	TYPE	EXAMPLE VALUES
action_result.parameter.custom_fields	string
action_result.parameter.description	string
action_result.parameter.priority	string
action_result.parameter.subject	string
action_result.parameter.tracker	string
action_result.data.*.issue.author.name	string
action_result.data.*.issue.id	string
action_result.data.*.issue.priority.closed_on	string
action_result.data.*.issue.priority.created_on	string
action_result.data.*.issue.priority.name	string
action_result.data.*.issue.priority.updated_on	string
action_result.data.*.issue.project.name	string
action_result.data.*.issue.status.name	string
action_result.data.*.issue.subject	string
action_result.data.*.issue.tracker.name	string
action_result.status	string	success failed
action_result.message	string
action_result.summary	string
summary.total_objects	numeric	1
summary.total_objects_successful	numeric	1

action: 'update ticket'

Update ticket (issue)

Type: generic
Read only: False

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
id	required	Issue ID	string
update_fields	optional	JSON containing field values	string
vault_id	optional	Vault ID of attachment	string	`vault id`

Action Output

DATA PATH	TYPE	CONTAINS	EXAMPLE VALUES
action_result.parameter.id	string
action_result.parameter.update_fields	string
action_result.parameter.vault_id	string	`vault id`
action_result.data.*.issue.author.name	string
action_result.data.*.issue.id	string
action_result.data.*.issue.priority.closed_on	string
action_result.data.*.issue.priority.created_on	string
action_result.data.*.issue.priority.name	string
action_result.data.*.issue.priority.updated_on	string
action_result.data.*.issue.project.name	string
action_result.data.*.issue.status.name	string
action_result.data.*.issue.subject	string
action_result.data.*.issue.tracker.name	string
action_result.status	string		success failed
action_result.message	string
action_result.summary	string
summary.total_objects	numeric		1
summary.total_objects_successful	numeric		1

action: 'add comment'

Add a comment to a ticket

Type: generic
Read only: False

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
id	required	Issue ID	string
comment	required	Comment to add	string

Action Output

DATA PATH	TYPE	EXAMPLE VALUES
action_result.parameter.comment	string
action_result.parameter.id	string
action_result.data.*.issue.author.name	string
action_result.data.*.issue.id	string
action_result.data.*.issue.priority.closed_on	string
action_result.data.*.issue.priority.created_on	string
action_result.data.*.issue.priority.name	string
action_result.data.*.issue.priority.updated_on	string
action_result.data.*.issue.project.name	string
action_result.data.*.issue.status.name	string
action_result.data.*.issue.subject	string
action_result.data.*.issue.tracker.name	string
action_result.status	string	success failed
action_result.message	string
action_result.summary	string
summary.total_objects	numeric	1
summary.total_objects_successful	numeric	1

action: 'list tickets'

Get a list of tickets (issues) in a project

Type: investigate
Read only: True

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE
query	optional	Additional parameters to query for in JQL	string
start_index	optional	Start index of the list	numeric
max_results	optional	Max number of issues to return	numeric

Action Output

DATA PATH	TYPE	EXAMPLE VALUES
action_result.parameter.max_results	numeric
action_result.parameter.query	string
action_result.parameter.start_index	numeric
action_result.data..issues..author.name	string
action_result.data..issues..id	string
action_result.data..issues..priority.closed_on	string
action_result.data..issues..priority.created_on	string
action_result.data..issues..priority.name	string
action_result.data..issues..priority.updated_on	string
action_result.data..issues..project.name	string
action_result.data..issues..status.name	string
action_result.data..issues..subject	string
action_result.data..issues..tracker.name	string
action_result.status	string	success failed
action_result.message	string
action_result.summary	string
summary.total_objects	numeric	1
summary.total_objects_successful	numeric	1

action: 'get ticket'

Get ticket (issue) information

Type: investigate
Read only: True

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
id	required	Ticket (Issue) Key	string

Action Output

DATA PATH	TYPE	EXAMPLE VALUES
action_result.parameter.id	string
action_result.data.*.issue.author.name	string
action_result.data.*.issue.id	string
action_result.data.*.issue.priority.closed_on	string
action_result.data.*.issue.priority.created_on	string
action_result.data.*.issue.priority.name	string
action_result.data.*.issue.priority.updated_on	string
action_result.data.*.issue.project.name	string
action_result.data.*.issue.status.name	string
action_result.data.*.issue.subject	string
action_result.data.*.issue.tracker.name	string
action_result.status	string	success failed
action_result.message	string
action_result.summary	string
summary.total_objects	numeric	1
summary.total_objects_successful	numeric	1

action: 'delete ticket'

Delete ticket (issue)

Type: generic
Read only: False

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
id	required	Issue ID	string

Action Output

DATA PATH	TYPE	EXAMPLE VALUES
action_result.parameter.id	string
action_result.data	string
action_result.status	string	success failed
action_result.message	string
action_result.summary	string
summary.total_objects	numeric	1
summary.total_objects_successful	numeric	1

action: 'set status'

Set ticket (issue) status

Type: generic
Read only: False

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE
id	required	Ticket (Issue) Key	string
status	required	Status to set	string
comment	optional	Comment to set	string

Action Output

DATA PATH	TYPE	EXAMPLE VALUES
action_result.parameter.comment	string
action_result.parameter.id	string
action_result.parameter.status	string
action_result.data.*.issue.author.name	string
action_result.data.*.issue.id	string
action_result.data.*.issue.priority.closed_on	string
action_result.data.*.issue.priority.created_on	string
action_result.data.*.issue.priority.name	string
action_result.data.*.issue.priority.updated_on	string
action_result.data.*.issue.project.name	string
action_result.data.*.issue.status.name	string
action_result.data.*.issue.subject	string
action_result.data.*.issue.tracker.name	string
action_result.status	string	success failed
action_result.message	string
action_result.summary	string
summary.total_objects	numeric	1
summary.total_objects_successful	numeric	1

Auto-generated Splunk SOAR Connector documentation.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Name		Name	Last commit message	Last commit date
Latest commit History 23 Commits
.github/workflows		.github/workflows
release_notes		release_notes
.pre-commit-config.yaml		.pre-commit-config.yaml
LICENSE		LICENSE
NOTICE		NOTICE
README.md		README.md
__init__.py		__init__.py
logo_redmine.svg		logo_redmine.svg
logo_redmine_dark.svg		logo_redmine_dark.svg
pyproject.toml		pyproject.toml
readme.html		readme.html
redmine.json		redmine.json
redmine_connector.py		redmine_connector.py
redmine_consts.py		redmine_consts.py

Uh oh!

Folders and files

Latest commit

History

Repository files navigation

Redmine

Configuration variables

Supported Actions

action: 'test connectivity'

Action Parameters

Action Output

action: 'on poll'

Action Parameters

Action Output

action: 'create ticket'

Action Parameters

Action Output

action: 'update ticket'

Action Parameters

Action Output

action: 'add comment'

Action Parameters

Action Output

action: 'list tickets'

Action Parameters

Action Output

action: 'get ticket'

Action Parameters

Action Output

action: 'delete ticket'

Action Parameters

Action Output

action: 'set status'

Action Parameters

Action Output

About

Resources

License

Contributing

Uh oh!

Stars

Watchers

Forks

Releases 1

Packages 0

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

Packages