HTTP Request with YAML

YAML parameters for HTTP Request

NameTypeDescription
action
Required
StringThe ID of the action.
notification_url
Required
StringThe target URL.
type
Required
StringThe type of the action. Should be set to HTTP.
trigger_timeStringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
portStringThe port for the connection.
loginStringThe username required to connect to the server.
passwordStringThe password required to connect to the server.
contentStringThe content of the request.
headersHeader[]The headers that will be sent with the request.
timeoutIntegerThe HTTP request timeout in seconds. Available values between 0-600.
trigger_conditionStringDefines when the build action should be run. Can be one of ALWAYS, ON_CHANGE, ON_CHANGE_AT_PATH, VAR_IS, VAR_IS_NOT or VAR_CONTAINS.
trigger_condition_pathsString[]Required when trigger_condition is set to ON_CHANGE_AT_PATH.
trigger_variable_keyStringRequired when trigger_condition is set to VAR_IS, VAR_IS_NOT or VAR_CONTAINS. Defines the name of the desired variable.
trigger_variable_valueStringRequired when trigger_condition is set to VAR_IS, VAR_IS_NOT or VAR_CONTAINS. Defines the value of the desired variable which will be compared with its current value.
disabledBooleanWhen set to true the action is disabled. By default it is set to false.
variablesVariable[]The list of variables defined for this action.

YAML example for HTTP request

actions:
- action: "Send HTTP request to http://mywebserver.io"
type: "HTTP"
login: "api_tests_user"
password: "$api_tests_password"
port: "4567"
notification_url: "http://mywebserver.io"
method: "POST"
content: "{\r\n\t\"url\": \"${execution.url}\",\r\n\t\"html_url\": \"${execution.html_url}\",\r\n\t\"id\": \"${execution.id}\",\r\n\t\"start_date\": \"${execution.start_date}\",\r\n\t\"mode\": \"${execution.mode}\",\r\n\t\"refresh\": \"${execution.refresh}\",\r\n\t\"status\": \"${execution.status}\",\r\n\t\"comment\": \"${execution.comment}\",\r\n}"
headers:
- name: "User-Agent"
value: "Buddy"
- name: "Content-Type"
value: "application/json"
timeout: 120
variables:
- key: "ftp_login"
value: "userLogin123"
description: "The name of user to FTP."
- key: "ftp_password"
value: "secure!14ivLMxPgv7TX6c9+ITX/g=="
encrypted: true
description: "The password for ftp."