Skip to content
bucker

API reference

findings

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

GET/orgs/{orgSlug}/projects/{projectSlug}/findings

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/projects/{projectSlug}/findings
NameInTypeNotes
orgSlugrequiredpathstringmin length 1, max length 128
projectSlugrequiredpathstringmin length 1, max length 128
kindquerystringmin length 1, max length 400
statusquerystringmin length 1, max length 400
severityquerystringmin length 1, max length 400
evidenceClassquerystringmin length 1, max length 400
environmentquerystringmin length 1, max length 64
servicequerystringmin length 1, max length 120
releasequerystringmin length 1, max length 128
ownerquerystringmin length 1, max length 80
includequerystringmin length 1, max length 400
limitqueryintegermin 1, max 50
cursorquerystringmin length 1, max length 500

Response 200

{
  ruleSet: {
    version: integer
    ranking: string[]
    thresholds: Record<string, object>
  }
  freshness: {
    newestObservationAt: string | null
    computedAt: string
  }
  scanned: integer
  truncated: boolean
  findings: {
    id: string
    kind: "secret_exposure" | "pii_exposure" | "bucker_credential_exposure" | "attack_probe" | "credential_stuffing" | "api_shadow_endpoint" | "api_orphan_endpoint" | "api_schema_drift" | … 15 more
    rule: string
    ruleSetVersion: string
    location: Record<string, string | number>
    service: string | null
    environment: string | null
    status: "open" | "suppressed" | "accepted_risk" | "resolved" | "auto_closed"
    severity: "critical" | "high" | "medium" | "low" | "info"
    baseSeverity: "critical" | "high" | "medium" | "low" | "info"
    provenance: "scm_signed" | "first_party" | "token" | "dsn"
    owner: {
      ref: string
      basis: string | null
    } | null
    issueId: string | null
    firstSeenAt: string
    lastSeenAt: string
    firstRelease: string | null
    count: number
    evidenceCounts: {
      traces: number
      events: number
      sessions: number
      releases: number
    }
    signals: {
      kev: boolean
      malicious: boolean
      publicEndpoint: boolean
      personalData: boolean
    }
    rankedBy: string[]
    revision: integer
  }[]
  nextCursor: string | null
  coverage: {
    kind: "secret_exposure" | "pii_exposure" | "bucker_credential_exposure" | "attack_probe" | "credential_stuffing" | "api_shadow_endpoint" | "api_orphan_endpoint" | "api_schema_drift" | … 15 more
    state: "findings_present" | "ran_no_findings" | "not_checked"
    reason: "writer_not_built" | "no_recent_run" | null
    writerCard: string
    openFindings: integer
    totalFindings: integer
    lastRunAt: string | null
    lastFindingAt: string | null
  }[]
  include: {
    policy?: {
      scopeVersion: string
      ratified: boolean
      asOf: string
      humanOnlyActs: object[]
      doc: string
      detectionPolicy: object
    }
    detectors?: {
      state: "available"
      card: "SEC-18"
      ruleSetVersion: integer
      rules: object[]
    }
    suppressions?: {
      state: "available"
      policy: object
      total: integer
      live: object[]
    }
  }
}

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}/findings \
  -H "authorization: Bearer $BUCKER_TOKEN"

GET/orgs/{orgSlug}/projects/{projectSlug}/findings/{findingId}

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/projects/{projectSlug}/findings/{findingId}
NameInTypeNotes
orgSlugrequiredpathstringmin length 1, max length 128
projectSlugrequiredpathstringmin length 1, max length 128
findingIdrequiredpathstringmin length 1, max length 64
includequerystringmin length 1, max length 400

Response 200

{
  ruleSet: {
    version: integer
    ranking: string[]
    thresholds: Record<string, object>
  }
  freshness: {
    newestObservationAt: string
    computedAt: string
  }
  finding: {
    id: string
    kind: "secret_exposure" | "pii_exposure" | "bucker_credential_exposure" | "attack_probe" | "credential_stuffing" | "api_shadow_endpoint" | "api_orphan_endpoint" | "api_schema_drift" | … 15 more
    rule: string
    ruleSetVersion: string
    location: Record<string, string | number>
    service: string | null
    environment: string | null
    status: "open" | "suppressed" | "accepted_risk" | "resolved" | "auto_closed"
    severity: "critical" | "high" | "medium" | "low" | "info"
    baseSeverity: "critical" | "high" | "medium" | "low" | "info"
    provenance: "scm_signed" | "first_party" | "token" | "dsn"
    owner: {
      ref: string
      basis: string | null
    } | null
    issueId: string | null
    firstSeenAt: string
    lastSeenAt: string
    firstRelease: string | null
    count: number
    evidenceCounts: {
      traces: number
      events: number
      sessions: number
      releases: number
    }
    signals: {
      kev: boolean
      malicious: boolean
      publicEndpoint: boolean
      personalData: boolean
    }
    rankedBy: string[]
    revision: integer
  }
  issue: {
    id: string
    shortId: string
    status: string
  } | null
  evidence?: {
    traceIds: string[]
    eventIds: string[]
    sessionIds: string[]
    releases: string[]
  }
  history?: {
    days: {
      day: string
      release: string
      count: number
    }[]
    triage: {
      at: string
      actorMode: string
      field: string | null
      before: object | null
      after: object | null
    }[]
  }
  suggestions?: {
    at: string
    field: string
    value: string
    rationale: string
  }[]
  suppressions?: {
    state: "not_available"
    card: 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}/findings/{findingId} \
  -H "authorization: Bearer $BUCKER_TOKEN"

PATCH/orgs/{orgSlug}/projects/{projectSlug}/findings/{findingId}

Requires bearerAuth

Parameters

Parameters for PATCH /orgs/{orgSlug}/projects/{projectSlug}/findings/{findingId}
NameInTypeNotes
orgSlugrequiredpathstringmin length 1, max length 128
projectSlugrequiredpathstringmin length 1, max length 128
findingIdrequiredpathstringmin length 1, max length 64

Request body (required) · application/json

{
  status?: "open" | "resolved" | "accepted_risk"
  owner?: string | null
  severity?: "critical" | "high" | "medium" | "low" | "info"
  issueId?: string | null
  suggestion?: {
    field: "owner" | "severity" | "status"
    value: string
    rationale: string
  }
  reason?: string
  approvalRequestId?: string
}

Response 200

{
  status: "applied"
  findingId: string
  operationId: string
  decision: "ALLOW" | "APPROVED"
  riskClass: string
  planDigest: string
  versionAfter: string
  receiptSigned: boolean
} | {
  status: "suggestion_recorded"
  findingId: string
  draft: {
    field: string
    value: string
  }
}

Response 202

{
  status: "approval_required" | "inert_draft"
  findingId: string
  operationId: string
  approvalRequestId: string | null
  riskClass: string
  planDigest: string
  eligibleApprovers?: integer
  minApprovers?: integer
}

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 -X PATCH https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/findings/{findingId} \
  -H "authorization: Bearer $BUCKER_TOKEN" \
  -H 'content-type: application/json' \
  -d '{ … }'

GET/orgs/{orgSlug}/projects/{projectSlug}/findings/{findingId}/leak-response

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/projects/{projectSlug}/findings/{findingId}/leak-response
NameInTypeNotes
orgSlugrequiredpathstringmin length 1, max length 128
projectSlugrequiredpathstringmin length 1, max length 128
findingIdrequiredpathstringmin length 1, max length 64

Response 200

{
  findingId: string
  projectId: string
  kind: string
  rule: string
  ruleClass: "credential" | "entropy" | "pii" | null
  pathTemplate: string
  window: {
    from: string
    to: string
  }
  issue: {
    id: string
    shortId: string
    status: string
    title: string
  } | null
  evidence: {
    eventIds: number
    traceIds: number
    releases: string[]
  }
  fixAtSource: {
    tool: "start_remediation"
    available: boolean
    issueId: string | null
    merge: "human"
  }
  redaction: {
    tool: "scrub_rule_propose"
    approval: "ask_floor"
    addOnly: true
    draft: {
      proposal: object
      selects: string
    } | null
    reason: string | null
  }
  storedLogs: {
    selectable: boolean
    selection: {
      from: string
      to: string
      where: string | null
    } | null
    scope: "has_key" | "window_only" | null
    matchedRecords: number | null
    humanOnly: true
    actions: {
      purge: string
      rescrub: string
    }
    cancelWindowHours: number
    order: "redact_then_rescrub"
  }
}

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}/findings/{findingId}/leak-response \
  -H "authorization: Bearer $BUCKER_TOKEN"

GET/orgs/{orgSlug}/projects/{projectSlug}/findings/{findingId}/raw-envelopes

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/projects/{projectSlug}/findings/{findingId}/raw-envelopes
NameInTypeNotes
orgSlugrequiredpathstringmin length 1, max length 128
projectSlugrequiredpathstringmin length 1, max length 128
findingIdrequiredpathstringmin length 1, max length 64

Response 200

{
  findingId: string
  projectId: string
  window: {
    from: string
    to: string
  }
  envelopes: integer
  inline: integer
  objects: integer
  unfinished: integer
  retentionDays: integer
  earliestExpiry: string | null
  latestExpiry: string | null
  expired: boolean
  pendingPurge: {
    purgeId: string
    executeAfter: string
    envelopes: integer
  } | null
}

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}/findings/{findingId}/raw-envelopes \
  -H "authorization: Bearer $BUCKER_TOKEN"

POST/orgs/{orgSlug}/projects/{projectSlug}/findings/{findingId}/raw-envelopes/purge

Requires bearerAuth

Parameters

Parameters for POST /orgs/{orgSlug}/projects/{projectSlug}/findings/{findingId}/raw-envelopes/purge
NameInTypeNotes
orgSlugrequiredpathstringmin length 1, max length 128
projectSlugrequiredpathstringmin length 1, max length 128
findingIdrequiredpathstringmin length 1, max length 64

Request body (required) · application/json

{
  reason: string
  acknowledgeEnvelopes: integer
}

Response 202

{
  purgeId: string
  findingId: string
  envelopes: integer
  window: {
    from: string
    to: string
  }
  executeAfter: string
  cancelWindowMinutes: integer
}

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 -X POST https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/findings/{findingId}/raw-envelopes/purge \
  -H "authorization: Bearer $BUCKER_TOKEN" \
  -H 'content-type: application/json' \
  -d '{ … }'

POST/orgs/{orgSlug}/projects/{projectSlug}/findings/{findingId}/raw-envelopes/purge/{purgeId}/cancel

Requires bearerAuth

Parameters

Parameters for POST /orgs/{orgSlug}/projects/{projectSlug}/findings/{findingId}/raw-envelopes/purge/{purgeId}/cancel
NameInTypeNotes
orgSlugrequiredpathstringmin length 1, max length 128
projectSlugrequiredpathstringmin length 1, max length 128
findingIdrequiredpathstringmin length 1, max length 64
purgeIdrequiredpathstringmin length 1, max length 64

Response 200

{
  purgeId: string
  cancelled: true
}

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 -X POST https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/findings/{findingId}/raw-envelopes/purge/{purgeId}/cancel \
  -H "authorization: Bearer $BUCKER_TOKEN"