export ESCAPE_APPLICATION_ID=<YOUR APPLICATION ID>
export ESCAPE_API_KEY=<YOUR API KEY>
npm i -g @escape.tech/action
By default, Escape cli will fail if any High issues are flagged, and will exit with an error code 1.
The id of the application on Escape that will be scanned continuously.
You can find it in your Escape application settings.
Your API key on the Escape platform.
You can find it in your Escape settings.
The URL to your API schema, that you want to upload to the specific application
The filepath to your API schema, that you want to upload to the specific application
A csv-delimited string that should contain either of these severities to define a failure of the cli (exit code 1):
export FAIL_ON_SEVERITIES=HIGH,MEDIUM will make the cli fail if any HIGH or MEDIUM issues are flagged.
The timeout of the job. If set to 0, the scan will be started, but the job will not wait for it to be finished before terminating.
The triggered scan will run asynchronously on Escape, and your team will be notified once it is done using your desired notifications settings.
The path to the output file that will contain the scan results.