Skip to content
bucker

API reference

attack-summary

1 operation. Shapes are sketches of the declared schemas, bounded in depth — the authoritative document is linked from the index.

GET/orgs/{orgSlug}/projects/{projectSlug}/attack-summary

Requires bearerAuth

What the threat classifier found in the project over up to 30 days, as counts: categories, rules and fields, targeted endpoints, laned issues by review state, sources as keyed prefix buckets and user-agent families (never an address) and an outcome per probe class (refused and served read null until the span scan runs). A person’s own read: it carries telemetry text unfenced.

Parameters

Parameters for GET /orgs/{orgSlug}/projects/{projectSlug}/attack-summary
NameInTypeNotes
orgSlugrequiredpathstringmin length 1, max length 128
projectSlugrequiredpathstringmin length 1, max length 128
daysqueryintegerdefault 7, min 1, max 30

Response 200

{
  window: {
    from: string
    to: string
    days: integer
  }
  ipStorage: "on" | "off"
  totals: {
    hits: integer
    hours: integer
  }
  categories: {
    category: string
    hits: integer
  }[]
  rules: {
    rule: string
    category: string
    hits: integer
    fields: {
      field: string
      hits: integer
    }[]
  }[]
  endpoints: {
    endpoint: string
    hits: integer
  }[]
  lanes: Record<string, integer>
  sources: {
    distinctPrefixes: integer
    unknownHits: integer
    top: {
      bucket: string
      hits: integer
    }[]
    userAgentFamilies: {
      family: string
      hits: integer
    }[]
  }
  outcomes: {
    crashed: integer
    refused: integer | null
    served: integer | null
    spanCoverage: "none" | "sampled"
  }
  newestHour: string | null
  trust: {
    untrustedFields: string[]
    note: string
  }
}

Response 400 · `bad_request` — the path, query or body failed validation. `details` carries the Zod issues, one per offending field.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 401 · `unauthorized` — no credential, or one that is expired, revoked or not valid for this resource. `mfa_required` when the credential is good but a second factor is owed.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 403 · `forbidden` — the credential is valid and its scopes or this principal’s membership do not reach this resource. Scopes are re-intersected with live memberships on every request, so this can appear for a token that worked yesterday.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 404 · `not_found` — no such resource, OR one this principal cannot see. The two are deliberately one answer: a 403 would confirm the existence of something whose identifier is guessable.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 429 · `rate_limited` or `quota_exceeded` — over a ceiling. `Retry-After` says when to come back, and `x-ratelimit-limit` / `-remaining` / `-reset` describe the bucket.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 500 · `internal_error` — an unhandled failure on this side. The message is always generic; `requestId` is the part worth quoting.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Request

curl https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/attack-summary \
  -H "authorization: Bearer $BUCKER_TOKEN"