check-batches
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}/check-batches/{batchId}
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
batchIdrequired | path | string | min length 1, max length 100 |
Response 200
{
id: string
gate: {
id: string
name: string
stage: string
failMode: string
enforced: boolean
} | null
release: string | null
environment: string
deployUrl: string
status: "queued" | "running" | "complete"
result: "passed" | "failed" | "skipped" | "not_evaluated" | null
startedAt: string
completedAt: string | null
pollIntervalMs: integer
summary: {
result: "passed" | "failed" | "skipped" | "not_evaluated"
reason: "no_checks" | "blocking_not_run" | "no_blocking_checks" | "requested_blocking_only" | null
total: integer
blocking: integer
nonBlocking: integer
skipped: integer
passed: integer
failed: integer
notRun: integer
blockingFailed: integer
blockingNotRun: integer
warnings: integer
budgetExhausted: integer
} | null
items: {
checkId: string
projectId: string
slug: string
name: string
storedRule: "blocking" | "non_blocking" | "skipped"
rule: "blocking" | "non_blocking" | "skipped"
status: "passed" | "failed" | "not_run" | "skipped"
notRun: {
code: "ORIGIN_BOUND" | "PROBE_ERROR" | "RUN_BUDGET_EXHAUSTED" | "CHECK_GONE"
reason: string
} | null
resultId: string | null
httpStatus: integer | null
latencyMs: integer | null
failureKind: string | null
error: string | null
}[] | 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}/check-batches/{batchId} \
-H "authorization: Bearer $BUCKER_TOKEN"