Skip to content

Commit 6031acb

Browse files
Update README to include mayhem-url
1 parent d3ddb97 commit 6031acb

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ The action accepts the follow inputs:
9292
| | `html-report` | string | Path to the generated SARIF report |
9393
| | `sarif-report` | string | Path to the generated HTML report |
9494
| | `run-args` | string | Additional arguments to provide to the `mapi run` command. Argument values should be separated on new lines. <br><br>e.g.<br> <pre> run-args: \|<br> # Basic Auth<br> --basic-auth<br> login:password</pre><br>⚠️ Avoid wrapping values in quotes, as these will be escaped and included in the value passed to `mapi`.<br><br>⛔️ `"login:password"` <br>✅ `login:password` |
95+
| | `mayhem-url` | string | Path to your Mayhem API instance. If you're using something other than the default of https://app.mayhem.security |
9596

9697
### Continuing on error
9798

@@ -117,7 +118,7 @@ jobs:
117118
run: ./run_your_api.sh &
118119
119120
- name: Run Mayhem for API to check for vulnerabilities
120-
uses: ForAllSecure/mapi-action@v2
121+
uses: ForAllSecure/mapi-action@v1
121122
continue-on-error: true # <-----------------------------------------------
122123
with:
123124
mayhem-token: ${{ secrets.MAYHEM_TOKEN }}
@@ -151,7 +152,7 @@ To create an artifact of the report in your build, add this step to your pipelin
151152

152153
```yaml
153154
- name: Run Mayhem for API to check for vulnerabilities
154-
uses: ForAllSecure/mapi-action@v2
155+
uses: ForAllSecure/mapi-action@v1
155156
continue-on-error: true
156157
with:
157158
mayhem-token: ${{ secrets.MAYHEM_TOKEN }}
@@ -180,7 +181,7 @@ step to your pipeline:
180181

181182
```yaml
182183
- name: Run Mayhem for API to check for vulnerabilities
183-
uses: ForAllSecure/mapi-action@v2
184+
uses: ForAllSecure/mapi-action@v1
184185
continue-on-error: true
185186
with:
186187
mayhem-token: ${{ secrets.MAYHEM_TOKEN }}

0 commit comments

Comments
 (0)