Documentation›Edge agent
Integrations

Edge agent

certone-agent runs on a gateway or device, watches a project folder and sends each new version for a confidential scan.

Before you start

  • Python 3.10 or later on the gateway, with outbound HTTPS to the platform.
  • A member API key, set as CERTONE_API_KEY (or mounted from a Kubernetes Secret).

In the CertOne console, open Developer Hub, then API keys. Name the key, choose the member role and select New key.

  • Copy the secret right away: it is shown only once.
  • Keys start with ck_ and expire after at most 365 days.
  • Creating keys requires the admin role in your organization.
  • A viewer key can read results but cannot submit scans.

Install and watch

Install certone-sdk, which provides certone-agent, then start watching. Use --mode confidential: the default mode, local, runs the engine on the device instead.

Shell
pip install certone-sdk
export CERTONE_API_KEY=ck_...
certone-agent watch --mode confidential --project binpick-sort \
  --asset "Bin-Pick Sorter Vision" --country-code EU --interval 30 \
  --api https://platform.certkor.ai

Options

OptionDefaultMeaning
--modelocalUse confidential to scan on the platform.
--apirequiredThe CertOne platform, https://platform.certkor.ai.
--project.The folder to watch.
--assetThe AI system's name in CertOne.
--country-codeZZWhere the system operates.
--teeamd_sev_snpamd_sev_snp or kata_cc.
--fail-onhighLowest severity that fails the verdict.
--interval300Seconds between checks for a new version.
--tokenCERTONE_API_KEYPrefer the variable, to keep the key out of the process list.

certone-agent run scans once instead of watching.

What you see

The agent fingerprints every file in the folder. When the fingerprint changes, it scans the new version:

Log
certone-agent: watching /home/dev/binpick-sort
certone-agent: Bin-Pick Sorter Vision -> confidential scan aed6... (sha256:...)
certone-agent: verdict FAIL (2 high, 8 medium, 1 low) in ...
certone-agent: new version detected (sha256:...)

Each verdict also appears in the console, under the AI system.

How it gates

  • watch keeps running whatever the verdict, and retries a failed scan on the next check.
  • run --mode confidential exits 0 on a pass, 1 on a fail and 2 on an error, so a deployment script can stop on it.