Information
- OpenAPI version:
3.0.3
Overview
nebty API 1.0.0
Section titled “nebty API 1.0.0”Read access to your brand-protection data in nebty: the brands being monitored, the domains found impersonating them, the scan results behind each finding and your takedown cases. You can also request a takedown.
Base URL: https://app.nebty.de
Authentication. Send your API key in the Authorization header as Authorization: Api-Key <key>. A key acts as the user it belongs to, and results are limited to what that user may see: the brands the user is a member of, and takedowns the user requested or that belong to one of those brands. Records you cannot see are treated as if they did not exist.
Identifiers are UUIDs.
Pagination. List endpoints are page-number paginated. Pass page (1-based) and page_size. The default page size is 50 and the maximum is 100. A paginated response is an object with count (total rows), next and previous (URLs or null) and results; the total is also sent in the X-Total-Count response header. Keep page_size and all filters unchanged while walking through pages.
Compact rows. The brand list and the per-brand domain and scan lists accept compact=true and then return a short summary per row instead of the full record with embedded scan history. Use it for lists and fetch a single domain for the full evidence. It is much lighter for large brands.
Undocumented fields. Responses can contain additional fields that are not documented here. They are not part of the public contract and can change or disappear without notice.
Authentication
Section titled “Authentication”ApiKeyAuth
Section titled “ApiKeyAuth”Static API key, sent in the Authorization header with the scheme Api-Key:
Authorization: Api-Key nbty_<your_key>The key is the whole credential after Api-Key (not Bearer). A key belongs to one nebty user and carries that user’s current rights, including the right to request takedowns.
Getting a key. Brand admins, partner and enterprise accounts with a verified email address create their key in the dashboard under Settings > API key. The full key is shown only once, so store it right away. Replacing the key makes the old one stop working at once, and so does revoking it. Creating, replacing and revoking a key work only from the dashboard, not with an API key. If your account cannot create a key, contact nebty.
A missing, revoked or unknown key is answered with 401.
Security scheme type: apiKey
Header parameter name: Authorization