Synopsis

fcli fod dast-scan setup-api [--false-positive-removal] --assessment-type=<assessmentType> [--delim=<delimiter>] [--entitlement-id=<entitlementId>] [--environment=<environmentFacingType>] [-f=<file>] [--file-id=<fileId>] --frequency=<entitlementFrequencyType> [--host=<apiHost>] [--key=<apiKey>] [--network-auth-type=<networkAuthenticationType>] [-p=<password>] --rel=id|app[:ms]:rel [--scheme-type=<apiSchemeType>] [--service-path=<apiServicePath>] [--timebox=<timebox>] [--timezone=<timezone>] --type=<apiType> [-u=<username>] [--url=<apiUrl>] [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] [[--session=<sessionName>]] ] [--store=_variableName[: _ <propertyNames>]] [--to-file=<outputFile>_]]

Description

This command is intended for preview only. Command name, options and behavior may change at any time, even between patch or minor releases, potentially affecting any workflows in which this command is being used. To correctly setup a scan you will need to provide the name of the assessment type using the '--assessment-type=xxx' option. Since assessment types can potentially be configured differently for each tenant, you can find the correct name using the 'fod rest lookup AssessmentTypes' command. If you know the Id of an entitlement that you want to use then you can supply it to the '--entitlement-id=xxx' option. If not, you can supply both '--assessment-type' and '--entitlement-frequency' options and the command will try to find an appropriate entitlement. In order to use an OpenAPI specification, Postman collection, GraphQL schema file or GRPC proto file, you can upload it directly using the '--file' option, or you can refer to a previously uploaded File Id that was uploaded using the 'fod dast-scan upload-file' command.

Options

--assessment-type=<assessmentType>

The type of DAST assessment to carry out. Use 'fod rest lookup AssessmentTypes' to display valid values.

--delim=<delimiter>

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

--entitlement-id=<entitlementId>

Entitlement Id to use. If not specified Frequency and Assessment Type will be used to find one.

--environment=<environmentFacingType>

The public facing visibility of the environment. Valid values: Internal, External.

-f, --file=<file>

An OpenAPI specification, Postman collection, GraphQL schema file or GRPC proto file.

--false-positive-removal

Request false positive removal by the testing team (once per application).

--file-id=<fileId>

The file Id of a Workflow Macro previously uploaded using the 'fod dast-scan upload-file' command.

--frequency, --entitlement-frequency=<entitlementFrequencyType>

The entitlement frequency type to use. Valid values: SingleScan, Subscription.

--host=<apiHost>

API Host.

--key, --api-key=<apiKey>

API Key to use for authentication.

--network-auth-type=<networkAuthenticationType>

The Network Authentication type to use. Valid values: Basic, NTLM, Kerberos, Digest, Automatic, ADFS_CBT.

-p, --network-password=<password>

The Network Password to use.

--rel, --release=id|app[:ms]:rel

Release id or <application>[:<microservice>]:<release> name.

--scheme-type=<apiSchemeType>

API Scheme Type. Valid values: HTTP, HTTPS, HTTPandHTTPs.

--service-path=<apiServicePath>

API Service Path.

--timebox=<timebox>

Timebox for the scan duration (in hours).

--timezone=<timezone>

The timezone in which the website is running in.

--type=<apiType>

The type of API to scan. Valid Values: OpenApi, Postman, GraphQL, GRPC

-u, --network-username=<username>

The Network Username to use.

--url, --api-url=<apiUrl>

The URL to the API definition file.

Session options

--session=<sessionName>

Name of the FoD session to use for executing this command. Default value: default.

Output options

-o, --output=format[=<options>]

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

--store=variableName[:<propertyNames>]

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

--to-file=<outputFile>

Write command output to the specified file instead of stdout.

Generic fcli options

--env-prefix=<envPrefix>

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

-h, --help

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

--log-file=<logFile>

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

--log-level=<logLevel>

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.