Synopsis

fcli sc-sast rest call [--no-paging] [-d=<data>] [-X=<httpMethod>] [[-h] [--env-prefix=<prefix>] [--log-file=<logFile>] [--log-level=<logLevel>] [--log-mask=<level>] [--debug]] [[--no-transform] | -t=<expr>] [[-o=<type+args>] [--style*=<style>,…​]…​ ] [--to-file=<outputFile>_]] [-q=<SpEL expression>] [[--ssc-session=<sessionName>]] <uri>

Description

Options

-d, --data=<data>

Data to send in the request body. This option takes either a string to be sent as request body, or @@<file> to send the contents of the given file as the request body (note the double at-sign). This option is not available for GET requests.

--no-paging

This option currently has no effect for ScanCentral SAST.

--no-transform

This option currently has no effect for ScanCentral SAST.

-q, --query=<SpEL expression>

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

-t, --transform=<expr>

This option allows for performing custom transformations on the response data based on a Spring Expression Language (SpEL) expression. For example, this allows for retrieving data from sub-properties, or using project selection/projection. Note that the expression operates on the raw response, as if --no-transform was specified before evaluating the expression.

-X, --request=<httpMethod>

HTTP method/verb to use for the API request, like GET, POST, DELETE, …​ Default value: GET.

SSC session name options

--ssc-session=<sessionName>

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

Output options (also see documentation link below)

-o, --output=<type+args>

Select output type (csv, table, expr, json, xml, yaml) and optional type arguments.

--store=<var>[:<prop>]

Store JSON results in an fcli variable for later reference.

*--style*=<style>,…​

Select output style: header, no-header, pretty, no-pretty, flat, no-flat, array, single, border, no-border, md-border.

--to-file=<outputFile>

Write output to the specified file.

Generic fcli options (also see documentation link below)

--debug

Enable collection of debug logs.

--env-prefix=<prefix>

Prefix for resolving default option values. Default value: FCLI_DEFAULT.

-h, --help

Use 'fcli [command] -h' to display help for fcli (sub-)commands.

--log-file=<logFile>

Write log output to file. Default: ./fcli.log if logging is enabled.

--log-level=<logLevel>

Set logging level: TRACE, DEBUG, INFO, WARN, ERROR, NONE.

--log-mask=<level>

Log mask level: high, medium, low, none. Default: medium. Masking is done on a best-effort basis; no guarantee that all sensitive data will be masked.

Arguments

<uri>

Relative URI to the REST API endpoint that you want to invoke.