Skip to content
bucker

API reference

review-mode

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

GET/orgs/{orgSlug}/projects/{projectSlug}/review-mode

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/projects/{projectSlug}/review-mode
NameInTypeNotes
orgSlugrequiredpathstringmin length 1
projectSlugrequiredpathstringmin length 1

Response 200

{
  mode: "HUMAN_REVIEW" | "AUTO" | null
  goals: {
    riskCeiling?: "ELEVATED" | "SENSITIVE" | null
    protectedEnvironments?: unknown[]
    changeWindows?: unknown[]
    blastRadiusAudienceShareCap?: number | null
    blastRadiusTrafficShareCap?: number | null
    errorBudgetFloor?: number | null
    requireVerification?: boolean
    requireInverse?: boolean
    context?: string | null
  } | null
  stored: boolean
  updatedAt: string | null
  effective: {
    mode: "HUMAN_REVIEW" | "AUTO"
    source: "org" | "project"
    goals: {
      riskCeiling: "ELEVATED" | "SENSITIVE" | null
      protectedEnvironments: unknown[]
      changeWindows: unknown[]
      blastRadiusAudienceShareCap: number | null
      blastRadiusTrafficShareCap: number | null
      errorBudgetFloor: number | null
      requireVerification: boolean
      requireInverse: boolean
      autoDeployEnvironments: object
      productionAutoDeploy: object
      context: string | 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}/review-mode \
  -H "authorization: Bearer $BUCKER_TOKEN"

PUT/orgs/{orgSlug}/projects/{projectSlug}/review-mode

Requires bearerAuth

Parameters

Parameters for PUT /orgs/{orgSlug}/projects/{projectSlug}/review-mode
NameInTypeNotes
orgSlugrequiredpathstringmin length 1
projectSlugrequiredpathstringmin length 1

Request body (required) · application/json

{
  mode?: "HUMAN_REVIEW" | "AUTO" | null
  goals?: {
    riskCeiling?: "ELEVATED" | "SENSITIVE" | null
    protectedEnvironments?: string[]
    changeWindows?: {
      days: integer[]
      start: string
      end: string
      tz: string
    }[]
    blastRadiusAudienceShareCap?: number | null
    blastRadiusTrafficShareCap?: number | null
    errorBudgetFloor?: number | null
    requireVerification?: boolean
    requireInverse?: boolean
    context?: string | null
  } | null
}

Response 200

{
  mode: "HUMAN_REVIEW" | "AUTO" | null
  goals: {
    riskCeiling?: "ELEVATED" | "SENSITIVE" | null
    protectedEnvironments?: unknown[]
    changeWindows?: unknown[]
    blastRadiusAudienceShareCap?: number | null
    blastRadiusTrafficShareCap?: number | null
    errorBudgetFloor?: number | null
    requireVerification?: boolean
    requireInverse?: boolean
    context?: string | null
  } | null
  stored: boolean
  updatedAt: string | null
  effective: {
    mode: "HUMAN_REVIEW" | "AUTO"
    source: "org" | "project"
    goals: {
      riskCeiling: "ELEVATED" | "SENSITIVE" | null
      protectedEnvironments: unknown[]
      changeWindows: unknown[]
      blastRadiusAudienceShareCap: number | null
      blastRadiusTrafficShareCap: number | null
      errorBudgetFloor: number | null
      requireVerification: boolean
      requireInverse: boolean
      autoDeployEnvironments: object
      productionAutoDeploy: object
      context: string | 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 -X PUT https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/review-mode \
  -H "authorization: Bearer $BUCKER_TOKEN" \
  -H 'content-type: application/json' \
  -d '{ … }'

GET/orgs/{orgSlug}/review-mode

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/review-mode
NameInTypeNotes
orgSlugrequiredpathstringmin length 1

Response 200

{
  mode: "HUMAN_REVIEW" | "AUTO"
  description: string
  goals: {
    riskCeiling: "ELEVATED" | "SENSITIVE" | null
    protectedEnvironments: unknown[]
    changeWindows: unknown[]
    blastRadiusAudienceShareCap: number | null
    blastRadiusTrafficShareCap: number | null
    errorBudgetFloor: number | null
    requireVerification: boolean
    requireInverse: boolean
    autoDeployEnvironments: Record<string, object>
    productionAutoDeploy: {
      enabled: boolean
      optedInByPrincipalId: string | null
      optedInAt: string | null
      stepUpDigest: string | null
    }
    context: string | null
  }
  stored: boolean
  updatedAt: string | 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}/review-mode \
  -H "authorization: Bearer $BUCKER_TOKEN"

PUT/orgs/{orgSlug}/review-mode

Requires bearerAuth

Parameters

Parameters for PUT /orgs/{orgSlug}/review-mode
NameInTypeNotes
orgSlugrequiredpathstringmin length 1

Request body (required) · application/json

{
  mode?: "HUMAN_REVIEW" | "AUTO"
  goals?: {
    riskCeiling?: "ELEVATED" | "SENSITIVE" | null
    protectedEnvironments?: string[]
    changeWindows?: {
      days: integer[]
      start: string
      end: string
      tz: string
    }[]
    blastRadiusAudienceShareCap?: number | null
    blastRadiusTrafficShareCap?: number | null
    errorBudgetFloor?: number | null
    requireVerification?: boolean
    requireInverse?: boolean
    context?: string | null
    autoDeployEnvironments?: Record<string, object>
  }
}

Response 200

{
  mode: "HUMAN_REVIEW" | "AUTO"
  description: string
  goals: {
    riskCeiling: "ELEVATED" | "SENSITIVE" | null
    protectedEnvironments: unknown[]
    changeWindows: unknown[]
    blastRadiusAudienceShareCap: number | null
    blastRadiusTrafficShareCap: number | null
    errorBudgetFloor: number | null
    requireVerification: boolean
    requireInverse: boolean
    autoDeployEnvironments: Record<string, object>
    productionAutoDeploy: {
      enabled: boolean
      optedInByPrincipalId: string | null
      optedInAt: string | null
      stepUpDigest: string | null
    }
    context: string | null
  }
  stored: boolean
  updatedAt: string | 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 -X PUT https://api.bucker.io/orgs/{orgSlug}/review-mode \
  -H "authorization: Bearer $BUCKER_TOKEN" \
  -H 'content-type: application/json' \
  -d '{ … }'

DELETE/orgs/{orgSlug}/review-mode/production-opt-in

Requires bearerAuth

Parameters

Parameters for DELETE /orgs/{orgSlug}/review-mode/production-opt-in
NameInTypeNotes
orgSlugrequiredpathstringmin length 1

Response 200

{
  mode: "HUMAN_REVIEW" | "AUTO"
  description: string
  goals: {
    riskCeiling: "ELEVATED" | "SENSITIVE" | null
    protectedEnvironments: unknown[]
    changeWindows: unknown[]
    blastRadiusAudienceShareCap: number | null
    blastRadiusTrafficShareCap: number | null
    errorBudgetFloor: number | null
    requireVerification: boolean
    requireInverse: boolean
    autoDeployEnvironments: Record<string, object>
    productionAutoDeploy: {
      enabled: boolean
      optedInByPrincipalId: string | null
      optedInAt: string | null
      stepUpDigest: string | null
    }
    context: string | null
  }
  stored: boolean
  updatedAt: string | 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 -X DELETE https://api.bucker.io/orgs/{orgSlug}/review-mode/production-opt-in \
  -H "authorization: Bearer $BUCKER_TOKEN"

POST/orgs/{orgSlug}/review-mode/production-opt-in

Requires bearerAuth

Parameters

Parameters for POST /orgs/{orgSlug}/review-mode/production-opt-in
NameInTypeNotes
orgSlugrequiredpathstringmin length 1

Request body (required) · application/json

{
  password?: string
  webauthn?: {
    credentialId: string
    clientDataJSON: string
    authenticatorData: string
    signature: string
  }
}

Response 200

{
  mode: "HUMAN_REVIEW" | "AUTO"
  description: string
  goals: {
    riskCeiling: "ELEVATED" | "SENSITIVE" | null
    protectedEnvironments: unknown[]
    changeWindows: unknown[]
    blastRadiusAudienceShareCap: number | null
    blastRadiusTrafficShareCap: number | null
    errorBudgetFloor: number | null
    requireVerification: boolean
    requireInverse: boolean
    autoDeployEnvironments: Record<string, object>
    productionAutoDeploy: {
      enabled: boolean
      optedInByPrincipalId: string | null
      optedInAt: string | null
      stepUpDigest: string | null
    }
    context: string | null
  }
  stored: boolean
  updatedAt: string | 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 -X POST https://api.bucker.io/orgs/{orgSlug}/review-mode/production-opt-in \
  -H "authorization: Bearer $BUCKER_TOKEN" \
  -H 'content-type: application/json' \
  -d '{ … }'