To fetch metadata of a SSH Action object send a GET request to:|xml)

example. request json with curl utility:

curl -H "authorization: bearer _token"

example. request xml with curl utility:

curl -H "authorization: bearer _token"

table below is the list of fields contained in the response, this list will be properly formatted to json or xml as requested.


Param Data type Access Description
id integer read SSH Action identifier
command string read/write Command to execute on the remote server when action is run
description string read/write Action description
frequency integer read/write Frequency of execution: 0 - manual, 1 - hourly, 2 - daily, 10 - on commit, 11 - on merge request creation, 12 - on merge request merge
name string read/write Name of the action
repo_tool_id string read Repository tool being monitored for commit and merge request events when frequency is 10/11/12
username string read/write User to run the action on the remote server
status integer read Status of the action: 0 - idle, 1 - queued, 2 - running. Both 1/2 are considered "active" statuses.
space_tool_id string read SSH tool identifier
position integer write Sort order in the list of all actions
ssh_tool_server_id string write SSH server identifier


Field Validator Description
command presence validator Command should be present.
description length validator Max length - 200.
frequency presence validator Frequency should be present.
frequency inclusion validator Frequency should be in [0, 1, 2, 10, 11, 12].
name presence validator Name should be present.
name format validator Name should pass this regex: ^[a-zA-Z0-9 _]+$.
username presence validator Username should be present.
ssh_tool_server_id presence validator SSH server with given identifier should be present in the same SSH tool.