http/action.yml
Kurt Bonheure ae65a272d9
Update action.yml (#151)
Added status as output in action.yml
2024-05-30 16:11:49 +02:00

84 lines
2.6 KiB
YAML

name: 'HTTP Request Action'
description: 'Create any HTTP Request'
inputs:
url:
description: 'Request URL'
required: true
method:
description: 'Request Method'
required: false
default: 'POST'
contentType:
description: 'Content Type'
required: false
data:
description: 'Request Body as JSON String'
required: false
default: '{}'
files:
description: 'Map of absolute file paths as JSON String'
required: false
default: '{}'
file:
description: 'A single absolute file path'
required: false
username:
description: 'Auth Username'
required: false
password:
description: 'Auth Password'
required: false
timeout:
description: 'Request Timeout in milliseconds'
required: false
default: '5000'
bearerToken:
description: 'Bearer Authentication Token'
required: false
customHeaders:
description: 'Custom HTTP Headers'
required: false
preventFailureOnNoResponse:
description: 'Prevent this Action to fail if the request respond without an response'
required: false
ignoreStatusCodes:
description: 'Prevent this Action to fail if the request respond with one of the configured StatusCodes'
required: false
escapeData:
description: 'Escape newlines in data string content'
required: false
httpsCA:
description: 'Certificate authority as string in PEM format'
required: false
httpsCert:
description: 'Client Certificate as string'
required: false
httpsKey:
description: 'Client Certificate Key as string'
required: false
responseFile:
description: 'Persist the response data to the specified file path'
required: false
maskResponse:
description: 'Allows to mark your response as secret and hide the output in the action logs'
required: false
default: 'false'
retry:
description: 'optional amount of retries if the request fails'
required: false
retryWait:
description: 'wait time between retries in milliseconds'
required: false
ignoreSsl:
description: 'ignore ssl verify (rejectUnauthorized: false)'
default: 'false'
outputs:
response:
description: 'HTTP Response Content'
headers:
description: 'HTTP Response Headers'
status:
description: 'HTTP status message'
runs:
using: 'node20'
main: 'dist/index.js'