Skip to content

Commit 2660b93

Browse files
authored
Create apisec-scan.yml
1 parent d67be64 commit 2660b93

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

.github/workflows/apisec-scan.yml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
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.fxlabs.io/#/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: '28 22 * * 6'
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+
Trigger APIsec scan:
50+
permissions:
51+
security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
52+
runs-on: ubuntu-latest
53+
54+
steps:
55+
- name: APIsec scan
56+
uses: apisec-inc/apisec-run-scan@f62d0c6fae8a80f97b091a323befdb56e6ad9993
57+
with:
58+
# The APIsec username with which the scans will be executed
59+
apisec-username: ${{ secrets.apisec_username }}
60+
# The Password of the APIsec user with which the scans will be executed
61+
apisec-password: ${{ secrets.apisec_password}}
62+
# The name of the project for security scan
63+
apisec-project: "VAmPI"
64+
# The name of the sarif format result file The file is written only if this property is provided.
65+
sarif-result-file: "apisec-results.sarif"
66+
- name: Import results
67+
uses: github/codeql-action/upload-sarif@v2
68+
with:
69+
sarif_file: ./apisec-results.sarif

0 commit comments

Comments
 (0)