API

DustOff inside your own tools

Anyone looking after many client sites doesn't want to check each one by hand. The API takes an address, checks it and answers with what stands out — as data that belongs in your own tooling.

Ask for access

What it does

Send one website and have it checked right away.
Get the result back as data: page, spot, reason, suggestion.
Fetch a check again later.
Ask for your own standing: plan, budget, what's left.

One round, start to finish

1
Ask
Send the address and the depth you want. DustOff reads the public site — nothing gets installed.
2
Receive
The check runs straight away and answers at once: how many pages were read and which spots stand out.
3
Place it
Put the result where the work happens: the client report, the ticket queue, the handover.

Request

The key travels in the request header. It doesn't belong in an address.

curl -X POST https://getdustoff.com/api/public/v1/pruefungen \
  -H "Authorization: Bearer dustoff_1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://beispiel.de", "seiten": 300, "sprache": "de" }'

Response

The same result can be fetched again later using the check's identifier.

{
  "pruefung": "b41d9f2c-6f1e-4a7c-9d3b-2c8a5e7f1042",
  "status": "fertig",
  "website": "https://beispiel.de",
  "seiten_gelesen": 148,
  "prueftiefe": 300,
  "grenze_erreicht": false,
  "stellen": [
    {
      "seite": "https://beispiel.de/aktuell",
      "titel": "Neuigkeiten",
      "art": "stale-year",
      "fundstelle": "© 2023",
      "begruendung": "Die Jahreszahl im Fuß stammt aus dem Vorjahr.",
      "vorschlag": "Jahreszahl auf das laufende Jahr setzen.",
      "sicherheit": 0.92,
      "wiederholungen": 12
    }
  ]
}

Limits

A key checks at the plan of its address.
A page budget per month, set when the key is issued.
Too many requests in a short time are slowed down.
The depth of a single check stays capped by the plan.

When something goes wrong

401: No key, a wrong one, or a revoked one.
400: That address couldn't be read as a website.
409: This website is being checked right now.
429: Too many requests, or the month's budget is used up.
503: The content check is switched off just now.

Access keys on request

DustOff issues keys by hand. A line with your name, address and the size you need is enough — the key and the address it belongs to follow.