Working with REST API

Interaction with the KESL container is implemented using the REST API.

Using the REST API, you can submit the following requests:

• Scan a file or multiple files. For this purpose, submit a scan request (POST).

  Example: POST http://<server>:<port>/scans One or multiple files.

• Scan a Docker image or multiple Docker images. For this purpose, submit a scan request (POST).

  Example: POST http://<server>:<port>/scans Link to the Docker images to scan.

• Scan a Docker image or multiple Docker images with additional settings. For this purpose, submit a scan request (POST).

  Example: POST http://<server>:<port>/scans JSON of a certain type.

• Get a list of scan sessions. For this purpose, send a request for information on scan sessions (GET).

  Example: GET http://<server>:<port>/scans

• Get information on a scan session. For this purpose, send a request for information on scan sessions (GET).

  Example: GET http://<server>:<port>/scans/<unique scan session identifier>

• Add a registry certificate without reloading the KESL container. For this purpose, submit a request for adding a registry certificate (POST).

  Example: POST http://<server>:<port>/addcert

• Get information about the state of the KESL container. To do this, send a request to receive information about the state of the KESL container (GET).

  Example: GET http://<server>:<port>/status

Page top