Get started

Quickstart

Five minutes from signup to your first scan.

1. Get an API key

Sign up at app.pentify.io/sign-up.
Verify ownership of a target hostname (DNS TXT or /.well-known/pentify-verify.txt).
Open Settings → API keys and click Create workspace key.
Copy the pk_live_* value. The full key is shown exactly once.

Note

If you don’t have a paid plan, the API also works after you buy a one-time token pack. See Tokens & pricing.

2. Install an SDK

npm install @pentify/sdk

3. Make a request

The example below creates a quick scan of an already-verified target and polls for completion. In production, prefer webhooks to skip the polling loop.

import { Pentify } from "@pentify/sdk";

const pentify = new Pentify({ apiKey: process.env.PENTIFY_API_KEY! });

const scan = await pentify.scans.create({
  target: "example.com",
  scanType: "quick",
});

let status = scan.status;
while (status === "queued" || status === "running") {
  await new Promise((r) => setTimeout(r, 5000));
  status = (await pentify.scans.retrieve(scan.id)).status;
}

console.log(`scan ${scan.id} finished: ${status}`);

Next steps

Authentication — key types and scopes.
API reference — full endpoint list.
Errors — error envelope, retry guidance.
Run your first scan — the full end-to-end recipe with target verification.