Kubescape Microservice API

Running kubescape will start up a webserver on port 8080 which will serve the following API's:

Trigger scan

  • POST /v1/scan - trigger a kubescape scan. The server will return an ID and will execute the scanning asynchronously. the request body should look as followed.
    • wait=true: scan synchronously (return results and not ID). Use only in small clusters or with an increased timeout. default is wait=false
    • keep=true: do not delete results from local storage after returning. default is keep=false
  • POST /v1/metrics - trigger kubescape for Prometheus support. read more

Response:

{
  "id": <str>,                      // scan ID
  "type": "busy",                   // response object type
  "response": <message:string>      // message indicating scanning is still in process
}

When scanning was triggered with the wait=true query param, the response is like the /v1/results API response

Get results

  • GET /v1/results - request kubescape scan results
    • query id=<string> -> request results of a specific scan ID. If empty will return latest results
    • query keep=true -> keep the results in the local storage after returning. default is keep=false - the results will be deleted from local storage after they are returned

Response:

When scanning was done successfully

{
  "id": <str>,                      // scan ID
  "type": "v1results",              // response object type
  "response": <object:v1results>    // v1 results payload
}

When scanning failed

{
  "id": <str>,                  // scan ID
  "type": "error",              // response object type
  "response": <error:string>    // error string
}

When scanning is in progress

{
  "id": <str>,                    // scan ID
  "type": "busy",                 // response object type
  "response": <message:string>    // message indicating scanning is still in process
}

Check scanning progress status

Check the scanning status - is the scanning in progress or done. This is meant for a waiting mechanize since the API does not return the entire results object when the scanning is done

  • GET /v1/status - Request kubescape scan status
    • query id=<string> -> Check status of a specific scan. If empty will check if any scan is in progress

Response:

When scanning is in progress

{
  "id": <str>,                    // scan ID
  "type": "busy",                 // response object type
  "response": <message:string>    // message indicating scanning is still in process
}

When scanning is not in progress

{
  "id": <str>,                    // scan ID
  "type": "notBusy",              // response object type
  "response": <message:string>    // message indicating scanning is done in process
}

Delete cached results

  • DELETE /v1/results - Delete kubescape scan results from storage. If empty will delete latest results
    • query id=<string>: Delete ID of specific results
    • query all: Delete all cached results

Prometheus support API

  • GET/POST /v1/metrics - will trigger cluster scan. will respond with Prometheus metrics once they have been scanned. This will respond 503 if the scan failed.
  • /livez - will respond 200 when the server is alive
  • /readyz - will respond 200 when the server can receive requests

Objects

Trigger scan object

{
  "format": <str>,               // results format [default: json] (same as 'kubescape scan --format')
  "excludedNamespaces": [<str>], // list of namespaces to exclude (same as 'kubescape scan --excluded-namespaces')
  "includeNamespaces": [<str>],  // list of namespaces to include (same as 'kubescape scan --include-namespaces')
  "useCachedArtifacts"`: <bool>, // use the cached artifacts instead of downloading (offline support)
  "submit": <bool>,              // submit results to Kubescape cloud (same as 'kubescape scan --submit')
  "hostScanner": <bool>,         // deploy kubescape K8s host-scanner DaemonSet in the scanned cluster (same as 'kubescape scan --enable-host-scan')
  "keepLocal": <bool>,           // do not submit results to Kubescape cloud (same as 'kubescape scan --keep-local')
  "account": <str>,              // account ID (same as 'kubescape scan --account')
  "targetType": <str>,           // framework/control
  "targetNames": [<str>]         // names. e.g. when targetType==framework, targetNames=["nsa", "mitre"]
}

Response object

{
  "id": <str>,                      // scan ID
  "type": <responseType:str>,       // response object type
  "response": <object:interface>    // response payload as list of bytes
}

Response object types

  • "v1results" - v1 results object
  • "busy" - server is busy processing previous requests
  • "notBusy" - server is not busy processing previous requests
  • "ready" - server is done processing request and results are ready
  • "error" - error object

API Examples

Default scan

  1. Trigger kubescape scan
curl --header "Content-Type: application/json" --request POST --data '{"hostScanner":true, "submit": true}' http://127.0.0.1:8080/v1/scan
  1. Get kubescape scan results
curl --request GET http://127.0.0.1:8080/v1/results -o response.json

Trigger scan and wait for the scan to end

curl --header "Content-Type: application/json" --request POST --data '{"hostScanner":true, "submit": true}' http://127.0.0.1:8080/v1/scan?wait -o scan_results.json

Scan single namespace with a specific framework

curl --header "Content-Type: application/json" \
  --request POST \
  --data '{"hostScanner":true, "submit":true, "includeNamespaces": ["ks-scanner"], "targetType": "framework", "targetNames": ["nsa"] }' \
  http://127.0.0.1:8080/v1/scan

Supported environment variables

  • KS_ACCOUNT: Account ID
  • KS_SUBMIT: Submit the results to Kubescape SaaS version
  • KS_EXCLUDE_NAMESPACES: List of namespaces to exclude, e.g. KS_EXCLUDE_NAMESPACES=kube-system,kube-public
  • KS_INCLUDE_NAMESPACES: List of namespaces to include, rest of the namespaces will be ignored. e.g. KS_INCLUDE_NAMESPACES=dev,prod
  • KS_HOST_SCAN_YAML: Full path to the host scanner YAML
  • KS_FORMAT: Output file format. default is json
  • KS_ENABLE_HOST_SCANNER: Enable the host scanner feature
  • KS_DOWNLOAD_ARTIFACTS: Download the artifacts every scan

Did this page help you?