Protet

Docs / Getting started

Getting started

From signup to a running on-prem deployment. This is the same flow the dashboard walks you through — shown here as raw API calls if you'd rather script it.

1. Create an account

Self-serve signup starts you on the free tier — no card required.

curl -X POST https://protet.io/auth/signup \
  -H "Content-Type: application/json" \
  -d '{"email": "you@example.com", "password": "a-strong-password", "name": "Your Company"}'

Response is always the same shape whether or not the address was already registered — check your inbox either way:

{"status": "pending_verification", "customer_id": "..."}

2. Verify your email

The verification email contains a link with a token. Verifying activates your account, provisions your free-tier license, and mints your first pull token in one step:

curl -X POST https://protet.io/auth/verify \
  -H "Content-Type: application/json" \
  -d '{"token": ""}'
{
  "status": "active",
  "license": { "payload": "...", "sig": "...", "alg": "ed25519" },
  "pull_token": ""
}

3. Pull your first model bundle

The pull token authenticates a single, token-only URL — nothing about the underlying model setup is ever exposed in it:

curl -H "x-license-key: <your pull token>" https://protet.io/v1/bundle -o bundle.tar.gz

The first pull for a given model version returns 202 and schedules a build — retry after a few seconds until you get a 200 with the archive. Every later pull of the same version is an immediate cache hit.

4. Verify and deploy the bundle

The archive contains manifest.json, manifest.sig, and the detection model and its supporting files. Verify manifest.sig against Protet's public signing key before trusting the contents:

curl https://protet.io/v1/public-keys

Point your on-prem detection pipeline at the bundle: MODEL_BUNDLE_URL=https://protet.io/v1/bundle, MODEL_BUNDLE_KEY=<your pull token>. See Architecture for what the pipeline does with it, and Integrations for wiring findings into your SIEM.

Architecture →