Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
play

GitHub Action

HTTP Request Action

v1.7.3

HTTP Request Action

play

HTTP Request Action

Create any HTTP Request

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: HTTP Request Action

              
  uses: fjogeleit/[email protected]
Learn more about this action in fjogeleit/http-request-action

Choose a version

HTTP Request Action

Create HTTP Requests from GitHub Actions. This action allows GitHub events to engage with tools like Ansible AWX that use HTTP APIs.

Example

jobs:
  deployment:
    runs-on: ubuntu-latest
    steps:
    - name: Deploy Stage
      uses: fjogeleit/http-request-action@master
      with:
        url: 'https://ansible.io/api/v2/job_templates/84/launch/'
        method: 'POST'
        username: ${{ secrets.AWX_USER }}
        password: ${{ secrets.AWX_PASSWORD }}

Request Configuration

Argument Description Default
url Request URL required Field
method Request Method POST
contentType Request ContentType application/json
data Request Body Content as JSON String, only for POST / PUT / PATCH Requests '{}'
files Map of key / absolute file paths send as multipart/form-data request to the API, if set the contentType is set to multipart/form-data, values provided by data will be added as additional FormData values, nested objects are not supported. Example provided in the test Workflow of this Action '{}'
timeout Request Timeout in ms 5000 (5s)
username Username for Basic Auth
password Password for Basic Auth
bearerToken Bearer Authentication Token (without Bearer Prefix)
customHeaders Additional header values as JSON string, keys in this object overwrite default headers like Content-Type '{}'
preventFailureOnNoResponse Prevent this Action to fail if the request respond without an response. Use 'true' (string) as value to enable it
escapeData Escape newlines in data string content. Use 'true' (string) as value to enable it

Response

Variable Description
response Response as JSON String

To display HTTP response data in the GitHub Actions log give the request an id and access its outputs

steps:
  - name: Make Request
    id: myRequest
    uses: fjogeleit/http-request-action@master
    with:
      url: "http://yoursite.com/api"
  - name: Show Response
    run: echo ${{ steps.myRequest.outputs.response }}

Additional Information

Additional information is available if debug logging is enabled:

  • Instance Configuration (Url / Timeout / Headers)
  • Request Data (Body / Auth / Method)

To enable debug logging in GitHub Actions create a secret ACTIONS_RUNNER_DEBUG with a value of true