Skip to content
bucker

API reference

change-events

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}/change-events

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/projects/{projectSlug}/change-events
NameInTypeNotes
orgSlugrequiredpathstringmin length 1
projectSlugrequiredpathstringmin length 1
kindquerystringmax length 400
servicequerystringmin length 1, max length 200
environmentquerystringmin length 1, max length 64
configSubjectquery"bucker_yml" | "mcp_config" | "agent_config" | "alert_rule" | "routing_policy" | "sampling_rule" | "log_pipeline_rule" | "log_quota" | … 45 moreone of "bucker_yml" | "mcp_config" | "agent_config" | "alert_rule" | "routing_policy" | "sampling_rule" | "log_pipeline_rule" | "log_quota" | … 45 more
entityIdquerystringmin length 1, max length 200
hasOperationquery"true" | "false"one of "true" | "false"
fromqueryunknown
toqueryunknown
limitqueryintegerdefault 25, min 1, max 100
cursorquerystringmin length 1, max length 512
includeSupersededquery"true" | "false"one of "true" | "false"

Response 200

{
  data: {
    id: string
    kind: "DEPLOY" | "FLAG_FLIP" | "CONFIG" | "DEP_BUMP" | "EXPERIMENT_STATE" | "PROMPT_LABEL" | "SCALE" | "RESTART" | … 15 more
    summary: string
    reference: string | null
    source: string | null
    sources: string[]
    occurredAt: string
    createdAt: string
    actorKind: string | null
    actorMode: string | null
    actorPrincipalId: string | null
    approvalRequestId: string | null
    planDigest: string | null
    entityId: string | null
    environment: string | null
    service: string | null
    configSubject: string | null
    operationId: string | null
    revertsId: string | null
    supersedesId: string | null
    trust: "trusted" | "untrusted"
    deployStatus: string | null
  }[]
  nextCursor: string | null
  supersededHidden: 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 https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/change-events \
  -H "authorization: Bearer $BUCKER_TOKEN"

POST/orgs/{orgSlug}/projects/{projectSlug}/change-events

Requires bearerAuth

Parameters

Parameters for POST /orgs/{orgSlug}/projects/{projectSlug}/change-events
NameInTypeNotes
orgSlugrequiredpathstringmin length 1
projectSlugrequiredpathstringmin length 1

Request body (required) · application/json

{
  kind?: "CONFIG"
  configSubject?: "custom"
  summary: string
  service?: string
  environment?: string
  entityId?: string
  reference?: string
  occurredAt?: unknown
  supersedesId?: string
}

Response 201

{
  id: string
  kind: "DEPLOY" | "FLAG_FLIP" | "CONFIG" | "DEP_BUMP" | "EXPERIMENT_STATE" | "PROMPT_LABEL" | "SCALE" | "RESTART" | … 15 more
  summary: string
  reference: string | null
  source: string | null
  sources: string[]
  occurredAt: string
  createdAt: string
  actorKind: string | null
  actorMode: string | null
  actorPrincipalId: string | null
  approvalRequestId: string | null
  planDigest: string | null
  entityId: string | null
  environment: string | null
  service: string | null
  configSubject: string | null
  operationId: string | null
  revertsId: string | null
  supersedesId: string | null
  trust: "trusted" | "untrusted"
  deployStatus: 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}/projects/{projectSlug}/change-events \
  -H "authorization: Bearer $BUCKER_TOKEN" \
  -H 'content-type: application/json' \
  -d '{ … }'