Skip to content

Commit 2409c9f

Browse files
committed
Added AF API example
Signed-off-by: Simon Bennetts <[email protected]>
1 parent 882dbc0 commit 2409c9f

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

other/af-plans/ApiScanExample.yaml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
# An API plan that will not do anything unless you add one or more suitable API definitions.
3+
# You need to define at least one graphql, openapi, or soap endpoint, then you can delete the API jobs that don't have one.
4+
env:
5+
contexts:
6+
- name: "Example"
7+
urls:
8+
- "${ZAP_TARGET}"
9+
includePaths: []
10+
excludePaths: []
11+
parameters:
12+
failOnError: true
13+
failOnWarning: false
14+
progressToStdout: true
15+
vars: {}
16+
jobs:
17+
- parameters:
18+
scanOnlyInScope: true
19+
enableTags: false
20+
rules: []
21+
name: "passiveScan-config"
22+
type: "passiveScan-config"
23+
24+
- type: "graphql"
25+
parameters:
26+
endpoint: # String: the endpoint URL, default: null, no schema is imported
27+
schemaUrl: # String: URL pointing to a GraphQL Schema, default: null, import using introspection on endpoint
28+
schemaFile: # String: Local file path of a GraphQL Schema, default: null, import using schemaUrl
29+
30+
- type: "openapi"
31+
parameters:
32+
apiFile: # String: Local file containing the OpenAPI definition, default: null, no definition will be imported
33+
apiUrl: # String: URL containing the OpenAPI definition, default: null, no definition will be imported
34+
targetUrl: # String: URL which overrides the target defined in the definition, default: null, the target will not be overridden
35+
36+
- type: soap
37+
parameters:
38+
wsdlFile: # String: Local file path of the WSDL, default: null, no definition will be imported
39+
wsdlUrl: # String: URL pointing to the WSDL, default: null, no definition will be imported
40+
41+
- parameters:
42+
policyDefinition:
43+
defaultStrength: "medium"
44+
defaultThreshold: "medium"
45+
rules: []
46+
name: "activeScan"
47+
type: "activeScan"
48+
- parameters: {}
49+
name: "passiveScan-wait-pre-report"
50+
type: "passiveScan-wait"
51+
- parameters:
52+
template: "modern"
53+
reportTitle: "ZAP Scanning Report"
54+
reportDescription: ""
55+
name: "report"
56+
type: "report"

0 commit comments

Comments
 (0)