Skip to content

API client (cs-api) manual🔗

Configuration🔗

  • --profile-id: ID of the profile you want to use to analyze the trace. You can use the list-profiles command to get the IDs of the existing profiles.
  • --trace-id: ID of the trace to analyze
  • -k, --api-key: API key, can also be defined using the CRYPTOSENSE_API_KEY environment variable
  • --ca-file: Path to a file containing PEM encoded certificates to be trusted, to override the default CA file. This has no effect if certificate checking is disabled (it is enabled by default).
  • --no-check-certificate: Don’t check remote certificates. This is useful for when AQtive Guard is installed on-premises with self-signed certificates. For security, certificate checking is enabled by default.
  • -u, --api-base-url: (absent=https://analyzer.cryptosense.com) Base URL of the API server.
  • --help: Information about all the command-line option

Upload to a local instance of AQtive Guard🔗

Use the --api-base-url parameter to point the CLI at your local instance.

If you are using self-signed certificates or a custom CA, you can provide a custom CA file with the --ca-file path/to/cabundle.pem option.

HTTP Proxies🔗

If you need to route your request through a proxy, set the http_proxy or https_proxy environment variable to the URL of your proxy endpoint.

Note

Note that, for now, the --no-check-certificate option has no effect on the checking of the proxy certificate: it is always checked.

For more advanced configuration, please refer to the curl documentation.