Skip to content
bucker

API reference

rollout-overview

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

GET/orgs/{orgSlug}/projects/{projectSlug}/rollout-overview

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/projects/{projectSlug}/rollout-overview
NameInTypeNotes
orgSlugrequiredpathstringmin length 1, max length 64
projectSlugrequiredpathstringmin length 1, max length 64
kindquery"release" | "flag_variant" | "ramp"one of "release" | "flag_variant" | "ramp"
limitqueryintegerdefault 20, min 1, max 100

Response 200

{
  items: {
    id: string
    kind: "release" | "flag_variant" | "ramp"
    status: string
    environment: string
    releaseVersion: string | null
    flagKey: string | null
    variant: string | null
    baselineVariant: string | null
    cohortFraction: number | null
    startedAt: string
    lastCheckedAt: string | null
    lastVerdict: "not_available" | {
      verdict: string
      observedAt: string
      reason: string
    } | null
  }[]
  truncated: boolean
}

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

GET/orgs/{orgSlug}/projects/{projectSlug}/rollout-overview/{rolloutId}

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/projects/{projectSlug}/rollout-overview/{rolloutId}
NameInTypeNotes
orgSlugrequiredpathstringmin length 1, max length 64
projectSlugrequiredpathstringmin length 1, max length 64
rolloutIdrequiredpathstringmin length 1, max length 64
limitqueryintegerdefault 20, min 1, max 50

Response 200

{
  id: string
  kind: "release" | "flag_variant"
  status: string
  environment: string
  releaseVersion: string
  flagKey: string | null
  variant: string | null
  baselineVariant: string | null
  cohortFraction: number
  baselineVersion: string | null
  startedAt: string
  lastCheckedAt: string | null
  haltReason: string | null
  thresholds: {
    floor: integer
    maxPValue: number
    deltaThreshold: number
  }
  checks: {
    id: string
    observedAt: string
    metric: string
    test: string
    verdict: string
    numbers: {
      alpha: number | null
      floor: integer
      nPerSide: object
      delta: number | null
      p: number | null
      reason: string
    }
    newIssues: integer | null
    exposures: integer | null
    shadowAction: string | null
  }[]
  checksTruncated: boolean
  sessions: {
    state: "not_available"
    note: string
  }
  proposal: {
    action: "flag.narrow" | "flag.disable"
    input: {
      environment: string
      change: object
      reason: string
      evidence?: string[]
    }
    flagId: string | null
    preview: {
      derivedClass: string | null
      appliable: boolean
      refusal: object | null
      ownerOrAdminApprover: boolean
    } | null
    note: 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}/rollout-overview/{rolloutId} \
  -H "authorization: Bearer $BUCKER_TOKEN"