https://github.com/tyrrrz/action-http-request

GitHub Action that sends an HTTP request
https://github.com/tyrrrz/action-http-request

Last synced: 3 months ago
JSON representation

GitHub Action that sends an HTTP request

• Host: GitHub
• URL: https://github.com/tyrrrz/action-http-request
• Owner: Tyrrrz
• License: mit
• Created: 2023-04-05T15:43:44.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2025-07-01T15:38:10.000Z (3 months ago)
• Last Synced: 2025-07-01T16:45:20.741Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 43 KB
• Stars: 17
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license.txt

Awesome Lists containing this project

README

          
# GitHub Action: HTTP request

> 🟡 **Project status**: maintenance mode[[?]](https://github.com/Tyrrrz/.github/blob/master/docs/project-status.md)

GitHub Action that sends an HTTP request to the specified URL.

## Usage

### Minimal example

```yaml

on: [push, pull_request]

jobs:

  main:

    runs-on: ubuntu-latest

    steps:

      - name: Send HTTP request

        uses: tyrrrz/action-http-request@master

        with:

          url: https://example.com

```

> **Note**:

> When referencing the action, replace `@master` above with either the latest release tag or a specific commit hash.

> You can consult with [this article](https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-third-party-actions) for more information.

### Advanced example

```yaml

on: [push, pull_request]

jobs:

  main:

    runs-on: ubuntu-latest

    steps:

      - name: Send HTTP request

        id: request

        uses: tyrrrz/action-http-request@master

        with:

          url: https://example.com

          method: POST

          headers: |

            Content-Type: application/json

          body: |

            {

              "foo": "bar"

            }

          retry-count: 3

          retry-delay: 500

      - name: Print outputs

        run: |

          echo "Status: ${{ steps.request.outputs.status }}"

          echo "Success: ${{ steps.request.outputs.success }}"

          echo "Headers: ${{ steps.request.outputs.headers }}"

          echo "Body: ${{ steps.request.outputs.body }}"

```

### Inputs

- `url`: URL to send the request to.

- `method`: HTTP method to use. Defaults to `GET`.

- `headers`: Headers to send with the request (one per line). Defaults to empty.

- `body`: Body to send with the request. Defaults to empty.

- `retry-count`: Number of times to retry on unsuccessful requests. Defaults to `0`.

- `retry-delay`: Delay between retries in milliseconds. Defaults to `1000`.

- `fail-on-error`: Whether to fail the step if the request was unsuccessful. Defaults to `true`.

### Outputs

- `status`: Status code of the response.

- `success`: Whether the response status code indicates success.

- `headers`: Headers returned by the response (formatted as a JSON object).

- `body`: Body of the response.