Skip to content

Commit 143b74a

Browse files
Add APIsec scan workflow for API security testing
This workflow integrates APIsec for automated API security scanning, triggered on pushes to the main branch and scheduled runs.
1 parent 562acc9 commit 143b74a

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

.github/workflows/apisec-scan.yml

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# This workflow uses actions that are not certified by GitHub.
2+
# They are provided by a third-party and are governed by
3+
# separate terms of service, privacy policy, and support
4+
# documentation.
5+
6+
# APIsec addresses the critical need to secure APIs before they reach production.
7+
# APIsec provides the industry’s only automated and continuous API testing platform that uncovers security vulnerabilities and logic flaws in APIs.
8+
# Clients rely on APIsec to evaluate every update and release, ensuring that no APIs go to production with vulnerabilities.
9+
10+
# How to Get Started with APIsec.ai
11+
# 1. Schedule a demo at https://www.apisec.ai/request-a-demo .
12+
#
13+
# 2. Register your account at https://cloud.apisec.ai/#/signup .
14+
#
15+
# 3. Register your API . See the video (https://www.youtube.com/watch?v=MK3Xo9Dbvac) to get up and running with APIsec quickly.
16+
#
17+
# 4. Get GitHub Actions scan attributes from APIsec Project -> Configurations -> Integrations -> CI-CD -> GitHub Actions
18+
#
19+
# apisec-run-scan
20+
#
21+
# This action triggers the on-demand scans for projects registered in APIsec.
22+
# If your GitHub account allows code scanning alerts, you can then upload the sarif file generated by this action to show the scan findings.
23+
# Else you can view the scan results from the project home page in APIsec Platform.
24+
# The link to view the scan results is also displayed on the console on successful completion of action.
25+
26+
# This is a starter workflow to help you get started with APIsec-Scan Actions
27+
28+
name: APIsec
29+
30+
# Controls when the workflow will run
31+
on:
32+
# Triggers the workflow on push or pull request events but only for the "main" branch
33+
# Customize trigger events based on your DevSecOps processes.
34+
push:
35+
branches: [ "main" ]
36+
pull_request:
37+
branches: [ "main" ]
38+
schedule:
39+
- cron: '34 17 * * 3'
40+
41+
# Allows you to run this workflow manually from the Actions tab
42+
workflow_dispatch:
43+
44+
45+
permissions:
46+
contents: read
47+
48+
jobs:
49+
50+
Trigger_APIsec_scan:
51+
permissions:
52+
security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
53+
actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
54+
runs-on: ubuntu-latest
55+
56+
steps:
57+
- name: APIsec scan
58+
uses: apisec-inc/apisec-run-scan@025432089674a28ba8fb55f8ab06c10215e772ea
59+
with:
60+
# The APIsec username with which the scans will be executed
61+
apisec-username: ${{ secrets.apisec_username }}
62+
# The Password of the APIsec user with which the scans will be executed
63+
apisec-password: ${{ secrets.apisec_password}}
64+
# The name of the project for security scan
65+
apisec-project: "VAmPI"
66+
# The name of the sarif format result file The file is written only if this property is provided.
67+
sarif-result-file: "apisec-results.sarif"
68+
- name: Import results
69+
uses: github/codeql-action/upload-sarif@v3
70+
with:
71+
sarif_file: ./apisec-results.sarif

0 commit comments

Comments
 (0)