syedsimran/Trigger Playbook Scan
Continuous, automated, comprehensive API Security Testing
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| apisec-hostname | HostName of APIsec | yes | "" |
| apisec-username | The APIsec username with which the scans will be executed | yes | "" |
| apisec-password | The Password of the APIsec user with which the scans will be executed | yes | "" |
| apisec-project | The Name of the project for security scan | yes | "" |
| apisec-profile | The Name of the scan profile to be executed | no | Master |
| apisec-region | The location/scanner name where the scan will be executed in | no | "" |
| sarif-result-file | The path to the sarif format result file | no | "" |
| apisec-email-report | To trigger scan email reports, set this value as "true" or else "false" | no | "" |
| apisec-report-Type | Type of Report to be send with trigger scan email, with possible valuess as these "RUN_SUMMARY", "RUN_DETAIL", "PROJECT_SUMMARY", "PROJECT_DETAIL", "PROJECT_PEN_TEST_REPORT", "DEVELOPER_REPORT", "COMPLIANCE" | no | "" |
| apisec-fail-on-vuln-severity | Pass the vulnerable seveity string to break pipeline execution with allowed values are Critical, High and Medium severity. | no | "" |
| apisec-refresh-playbooks | To regenerate/refresh the playbooks of a project, set this value as "true" or else "false" | no | "" |
| apisec-openapi-spec-url | OpenAPI Spec Url for registering a project like "http://netbanking.apisec.ai:8080/v2/api-docs" | no | "" |
| apisec-openapi-spec-file | Path where OpenAPI Spec File is avaiable like "netbanking.json" if spec file available at present working directory | no | "" |
| apisec-internal-openapi-spec-url | OpenAPI Spec Url for registering a project like "http://netbanking.apisec.ai:8080/v2/api-docs" for special use-case like Github Actions | no | "" |
| apisec-spec-type | To be used while using "apisec-internal-openapi-spec-url parameter for type of spec like "json" for json-content specs and "yaml" for yaml-content specs | no | "" |
| apisec-profile-scanner | Name of the scanner like "US_EAST_1" with which profile like "Master" needs to be configured | no | "" |
| apisec-env-name | Environment Name like "Master" of an existing project | no | "" |
| apisec-auth-name | Auth Name like "Default" of existing environment of an existing project | no | "" |
| apisec-app-username | Username of the OpenAPISpec application | no | "" |
| apisec-app-password | Password of the OpenAPISpec application | no | "" |
| apisec-app-endpoint-url | Token endpoint url of the OpenAPISpec application like https://netbanking.apisec.ai:8080/login | no | "" |
| apisec-app-token_param | Token param of the OpenAPISpec application like ".info.token" or ".token" | no | "" |
| apisec-tier | Type of categories on scans needs to be triggered with possibles values "tier0", "tier1", "tier2", "tier3", | no | "" |
| apisec-category | To scan one specific category like "Unsecured", "ABAC_Level1"., etc | no | "" |
Outputs
no outputs