alert-rules
24 operations. Shapes are sketches of the declared schemas, bounded in depth — the authoritative document is linked from the index.
GET/orgs/{orgSlug}/alert-rules
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
cursor | query | string | max length 500 |
limit | query | integer | default 25, min 1, max 100 |
state | query | "BREACHING" | "WARNING" | "NO_DATA" | "OK" | one of "BREACHING" | "WARNING" | "NO_DATA" | "OK" |
Response 200
{
data: {
id: string
projectId: string | null
scope: "project" | "org"
name: string
enabled: boolean
type: "issue" | "metric"
conditionMatch: "all" | "any"
conditions: {
id: "first_seen"
} | {
id: "regression"
} | {
id: "event_count"
value: integer
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "user_count"
value: integer
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "issue_level"
level: "debug" | "info" | "warning" | "error" | "fatal"
match: "eq" | "gte"
} | {
id: "environment"
value: string
} | … 3 more | {
id: "metric"
aggregate: "event_count" | "user_count" | "issue_count" | "crash_free_sessions" | "crash_free_users" | "release_adoption"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
minSessions?: integer
warningThreshold?: number
comparison?: object
groupBy?: object
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
} | {
id: "anomaly"
aggregate: "event_count" | "user_count" | "issue_count"
sensitivity: number
direction: "above" | "below" | "both"
minValue: integer
environment?: string
} | {
id: "telemetry"
dataset: "spans" | "logs" | "metrics"
query: object[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
counter?: "delta" | "rate"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
warningThreshold?: number
comparison?: object
groupBy?: object
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
ratio?: object
minVolume?: integer
unresolvedWithin?: object
} | {
id: "telemetry_anomaly"
dataset: "spans" | "logs" | "metrics"
query: object[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
sensitivity: number
direction: "above" | "below" | "both"
minValue: number
notifyOnRecovery?: boolean
} | {
id: "change_event"
kinds: "DEPLOY" | "FLAG_FLIP" | "CONFIG" | "DEP_BUMP" | "EXPERIMENT_STATE" | "PROMPT_LABEL" | "SCALE" | "RESTART" | … 3 more[]
environment?: string
service?: string
actorKind?: "HUMAN" | "AGENT" | "SERVICE" | "EXTERNAL"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
afterChange?: object
notifyOnRecovery?: boolean
} | … 9 more[]
filters: {
id: "level"
comparator: "eq" | "gte"
value: "debug" | "info" | "warning" | "error" | "fatal"
} | {
id: "environment"
value: string
} | {
id: "release"
value: string
match: "equals" | "contains"
} | {
id: "tag"
key: string
value: string
match: "equals" | "contains"
} | {
id: "issue_age"
comparator: "older_than" | "newer_than"
minutes: integer
} | {
id: "priority"
comparator: "eq" | "gte"
value: "HIGH" | "MEDIUM" | "LOW"
} | … 1 more[]
actions: {
kind: "notify_channel"
channelId: string
} | {
kind: "agent_investigate"
objective?: string
maxTier?: string
stopAt?: "rca" | "proposal" | "pr"
budgetCents?: integer
} | {
kind: "notify_owner"
fallbackChannelId: string
subject: "ALERTS" | "APPROVALS" | "INCIDENTS" | "REMEDIATION" | "DIGESTS"
}[]
frequencyMinutes: integer
noDataGroupRetentionMinutes: integer | null
mutedUntil: string | null
mutedForMeUntil: string | null
lifecycle: "SHADOW" | "LIVE" | "EXPIRED"
shadowSince: string | null
expiresAt: string | null
createdAt: string
updatedAt: string
definitionValid?: false
evaluation: {
state: "ok" | "lagging" | "broken" | "unknown"
lastEvaluatedAt: string | null
lagMs: integer | null
quarantined: boolean
errorClass: "timeout" | "dependency" | "invalid_query" | "bad_config" | "evaluation_error" | "dispatch_error" | null
quarantinedSince: string | null
nextRetryAt: string | null
brokenSince: string | null
lastOutcome: string | null
consecutiveFailures: integer
}
}[]
nextCursor: string | null
hasMore: 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}/alert-rules \
-H "authorization: Bearer $BUCKER_TOKEN"POST/orgs/{orgSlug}/alert-rules
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
Request body (required) · application/json
{
name: string
enabled?: boolean
type: "issue" | "metric"
conditionMatch?: "all" | "any"
conditions: {
id: "first_seen"
} | {
id: "regression"
} | {
id: "event_count"
value: integer
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "user_count"
value: integer
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "issue_level"
level: "debug" | "info" | "warning" | "error" | "fatal"
match?: "eq" | "gte"
} | {
id: "environment"
value: string
} | … 3 more | {
id: "metric"
aggregate: "event_count" | "user_count" | "issue_count" | "crash_free_sessions" | "crash_free_users" | "release_adoption"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
minSessions?: integer
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
} | {
id: "anomaly"
aggregate: "event_count" | "user_count" | "issue_count"
sensitivity?: number
direction?: "above" | "below" | "both"
minValue?: integer
environment?: string
} | {
id: "telemetry"
dataset: "spans" | "logs" | "metrics"
query?: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
counter?: "delta" | "rate"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
ratio?: {
numerator: object[]
denominator?: object[]
}
minVolume?: integer
unresolvedWithin?: {
resolveQuery: object[]
joinKey: string
withinMinutes: integer
}
} | {
id: "telemetry_anomaly"
dataset: "spans" | "logs" | "metrics"
query?: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
sensitivity?: number
direction?: "above" | "below" | "both"
minValue?: number
notifyOnRecovery?: boolean
} | {
id: "change_event"
kinds: "DEPLOY" | "FLAG_FLIP" | "CONFIG" | "DEP_BUMP" | "EXPERIMENT_STATE" | "PROMPT_LABEL" | "SCALE" | "RESTART" | … 3 more[]
environment?: string
service?: string
actorKind?: "HUMAN" | "AGENT" | "SERVICE" | "EXTERNAL"
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
threshold?: number
afterChange?: {
dataset: "spans" | "logs"
ratio: object
windowMinutes: integer
minVolume?: integer
}
notifyOnRecovery?: boolean
} | … 9 more[]
filters?: {
id: "level"
comparator?: "eq" | "gte"
value: "debug" | "info" | "warning" | "error" | "fatal"
} | {
id: "environment"
value: string
} | {
id: "release"
value: string
match?: "equals" | "contains"
} | {
id: "tag"
key: string
value: string
match?: "equals" | "contains"
} | {
id: "issue_age"
comparator: "older_than" | "newer_than"
minutes: integer
} | {
id: "priority"
comparator?: "eq" | "gte"
value: "HIGH" | "MEDIUM" | "LOW"
} | … 1 more[]
actions: {
kind: "notify_channel"
channelId: string
} | {
kind: "agent_investigate"
objective?: string
maxTier?: string
stopAt?: "rca" | "proposal" | "pr"
budgetCents?: integer
} | {
kind: "notify_owner"
fallbackChannelId: string
subject?: "ALERTS" | "APPROVALS" | "INCIDENTS" | "REMEDIATION" | "DIGESTS"
}[]
frequencyMinutes?: integer
noDataGroupRetentionMinutes?: integer
}Response 201
{
id: string
projectId: string | null
scope: "project" | "org"
name: string
enabled: boolean
type: "issue" | "metric"
conditionMatch: "all" | "any"
conditions: {
id: "first_seen"
} | {
id: "regression"
} | {
id: "event_count"
value: integer
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "user_count"
value: integer
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "issue_level"
level: "debug" | "info" | "warning" | "error" | "fatal"
match: "eq" | "gte"
} | {
id: "environment"
value: string
} | … 3 more | {
id: "metric"
aggregate: "event_count" | "user_count" | "issue_count" | "crash_free_sessions" | "crash_free_users" | "release_adoption"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
minSessions?: integer
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
} | {
id: "anomaly"
aggregate: "event_count" | "user_count" | "issue_count"
sensitivity: number
direction: "above" | "below" | "both"
minValue: integer
environment?: string
} | {
id: "telemetry"
dataset: "spans" | "logs" | "metrics"
query: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
counter?: "delta" | "rate"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
ratio?: {
numerator: object[]
denominator: object[]
}
minVolume?: integer
unresolvedWithin?: {
resolveQuery: object[]
joinKey: string
withinMinutes: integer
}
} | {
id: "telemetry_anomaly"
dataset: "spans" | "logs" | "metrics"
query: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
sensitivity: number
direction: "above" | "below" | "both"
minValue: number
notifyOnRecovery?: boolean
} | {
id: "change_event"
kinds: "DEPLOY" | "FLAG_FLIP" | "CONFIG" | "DEP_BUMP" | "EXPERIMENT_STATE" | "PROMPT_LABEL" | "SCALE" | "RESTART" | … 3 more[]
environment?: string
service?: string
actorKind?: "HUMAN" | "AGENT" | "SERVICE" | "EXTERNAL"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
afterChange?: {
dataset: "spans" | "logs"
ratio: object
windowMinutes: integer
minVolume?: integer
}
notifyOnRecovery?: boolean
} | … 9 more[]
filters: {
id: "level"
comparator: "eq" | "gte"
value: "debug" | "info" | "warning" | "error" | "fatal"
} | {
id: "environment"
value: string
} | {
id: "release"
value: string
match: "equals" | "contains"
} | {
id: "tag"
key: string
value: string
match: "equals" | "contains"
} | {
id: "issue_age"
comparator: "older_than" | "newer_than"
minutes: integer
} | {
id: "priority"
comparator: "eq" | "gte"
value: "HIGH" | "MEDIUM" | "LOW"
} | … 1 more[]
actions: {
kind: "notify_channel"
channelId: string
} | {
kind: "agent_investigate"
objective?: string
maxTier?: string
stopAt?: "rca" | "proposal" | "pr"
budgetCents?: integer
} | {
kind: "notify_owner"
fallbackChannelId: string
subject: "ALERTS" | "APPROVALS" | "INCIDENTS" | "REMEDIATION" | "DIGESTS"
}[]
frequencyMinutes: integer
noDataGroupRetentionMinutes: integer | null
mutedUntil: string | null
mutedForMeUntil: string | null
lifecycle: "SHADOW" | "LIVE" | "EXPIRED"
shadowSince: string | null
expiresAt: string | null
createdAt: string
updatedAt: string
definitionValid?: false
}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}/alert-rules \
-H "authorization: Bearer $BUCKER_TOKEN" \
-H 'content-type: application/json' \
-d '{ … }'DELETE/orgs/{orgSlug}/alert-rules/{ruleId}
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
Response 204
No body.
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}/alert-rules/{ruleId} \
-H "authorization: Bearer $BUCKER_TOKEN"GET/orgs/{orgSlug}/alert-rules/{ruleId}
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
Response 200
{
id: string
projectId: string | null
scope: "project" | "org"
name: string
enabled: boolean
type: "issue" | "metric"
conditionMatch: "all" | "any"
conditions: {
id: "first_seen"
} | {
id: "regression"
} | {
id: "event_count"
value: integer
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "user_count"
value: integer
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "issue_level"
level: "debug" | "info" | "warning" | "error" | "fatal"
match: "eq" | "gte"
} | {
id: "environment"
value: string
} | … 3 more | {
id: "metric"
aggregate: "event_count" | "user_count" | "issue_count" | "crash_free_sessions" | "crash_free_users" | "release_adoption"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
minSessions?: integer
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
} | {
id: "anomaly"
aggregate: "event_count" | "user_count" | "issue_count"
sensitivity: number
direction: "above" | "below" | "both"
minValue: integer
environment?: string
} | {
id: "telemetry"
dataset: "spans" | "logs" | "metrics"
query: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
counter?: "delta" | "rate"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
ratio?: {
numerator: object[]
denominator: object[]
}
minVolume?: integer
unresolvedWithin?: {
resolveQuery: object[]
joinKey: string
withinMinutes: integer
}
} | {
id: "telemetry_anomaly"
dataset: "spans" | "logs" | "metrics"
query: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
sensitivity: number
direction: "above" | "below" | "both"
minValue: number
notifyOnRecovery?: boolean
} | {
id: "change_event"
kinds: "DEPLOY" | "FLAG_FLIP" | "CONFIG" | "DEP_BUMP" | "EXPERIMENT_STATE" | "PROMPT_LABEL" | "SCALE" | "RESTART" | … 3 more[]
environment?: string
service?: string
actorKind?: "HUMAN" | "AGENT" | "SERVICE" | "EXTERNAL"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
afterChange?: {
dataset: "spans" | "logs"
ratio: object
windowMinutes: integer
minVolume?: integer
}
notifyOnRecovery?: boolean
} | … 9 more[]
filters: {
id: "level"
comparator: "eq" | "gte"
value: "debug" | "info" | "warning" | "error" | "fatal"
} | {
id: "environment"
value: string
} | {
id: "release"
value: string
match: "equals" | "contains"
} | {
id: "tag"
key: string
value: string
match: "equals" | "contains"
} | {
id: "issue_age"
comparator: "older_than" | "newer_than"
minutes: integer
} | {
id: "priority"
comparator: "eq" | "gte"
value: "HIGH" | "MEDIUM" | "LOW"
} | … 1 more[]
actions: {
kind: "notify_channel"
channelId: string
} | {
kind: "agent_investigate"
objective?: string
maxTier?: string
stopAt?: "rca" | "proposal" | "pr"
budgetCents?: integer
} | {
kind: "notify_owner"
fallbackChannelId: string
subject: "ALERTS" | "APPROVALS" | "INCIDENTS" | "REMEDIATION" | "DIGESTS"
}[]
frequencyMinutes: integer
noDataGroupRetentionMinutes: integer | null
mutedUntil: string | null
mutedForMeUntil: string | null
lifecycle: "SHADOW" | "LIVE" | "EXPIRED"
shadowSince: string | null
expiresAt: string | null
createdAt: string
updatedAt: string
definitionValid?: false
}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}/alert-rules/{ruleId} \
-H "authorization: Bearer $BUCKER_TOKEN"PATCH/orgs/{orgSlug}/alert-rules/{ruleId}
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
Request body (required) · application/json
{
name?: string
enabled?: boolean
type?: "issue" | "metric"
conditionMatch?: "all" | "any"
conditions?: {
id: "first_seen"
} | {
id: "regression"
} | {
id: "event_count"
value: integer
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "user_count"
value: integer
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "issue_level"
level: "debug" | "info" | "warning" | "error" | "fatal"
match?: "eq" | "gte"
} | {
id: "environment"
value: string
} | … 3 more | {
id: "metric"
aggregate: "event_count" | "user_count" | "issue_count" | "crash_free_sessions" | "crash_free_users" | "release_adoption"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
minSessions?: integer
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
} | {
id: "anomaly"
aggregate: "event_count" | "user_count" | "issue_count"
sensitivity?: number
direction?: "above" | "below" | "both"
minValue?: integer
environment?: string
} | {
id: "telemetry"
dataset: "spans" | "logs" | "metrics"
query?: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
counter?: "delta" | "rate"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
ratio?: {
numerator: object[]
denominator?: object[]
}
minVolume?: integer
unresolvedWithin?: {
resolveQuery: object[]
joinKey: string
withinMinutes: integer
}
} | {
id: "telemetry_anomaly"
dataset: "spans" | "logs" | "metrics"
query?: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
sensitivity?: number
direction?: "above" | "below" | "both"
minValue?: number
notifyOnRecovery?: boolean
} | {
id: "change_event"
kinds: "DEPLOY" | "FLAG_FLIP" | "CONFIG" | "DEP_BUMP" | "EXPERIMENT_STATE" | "PROMPT_LABEL" | "SCALE" | "RESTART" | … 3 more[]
environment?: string
service?: string
actorKind?: "HUMAN" | "AGENT" | "SERVICE" | "EXTERNAL"
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
threshold?: number
afterChange?: {
dataset: "spans" | "logs"
ratio: object
windowMinutes: integer
minVolume?: integer
}
notifyOnRecovery?: boolean
} | … 9 more[]
filters?: {
id: "level"
comparator?: "eq" | "gte"
value: "debug" | "info" | "warning" | "error" | "fatal"
} | {
id: "environment"
value: string
} | {
id: "release"
value: string
match?: "equals" | "contains"
} | {
id: "tag"
key: string
value: string
match?: "equals" | "contains"
} | {
id: "issue_age"
comparator: "older_than" | "newer_than"
minutes: integer
} | {
id: "priority"
comparator?: "eq" | "gte"
value: "HIGH" | "MEDIUM" | "LOW"
} | … 1 more[]
actions?: {
kind: "notify_channel"
channelId: string
} | {
kind: "agent_investigate"
objective?: string
maxTier?: string
stopAt?: "rca" | "proposal" | "pr"
budgetCents?: integer
} | {
kind: "notify_owner"
fallbackChannelId: string
subject?: "ALERTS" | "APPROVALS" | "INCIDENTS" | "REMEDIATION" | "DIGESTS"
}[]
frequencyMinutes?: integer
noDataGroupRetentionMinutes?: integer | null
}Response 200
{
id: string
projectId: string | null
scope: "project" | "org"
name: string
enabled: boolean
type: "issue" | "metric"
conditionMatch: "all" | "any"
conditions: {
id: "first_seen"
} | {
id: "regression"
} | {
id: "event_count"
value: integer
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "user_count"
value: integer
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "issue_level"
level: "debug" | "info" | "warning" | "error" | "fatal"
match: "eq" | "gte"
} | {
id: "environment"
value: string
} | … 3 more | {
id: "metric"
aggregate: "event_count" | "user_count" | "issue_count" | "crash_free_sessions" | "crash_free_users" | "release_adoption"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
minSessions?: integer
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
} | {
id: "anomaly"
aggregate: "event_count" | "user_count" | "issue_count"
sensitivity: number
direction: "above" | "below" | "both"
minValue: integer
environment?: string
} | {
id: "telemetry"
dataset: "spans" | "logs" | "metrics"
query: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
counter?: "delta" | "rate"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
ratio?: {
numerator: object[]
denominator: object[]
}
minVolume?: integer
unresolvedWithin?: {
resolveQuery: object[]
joinKey: string
withinMinutes: integer
}
} | {
id: "telemetry_anomaly"
dataset: "spans" | "logs" | "metrics"
query: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
sensitivity: number
direction: "above" | "below" | "both"
minValue: number
notifyOnRecovery?: boolean
} | {
id: "change_event"
kinds: "DEPLOY" | "FLAG_FLIP" | "CONFIG" | "DEP_BUMP" | "EXPERIMENT_STATE" | "PROMPT_LABEL" | "SCALE" | "RESTART" | … 3 more[]
environment?: string
service?: string
actorKind?: "HUMAN" | "AGENT" | "SERVICE" | "EXTERNAL"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
afterChange?: {
dataset: "spans" | "logs"
ratio: object
windowMinutes: integer
minVolume?: integer
}
notifyOnRecovery?: boolean
} | … 9 more[]
filters: {
id: "level"
comparator: "eq" | "gte"
value: "debug" | "info" | "warning" | "error" | "fatal"
} | {
id: "environment"
value: string
} | {
id: "release"
value: string
match: "equals" | "contains"
} | {
id: "tag"
key: string
value: string
match: "equals" | "contains"
} | {
id: "issue_age"
comparator: "older_than" | "newer_than"
minutes: integer
} | {
id: "priority"
comparator: "eq" | "gte"
value: "HIGH" | "MEDIUM" | "LOW"
} | … 1 more[]
actions: {
kind: "notify_channel"
channelId: string
} | {
kind: "agent_investigate"
objective?: string
maxTier?: string
stopAt?: "rca" | "proposal" | "pr"
budgetCents?: integer
} | {
kind: "notify_owner"
fallbackChannelId: string
subject: "ALERTS" | "APPROVALS" | "INCIDENTS" | "REMEDIATION" | "DIGESTS"
}[]
frequencyMinutes: integer
noDataGroupRetentionMinutes: integer | null
mutedUntil: string | null
mutedForMeUntil: string | null
lifecycle: "SHADOW" | "LIVE" | "EXPIRED"
shadowSince: string | null
expiresAt: string | null
createdAt: string
updatedAt: string
definitionValid?: false
}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}/alert-rules/{ruleId} \
-H "authorization: Bearer $BUCKER_TOKEN" \
-H 'content-type: application/json' \
-d '{ … }'GET/orgs/{orgSlug}/projects/{projectSlug}/alert-rules
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
cursor | query | string | max length 500 |
limit | query | integer | default 25, min 1, max 100 |
state | query | "BREACHING" | "WARNING" | "NO_DATA" | "OK" | one of "BREACHING" | "WARNING" | "NO_DATA" | "OK" |
Response 200
{
data: {
id: string
projectId: string | null
scope: "project" | "org"
name: string
enabled: boolean
type: "issue" | "metric"
conditionMatch: "all" | "any"
conditions: {
id: "first_seen"
} | {
id: "regression"
} | {
id: "event_count"
value: integer
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "user_count"
value: integer
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "issue_level"
level: "debug" | "info" | "warning" | "error" | "fatal"
match: "eq" | "gte"
} | {
id: "environment"
value: string
} | … 3 more | {
id: "metric"
aggregate: "event_count" | "user_count" | "issue_count" | "crash_free_sessions" | "crash_free_users" | "release_adoption"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
minSessions?: integer
warningThreshold?: number
comparison?: object
groupBy?: object
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
} | {
id: "anomaly"
aggregate: "event_count" | "user_count" | "issue_count"
sensitivity: number
direction: "above" | "below" | "both"
minValue: integer
environment?: string
} | {
id: "telemetry"
dataset: "spans" | "logs" | "metrics"
query: object[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
counter?: "delta" | "rate"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
warningThreshold?: number
comparison?: object
groupBy?: object
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
ratio?: object
minVolume?: integer
unresolvedWithin?: object
} | {
id: "telemetry_anomaly"
dataset: "spans" | "logs" | "metrics"
query: object[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
sensitivity: number
direction: "above" | "below" | "both"
minValue: number
notifyOnRecovery?: boolean
} | {
id: "change_event"
kinds: "DEPLOY" | "FLAG_FLIP" | "CONFIG" | "DEP_BUMP" | "EXPERIMENT_STATE" | "PROMPT_LABEL" | "SCALE" | "RESTART" | … 3 more[]
environment?: string
service?: string
actorKind?: "HUMAN" | "AGENT" | "SERVICE" | "EXTERNAL"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
afterChange?: object
notifyOnRecovery?: boolean
} | … 9 more[]
filters: {
id: "level"
comparator: "eq" | "gte"
value: "debug" | "info" | "warning" | "error" | "fatal"
} | {
id: "environment"
value: string
} | {
id: "release"
value: string
match: "equals" | "contains"
} | {
id: "tag"
key: string
value: string
match: "equals" | "contains"
} | {
id: "issue_age"
comparator: "older_than" | "newer_than"
minutes: integer
} | {
id: "priority"
comparator: "eq" | "gte"
value: "HIGH" | "MEDIUM" | "LOW"
} | … 1 more[]
actions: {
kind: "notify_channel"
channelId: string
} | {
kind: "agent_investigate"
objective?: string
maxTier?: string
stopAt?: "rca" | "proposal" | "pr"
budgetCents?: integer
} | {
kind: "notify_owner"
fallbackChannelId: string
subject: "ALERTS" | "APPROVALS" | "INCIDENTS" | "REMEDIATION" | "DIGESTS"
}[]
frequencyMinutes: integer
noDataGroupRetentionMinutes: integer | null
mutedUntil: string | null
mutedForMeUntil: string | null
lifecycle: "SHADOW" | "LIVE" | "EXPIRED"
shadowSince: string | null
expiresAt: string | null
createdAt: string
updatedAt: string
definitionValid?: false
evaluation: {
state: "ok" | "lagging" | "broken" | "unknown"
lastEvaluatedAt: string | null
lagMs: integer | null
quarantined: boolean
errorClass: "timeout" | "dependency" | "invalid_query" | "bad_config" | "evaluation_error" | "dispatch_error" | null
quarantinedSince: string | null
nextRetryAt: string | null
brokenSince: string | null
lastOutcome: string | null
consecutiveFailures: integer
}
stateCounts: {
BREACHING: integer
WARNING: integer
NO_DATA: integer
}
}[]
nextCursor: string | null
hasMore: 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}/alert-rules \
-H "authorization: Bearer $BUCKER_TOKEN"POST/orgs/{orgSlug}/projects/{projectSlug}/alert-rules
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
Request body (required) · application/json
{
name: string
enabled?: boolean
type: "issue" | "metric"
conditionMatch?: "all" | "any"
conditions: {
id: "first_seen"
} | {
id: "regression"
} | {
id: "event_count"
value: integer
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "user_count"
value: integer
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "issue_level"
level: "debug" | "info" | "warning" | "error" | "fatal"
match?: "eq" | "gte"
} | {
id: "environment"
value: string
} | … 3 more | {
id: "metric"
aggregate: "event_count" | "user_count" | "issue_count" | "crash_free_sessions" | "crash_free_users" | "release_adoption"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
minSessions?: integer
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
} | {
id: "anomaly"
aggregate: "event_count" | "user_count" | "issue_count"
sensitivity?: number
direction?: "above" | "below" | "both"
minValue?: integer
environment?: string
} | {
id: "telemetry"
dataset: "spans" | "logs" | "metrics"
query?: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
counter?: "delta" | "rate"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
ratio?: {
numerator: object[]
denominator?: object[]
}
minVolume?: integer
unresolvedWithin?: {
resolveQuery: object[]
joinKey: string
withinMinutes: integer
}
} | {
id: "telemetry_anomaly"
dataset: "spans" | "logs" | "metrics"
query?: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
sensitivity?: number
direction?: "above" | "below" | "both"
minValue?: number
notifyOnRecovery?: boolean
} | {
id: "change_event"
kinds: "DEPLOY" | "FLAG_FLIP" | "CONFIG" | "DEP_BUMP" | "EXPERIMENT_STATE" | "PROMPT_LABEL" | "SCALE" | "RESTART" | … 3 more[]
environment?: string
service?: string
actorKind?: "HUMAN" | "AGENT" | "SERVICE" | "EXTERNAL"
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
threshold?: number
afterChange?: {
dataset: "spans" | "logs"
ratio: object
windowMinutes: integer
minVolume?: integer
}
notifyOnRecovery?: boolean
} | … 9 more[]
filters?: {
id: "level"
comparator?: "eq" | "gte"
value: "debug" | "info" | "warning" | "error" | "fatal"
} | {
id: "environment"
value: string
} | {
id: "release"
value: string
match?: "equals" | "contains"
} | {
id: "tag"
key: string
value: string
match?: "equals" | "contains"
} | {
id: "issue_age"
comparator: "older_than" | "newer_than"
minutes: integer
} | {
id: "priority"
comparator?: "eq" | "gte"
value: "HIGH" | "MEDIUM" | "LOW"
} | … 1 more[]
actions: {
kind: "notify_channel"
channelId: string
} | {
kind: "agent_investigate"
objective?: string
maxTier?: string
stopAt?: "rca" | "proposal" | "pr"
budgetCents?: integer
} | {
kind: "notify_owner"
fallbackChannelId: string
subject?: "ALERTS" | "APPROVALS" | "INCIDENTS" | "REMEDIATION" | "DIGESTS"
}[]
frequencyMinutes?: integer
noDataGroupRetentionMinutes?: integer
}Response 201
{
id: string
projectId: string | null
scope: "project" | "org"
name: string
enabled: boolean
type: "issue" | "metric"
conditionMatch: "all" | "any"
conditions: {
id: "first_seen"
} | {
id: "regression"
} | {
id: "event_count"
value: integer
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "user_count"
value: integer
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "issue_level"
level: "debug" | "info" | "warning" | "error" | "fatal"
match: "eq" | "gte"
} | {
id: "environment"
value: string
} | … 3 more | {
id: "metric"
aggregate: "event_count" | "user_count" | "issue_count" | "crash_free_sessions" | "crash_free_users" | "release_adoption"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
minSessions?: integer
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
} | {
id: "anomaly"
aggregate: "event_count" | "user_count" | "issue_count"
sensitivity: number
direction: "above" | "below" | "both"
minValue: integer
environment?: string
} | {
id: "telemetry"
dataset: "spans" | "logs" | "metrics"
query: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
counter?: "delta" | "rate"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
ratio?: {
numerator: object[]
denominator: object[]
}
minVolume?: integer
unresolvedWithin?: {
resolveQuery: object[]
joinKey: string
withinMinutes: integer
}
} | {
id: "telemetry_anomaly"
dataset: "spans" | "logs" | "metrics"
query: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
sensitivity: number
direction: "above" | "below" | "both"
minValue: number
notifyOnRecovery?: boolean
} | {
id: "change_event"
kinds: "DEPLOY" | "FLAG_FLIP" | "CONFIG" | "DEP_BUMP" | "EXPERIMENT_STATE" | "PROMPT_LABEL" | "SCALE" | "RESTART" | … 3 more[]
environment?: string
service?: string
actorKind?: "HUMAN" | "AGENT" | "SERVICE" | "EXTERNAL"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
afterChange?: {
dataset: "spans" | "logs"
ratio: object
windowMinutes: integer
minVolume?: integer
}
notifyOnRecovery?: boolean
} | … 9 more[]
filters: {
id: "level"
comparator: "eq" | "gte"
value: "debug" | "info" | "warning" | "error" | "fatal"
} | {
id: "environment"
value: string
} | {
id: "release"
value: string
match: "equals" | "contains"
} | {
id: "tag"
key: string
value: string
match: "equals" | "contains"
} | {
id: "issue_age"
comparator: "older_than" | "newer_than"
minutes: integer
} | {
id: "priority"
comparator: "eq" | "gte"
value: "HIGH" | "MEDIUM" | "LOW"
} | … 1 more[]
actions: {
kind: "notify_channel"
channelId: string
} | {
kind: "agent_investigate"
objective?: string
maxTier?: string
stopAt?: "rca" | "proposal" | "pr"
budgetCents?: integer
} | {
kind: "notify_owner"
fallbackChannelId: string
subject: "ALERTS" | "APPROVALS" | "INCIDENTS" | "REMEDIATION" | "DIGESTS"
}[]
frequencyMinutes: integer
noDataGroupRetentionMinutes: integer | null
mutedUntil: string | null
mutedForMeUntil: string | null
lifecycle: "SHADOW" | "LIVE" | "EXPIRED"
shadowSince: string | null
expiresAt: string | null
createdAt: string
updatedAt: string
definitionValid?: false
}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}/alert-rules \
-H "authorization: Bearer $BUCKER_TOKEN" \
-H 'content-type: application/json' \
-d '{ … }'DELETE/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
Response 204
No body.
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}/projects/{projectSlug}/alert-rules/{ruleId} \
-H "authorization: Bearer $BUCKER_TOKEN"GET/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
Response 200
{
id: string
projectId: string | null
scope: "project" | "org"
name: string
enabled: boolean
type: "issue" | "metric"
conditionMatch: "all" | "any"
conditions: {
id: "first_seen"
} | {
id: "regression"
} | {
id: "event_count"
value: integer
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "user_count"
value: integer
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "issue_level"
level: "debug" | "info" | "warning" | "error" | "fatal"
match: "eq" | "gte"
} | {
id: "environment"
value: string
} | … 3 more | {
id: "metric"
aggregate: "event_count" | "user_count" | "issue_count" | "crash_free_sessions" | "crash_free_users" | "release_adoption"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
minSessions?: integer
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
} | {
id: "anomaly"
aggregate: "event_count" | "user_count" | "issue_count"
sensitivity: number
direction: "above" | "below" | "both"
minValue: integer
environment?: string
} | {
id: "telemetry"
dataset: "spans" | "logs" | "metrics"
query: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
counter?: "delta" | "rate"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
ratio?: {
numerator: object[]
denominator: object[]
}
minVolume?: integer
unresolvedWithin?: {
resolveQuery: object[]
joinKey: string
withinMinutes: integer
}
} | {
id: "telemetry_anomaly"
dataset: "spans" | "logs" | "metrics"
query: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
sensitivity: number
direction: "above" | "below" | "both"
minValue: number
notifyOnRecovery?: boolean
} | {
id: "change_event"
kinds: "DEPLOY" | "FLAG_FLIP" | "CONFIG" | "DEP_BUMP" | "EXPERIMENT_STATE" | "PROMPT_LABEL" | "SCALE" | "RESTART" | … 3 more[]
environment?: string
service?: string
actorKind?: "HUMAN" | "AGENT" | "SERVICE" | "EXTERNAL"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
afterChange?: {
dataset: "spans" | "logs"
ratio: object
windowMinutes: integer
minVolume?: integer
}
notifyOnRecovery?: boolean
} | … 9 more[]
filters: {
id: "level"
comparator: "eq" | "gte"
value: "debug" | "info" | "warning" | "error" | "fatal"
} | {
id: "environment"
value: string
} | {
id: "release"
value: string
match: "equals" | "contains"
} | {
id: "tag"
key: string
value: string
match: "equals" | "contains"
} | {
id: "issue_age"
comparator: "older_than" | "newer_than"
minutes: integer
} | {
id: "priority"
comparator: "eq" | "gte"
value: "HIGH" | "MEDIUM" | "LOW"
} | … 1 more[]
actions: {
kind: "notify_channel"
channelId: string
} | {
kind: "agent_investigate"
objective?: string
maxTier?: string
stopAt?: "rca" | "proposal" | "pr"
budgetCents?: integer
} | {
kind: "notify_owner"
fallbackChannelId: string
subject: "ALERTS" | "APPROVALS" | "INCIDENTS" | "REMEDIATION" | "DIGESTS"
}[]
frequencyMinutes: integer
noDataGroupRetentionMinutes: integer | null
mutedUntil: string | null
mutedForMeUntil: string | null
lifecycle: "SHADOW" | "LIVE" | "EXPIRED"
shadowSince: string | null
expiresAt: string | null
createdAt: string
updatedAt: string
definitionValid?: false
}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}/alert-rules/{ruleId} \
-H "authorization: Bearer $BUCKER_TOKEN"PATCH/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
Request body (required) · application/json
{
name?: string
enabled?: boolean
type?: "issue" | "metric"
conditionMatch?: "all" | "any"
conditions?: {
id: "first_seen"
} | {
id: "regression"
} | {
id: "event_count"
value: integer
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "user_count"
value: integer
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "issue_level"
level: "debug" | "info" | "warning" | "error" | "fatal"
match?: "eq" | "gte"
} | {
id: "environment"
value: string
} | … 3 more | {
id: "metric"
aggregate: "event_count" | "user_count" | "issue_count" | "crash_free_sessions" | "crash_free_users" | "release_adoption"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
minSessions?: integer
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
} | {
id: "anomaly"
aggregate: "event_count" | "user_count" | "issue_count"
sensitivity?: number
direction?: "above" | "below" | "both"
minValue?: integer
environment?: string
} | {
id: "telemetry"
dataset: "spans" | "logs" | "metrics"
query?: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
counter?: "delta" | "rate"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
ratio?: {
numerator: object[]
denominator?: object[]
}
minVolume?: integer
unresolvedWithin?: {
resolveQuery: object[]
joinKey: string
withinMinutes: integer
}
} | {
id: "telemetry_anomaly"
dataset: "spans" | "logs" | "metrics"
query?: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
sensitivity?: number
direction?: "above" | "below" | "both"
minValue?: number
notifyOnRecovery?: boolean
} | {
id: "change_event"
kinds: "DEPLOY" | "FLAG_FLIP" | "CONFIG" | "DEP_BUMP" | "EXPERIMENT_STATE" | "PROMPT_LABEL" | "SCALE" | "RESTART" | … 3 more[]
environment?: string
service?: string
actorKind?: "HUMAN" | "AGENT" | "SERVICE" | "EXTERNAL"
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
threshold?: number
afterChange?: {
dataset: "spans" | "logs"
ratio: object
windowMinutes: integer
minVolume?: integer
}
notifyOnRecovery?: boolean
} | … 9 more[]
filters?: {
id: "level"
comparator?: "eq" | "gte"
value: "debug" | "info" | "warning" | "error" | "fatal"
} | {
id: "environment"
value: string
} | {
id: "release"
value: string
match?: "equals" | "contains"
} | {
id: "tag"
key: string
value: string
match?: "equals" | "contains"
} | {
id: "issue_age"
comparator: "older_than" | "newer_than"
minutes: integer
} | {
id: "priority"
comparator?: "eq" | "gte"
value: "HIGH" | "MEDIUM" | "LOW"
} | … 1 more[]
actions?: {
kind: "notify_channel"
channelId: string
} | {
kind: "agent_investigate"
objective?: string
maxTier?: string
stopAt?: "rca" | "proposal" | "pr"
budgetCents?: integer
} | {
kind: "notify_owner"
fallbackChannelId: string
subject?: "ALERTS" | "APPROVALS" | "INCIDENTS" | "REMEDIATION" | "DIGESTS"
}[]
frequencyMinutes?: integer
noDataGroupRetentionMinutes?: integer | null
}Response 200
{
id: string
projectId: string | null
scope: "project" | "org"
name: string
enabled: boolean
type: "issue" | "metric"
conditionMatch: "all" | "any"
conditions: {
id: "first_seen"
} | {
id: "regression"
} | {
id: "event_count"
value: integer
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "user_count"
value: integer
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "issue_level"
level: "debug" | "info" | "warning" | "error" | "fatal"
match: "eq" | "gte"
} | {
id: "environment"
value: string
} | … 3 more | {
id: "metric"
aggregate: "event_count" | "user_count" | "issue_count" | "crash_free_sessions" | "crash_free_users" | "release_adoption"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
minSessions?: integer
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
} | {
id: "anomaly"
aggregate: "event_count" | "user_count" | "issue_count"
sensitivity: number
direction: "above" | "below" | "both"
minValue: integer
environment?: string
} | {
id: "telemetry"
dataset: "spans" | "logs" | "metrics"
query: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
counter?: "delta" | "rate"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
warningThreshold?: number
comparison?: {
kind: "previous_period"
offsetMinutes: integer
}
groupBy?: {
by: "environment" | "release" | "tag"
key?: string
}
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
ratio?: {
numerator: object[]
denominator: object[]
}
minVolume?: integer
unresolvedWithin?: {
resolveQuery: object[]
joinKey: string
withinMinutes: integer
}
} | {
id: "telemetry_anomaly"
dataset: "spans" | "logs" | "metrics"
query: {
key: string
op: "eq" | "neq" | "contains" | "not_contains" | "starts_with" | "gt" | "gte" | "lt" | … 4 more
value?: string
}[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
sensitivity: number
direction: "above" | "below" | "both"
minValue: number
notifyOnRecovery?: boolean
} | {
id: "change_event"
kinds: "DEPLOY" | "FLAG_FLIP" | "CONFIG" | "DEP_BUMP" | "EXPERIMENT_STATE" | "PROMPT_LABEL" | "SCALE" | "RESTART" | … 3 more[]
environment?: string
service?: string
actorKind?: "HUMAN" | "AGENT" | "SERVICE" | "EXTERNAL"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
afterChange?: {
dataset: "spans" | "logs"
ratio: object
windowMinutes: integer
minVolume?: integer
}
notifyOnRecovery?: boolean
} | … 9 more[]
filters: {
id: "level"
comparator: "eq" | "gte"
value: "debug" | "info" | "warning" | "error" | "fatal"
} | {
id: "environment"
value: string
} | {
id: "release"
value: string
match: "equals" | "contains"
} | {
id: "tag"
key: string
value: string
match: "equals" | "contains"
} | {
id: "issue_age"
comparator: "older_than" | "newer_than"
minutes: integer
} | {
id: "priority"
comparator: "eq" | "gte"
value: "HIGH" | "MEDIUM" | "LOW"
} | … 1 more[]
actions: {
kind: "notify_channel"
channelId: string
} | {
kind: "agent_investigate"
objective?: string
maxTier?: string
stopAt?: "rca" | "proposal" | "pr"
budgetCents?: integer
} | {
kind: "notify_owner"
fallbackChannelId: string
subject: "ALERTS" | "APPROVALS" | "INCIDENTS" | "REMEDIATION" | "DIGESTS"
}[]
frequencyMinutes: integer
noDataGroupRetentionMinutes: integer | null
mutedUntil: string | null
mutedForMeUntil: string | null
lifecycle: "SHADOW" | "LIVE" | "EXPIRED"
shadowSince: string | null
expiresAt: string | null
createdAt: string
updatedAt: string
definitionValid?: false
}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}/alert-rules/{ruleId} \
-H "authorization: Bearer $BUCKER_TOKEN" \
-H 'content-type: application/json' \
-d '{ … }'GET/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/checks
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
limit | query | integer | default 50, min 1, max 200 |
before | query | string (date-time) | |
state | query | "ok" | "firing" | "no_data" | "not_enough_data" | "quiet" | "untrusted" | one of "ok" | "firing" | "no_data" | "not_enough_data" | "quiet" | "untrusted" |
Response 200
{
data: {
id: string
ruleId: string
evaluatedAt: string
value: number | null
threshold: number | null
state: "ok" | "firing" | "no_data" | "not_enough_data" | "quiet" | "untrusted"
watermark: string | null
trustDigest: string | null
}[]
nextBefore: 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}/alert-rules/{ruleId}/checks \
-H "authorization: Bearer $BUCKER_TOKEN"POST/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/demote
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
Request body (required) · application/json
{
minutes: integer
reason: string
approvalRequestId?: string
}Response 200
{
ruleId: string
lifecycle: "SHADOW" | "LIVE"
via: "person"
evidenceDigest: string | null
resumeAt: string | null
}Response 202
{
status: "applied" | "input_required" | "inert_draft"
action: string
operationId: string | null
planDigest: string | null
riskClass: string | null
approvalRequestId: string | null
decisionPath: string | null
versionAfter: string | null
until: string | null
plan: Record<string, unknown> | null
trust: {
untrustedFields: string[]
note: 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 -X POST https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/demote \
-H "authorization: Bearer $BUCKER_TOKEN" \
-H 'content-type: application/json' \
-d '{ … }'POST/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/edit
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
Request body (required) · application/json
{
patch: {
name?: string
enabled?: boolean
type?: "issue" | "metric"
conditionMatch?: "all" | "any"
conditions?: {
id: "first_seen"
} | {
id: "regression"
} | {
id: "event_count"
value: integer
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "user_count"
value: integer
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "issue_level"
level: "debug" | "info" | "warning" | "error" | "fatal"
match?: "eq" | "gte"
} | {
id: "environment"
value: string
} | … 3 more | {
id: "metric"
aggregate: "event_count" | "user_count" | "issue_count" | "crash_free_sessions" | "crash_free_users" | "release_adoption"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
minSessions?: integer
warningThreshold?: number
comparison?: object
groupBy?: object
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
} | {
id: "anomaly"
aggregate: "event_count" | "user_count" | "issue_count"
sensitivity?: number
direction?: "above" | "below" | "both"
minValue?: integer
environment?: string
} | {
id: "telemetry"
dataset: "spans" | "logs" | "metrics"
query?: object[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
counter?: "delta" | "rate"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
warningThreshold?: number
comparison?: object
groupBy?: object
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
ratio?: object
minVolume?: integer
unresolvedWithin?: object
} | {
id: "telemetry_anomaly"
dataset: "spans" | "logs" | "metrics"
query?: object[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
sensitivity?: number
direction?: "above" | "below" | "both"
minValue?: number
notifyOnRecovery?: boolean
} | {
id: "change_event"
kinds: "DEPLOY" | "FLAG_FLIP" | "CONFIG" | "DEP_BUMP" | "EXPERIMENT_STATE" | "PROMPT_LABEL" | "SCALE" | "RESTART" | … 3 more[]
environment?: string
service?: string
actorKind?: "HUMAN" | "AGENT" | "SERVICE" | "EXTERNAL"
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
threshold?: number
afterChange?: object
notifyOnRecovery?: boolean
} | … 9 more[]
filters?: {
id: "level"
comparator?: "eq" | "gte"
value: "debug" | "info" | "warning" | "error" | "fatal"
} | {
id: "environment"
value: string
} | {
id: "release"
value: string
match?: "equals" | "contains"
} | {
id: "tag"
key: string
value: string
match?: "equals" | "contains"
} | {
id: "issue_age"
comparator: "older_than" | "newer_than"
minutes: integer
} | {
id: "priority"
comparator?: "eq" | "gte"
value: "HIGH" | "MEDIUM" | "LOW"
} | … 1 more[]
actions?: {
kind: "notify_channel"
channelId: string
} | {
kind: "agent_investigate"
objective?: string
maxTier?: string
stopAt?: "rca" | "proposal" | "pr"
budgetCents?: integer
} | {
kind: "notify_owner"
fallbackChannelId: string
subject?: "ALERTS" | "APPROVALS" | "INCIDENTS" | "REMEDIATION" | "DIGESTS"
}[]
frequencyMinutes?: integer
noDataGroupRetentionMinutes?: integer | null
}
reason: string
minutes?: integer
approvalRequestId?: string
}Response 200
{
status: "applied" | "input_required" | "inert_draft"
action: string
operationId: string | null
planDigest: string | null
riskClass: string | null
approvalRequestId: string | null
decisionPath: string | null
versionAfter: string | null
until: string | null
plan: Record<string, unknown> | null
trust: {
untrustedFields: string[]
note: string
}
}Response 202
{
status: "applied" | "input_required" | "inert_draft"
action: string
operationId: string | null
planDigest: string | null
riskClass: string | null
approvalRequestId: string | null
decisionPath: string | null
versionAfter: string | null
until: string | null
plan: Record<string, unknown> | null
trust: {
untrustedFields: string[]
note: 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 -X POST https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/edit \
-H "authorization: Bearer $BUCKER_TOKEN" \
-H 'content-type: application/json' \
-d '{ … }'PUT/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/escalation
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
Request body (required) · application/json
{
escalation: {
afterMinutes: integer
channelId: string
} | null
}Response 200
{
ruleId: string
before: {
afterMinutes: integer
channelId: string
} | null
after: {
afterMinutes: integer
channelId: 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}/alert-rules/{ruleId}/escalation \
-H "authorization: Bearer $BUCKER_TOKEN" \
-H 'content-type: application/json' \
-d '{ … }'DELETE/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/mute
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
scope | query | "rule" | "me" | default "rule", one of "rule" | "me" |
reason | query | string | min length 1, max length 2000 |
approvalRequestId | query | string | min length 1, max length 64 |
Response 200
{
scope: "rule" | "me"
until: string | null
governed?: {
status: "applied" | "input_required" | "inert_draft"
action: string
operationId: string | null
planDigest: string | null
riskClass: string | null
approvalRequestId: string | null
decisionPath: string | null
versionAfter: string | null
until: string | null
plan: Record<string, unknown> | null
trust: {
untrustedFields: string[]
note: string
}
}
}Response 202
{
status: "applied" | "input_required" | "inert_draft"
action: string
operationId: string | null
planDigest: string | null
riskClass: string | null
approvalRequestId: string | null
decisionPath: string | null
versionAfter: string | null
until: string | null
plan: Record<string, unknown> | null
trust: {
untrustedFields: string[]
note: 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 -X DELETE https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/mute \
-H "authorization: Bearer $BUCKER_TOKEN"POST/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/mute
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
Request body (required) · application/json
{
scope?: "rule" | "me"
minutes?: integer
until?: string (date-time)
reason?: string
approvalRequestId?: string
}Response 200
{
scope: "rule" | "me"
until: string | null
governed?: {
status: "applied" | "input_required" | "inert_draft"
action: string
operationId: string | null
planDigest: string | null
riskClass: string | null
approvalRequestId: string | null
decisionPath: string | null
versionAfter: string | null
until: string | null
plan: Record<string, unknown> | null
trust: {
untrustedFields: string[]
note: string
}
}
}Response 202
{
status: "applied" | "input_required" | "inert_draft"
action: string
operationId: string | null
planDigest: string | null
riskClass: string | null
approvalRequestId: string | null
decisionPath: string | null
versionAfter: string | null
until: string | null
plan: Record<string, unknown> | null
trust: {
untrustedFields: string[]
note: 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 -X POST https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/mute \
-H "authorization: Bearer $BUCKER_TOKEN" \
-H 'content-type: application/json' \
-d '{ … }'POST/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/promote
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
Request body (required) · application/json
{
reason?: string
approvalRequestId?: string
}Response 200
{
ruleId: string
lifecycle: "SHADOW" | "LIVE"
via: "person"
evidenceDigest: string | null
resumeAt: string | null
}Response 202
{
status: "applied" | "input_required" | "inert_draft"
action: string
operationId: string | null
planDigest: string | null
riskClass: string | null
approvalRequestId: string | null
decisionPath: string | null
versionAfter: string | null
until: string | null
plan: Record<string, unknown> | null
trust: {
untrustedFields: string[]
note: 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 -X POST https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/promote \
-H "authorization: Bearer $BUCKER_TOKEN" \
-H 'content-type: application/json' \
-d '{ … }'POST/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/retry-evaluation
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
Response 200
{
ruleId: string
retried: 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}/alert-rules/{ruleId}/retry-evaluation \
-H "authorization: Bearer $BUCKER_TOKEN"PUT/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/routing
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
Request body (required) · application/json
{
tags?: string[]
priority?: integer | null
}Response 200
{
ruleId: string
before: {
tags: string[]
priority: integer | null
}
after: {
tags: string[]
priority: integer | null
}
uncoveredNow: boolean
trust: {
untrustedFields: string[]
note: 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 -X PUT https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/routing \
-H "authorization: Bearer $BUCKER_TOKEN" \
-H 'content-type: application/json' \
-d '{ … }'GET/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/shadow
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
Response 200
{
ruleId: string
lifecycle: "SHADOW" | "LIVE" | "EXPIRED"
since: string | null
expiresAt: string | null
window: {
from: string
to: string
days: number
}
fires: integer
recoveries: integer
groups: {
count: integer
named: string[]
}
firesByDay: {
day: string
fires: integer
}[]
wouldBeDestinations: {
actionKind: string
channelId: string | null
channelKind: string | null
pages: boolean
fires: integer
}[]
pagesAPerson: boolean
swallowedByCooldown: {
sinceLastFire: integer
estimatedInWindow: integer
estimated: true
}
backtest: {
predicted: {
days: number
evaluations: integer
matches: integer
fires: integer
deliveredFires: integer
recoveries: integer
suppressedByCooldown: integer
}
predictedFiresPerDay: number
actualFiresPerDay: number
ratio: number | null
note: string
} | null
truncated: boolean
digest: string
blockingKeys: string[]
hasMinimumEvidence: 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}/alert-rules/{ruleId}/shadow \
-H "authorization: Bearer $BUCKER_TOKEN"GET/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/{ruleId}/state
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
ruleIdrequired | path | string | min length 1 |
Response 200
{
ruleId: string
health: {
state: "ok" | "lagging" | "broken" | "unknown"
lastEvaluatedAt: string | null
lastOutcome: string | null
consecutiveFailures: integer
brokenSince: string | null
lagMs: number | null
}
counts: {
BREACHING: integer
WARNING: integer
NO_DATA: integer
}
groups: {
group: {
value: string
trust: "code" | "trusted" | "untrusted" | "quarantined"
flagged?: string
}
state: "BREACHING" | "WARNING" | "NO_DATA"
since: string
retiresAt: 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}/alert-rules/{ruleId}/state \
-H "authorization: Bearer $BUCKER_TOKEN"POST/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/backtest
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
Request body (required) · application/json
{
rule: {
name: string
enabled?: boolean
type: "issue" | "metric"
conditionMatch?: "all" | "any"
conditions: {
id: "first_seen"
} | {
id: "regression"
} | {
id: "event_count"
value: integer
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "user_count"
value: integer
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
} | {
id: "issue_level"
level: "debug" | "info" | "warning" | "error" | "fatal"
match?: "eq" | "gte"
} | {
id: "environment"
value: string
} | … 3 more | {
id: "metric"
aggregate: "event_count" | "user_count" | "issue_count" | "crash_free_sessions" | "crash_free_users" | "release_adoption"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
minSessions?: integer
warningThreshold?: number
comparison?: object
groupBy?: object
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
} | {
id: "anomaly"
aggregate: "event_count" | "user_count" | "issue_count"
sensitivity?: number
direction?: "above" | "below" | "both"
minValue?: integer
environment?: string
} | {
id: "telemetry"
dataset: "spans" | "logs" | "metrics"
query?: object[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
counter?: "delta" | "rate"
windowMinutes: integer
comparator: "gt" | "gte" | "lt" | "lte" | "eq"
threshold: number
warningThreshold?: number
comparison?: object
groupBy?: object
notifyOnRecovery?: boolean
sustainedMinutes?: integer
recoveryThreshold?: number
recoveryConfirmMinutes?: integer
delayNotifyMinutes?: integer
evaluationDelaySeconds?: integer
ratio?: object
minVolume?: integer
unresolvedWithin?: object
} | {
id: "telemetry_anomaly"
dataset: "spans" | "logs" | "metrics"
query?: object[]
aggregate: "count" | "count_unique" | "sum" | "avg" | "min" | "max" | "p50" | "p75" | … 11 more
field?: string
sensitivity?: number
direction?: "above" | "below" | "both"
minValue?: number
notifyOnRecovery?: boolean
} | {
id: "change_event"
kinds: "DEPLOY" | "FLAG_FLIP" | "CONFIG" | "DEP_BUMP" | "EXPERIMENT_STATE" | "PROMPT_LABEL" | "SCALE" | "RESTART" | … 3 more[]
environment?: string
service?: string
actorKind?: "HUMAN" | "AGENT" | "SERVICE" | "EXTERNAL"
windowMinutes: integer
comparator?: "gt" | "gte" | "lt" | "lte" | "eq"
threshold?: number
afterChange?: object
notifyOnRecovery?: boolean
} | … 9 more[]
filters?: {
id: "level"
comparator?: "eq" | "gte"
value: "debug" | "info" | "warning" | "error" | "fatal"
} | {
id: "environment"
value: string
} | {
id: "release"
value: string
match?: "equals" | "contains"
} | {
id: "tag"
key: string
value: string
match?: "equals" | "contains"
} | {
id: "issue_age"
comparator: "older_than" | "newer_than"
minutes: integer
} | {
id: "priority"
comparator?: "eq" | "gte"
value: "HIGH" | "MEDIUM" | "LOW"
} | … 1 more[]
actions: {
kind: "notify_channel"
channelId: string
} | {
kind: "agent_investigate"
objective?: string
maxTier?: string
stopAt?: "rca" | "proposal" | "pr"
budgetCents?: integer
} | {
kind: "notify_owner"
fallbackChannelId: string
subject?: "ALERTS" | "APPROVALS" | "INCIDENTS" | "REMEDIATION" | "DIGESTS"
}[]
frequencyMinutes?: integer
noDataGroupRetentionMinutes?: integer
}
days?: integer
}Response 200
{
from: string
to: string
ruleType: "issue" | "metric"
evaluations: integer
matches: integer
fires: integer
recoveries: integer
suppressedByCooldown: integer
fireTimes: string[]
firesByDay: {
day: string
fires: integer
}[]
delivery: {
actions: integer
chatDestinations: integer
chatMessagesPerDestination: integer | null
}
approximations: 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 -X POST https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/backtest \
-H "authorization: Bearer $BUCKER_TOKEN" \
-H 'content-type: application/json' \
-d '{ … }'GET/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/quality
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
key | query | "muted_over_60_days" | "stuck_in_alert_over_60_days" | "noisy_top_5_percent" | "missing_owner" | "missing_route" | "broken_channel" | "fired_never_resolved" | "acted_on_rate_low" | … 3 more | one of "muted_over_60_days" | "stuck_in_alert_over_60_days" | "noisy_top_5_percent" | "missing_owner" | "missing_route" | "broken_channel" | "fired_never_resolved" | "acted_on_rate_low" | … 3 more |
blockedOnly | query | "true" | "false" | one of "true" | "false" |
ruleId | query | string | min length 1, max length 64 |
limit | query | integer | min 1, max 100 |
Response 200
{
day: string | null
ruleSetVersion: string
rulesScored: integer
meanScore: number | null
blocked: integer
keyCounts: Record<string, integer>
rules: {
ruleId: string
name: string
orgWide: boolean
score: integer
keys: "muted_over_60_days" | "stuck_in_alert_over_60_days" | "noisy_top_5_percent" | "missing_owner" | "missing_route" | "broken_channel" | "fired_never_resolved" | "acted_on_rate_low" | … 3 more[]
blocking: "muted_over_60_days" | "stuck_in_alert_over_60_days" | "noisy_top_5_percent" | "missing_owner" | "missing_route" | "broken_channel" | "fired_never_resolved" | "acted_on_rate_low" | … 3 more[]
actedOn: {
rate: number
lower: number
upper: number
n: integer
} | null
}[]
omitted: integer
notChecked: {
key: string
until: 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}/alert-rules/quality \
-H "authorization: Bearer $BUCKER_TOKEN"POST/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/silencing/preview
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
projectSlugrequired | path | string | min length 1 |
Request body (required) · application/json
{
ruleId: string
reason?: string
mute?: {
minutes: integer
}
unmute?: true
disable?: {
minutes: integer
}
enable?: true
narrow?: {
patch: Record<string, unknown>
minutes: integer
}
}Response 200
{
action: string
direction: "tighten" | "neutral" | "loosen" | "silence" | null
riskClass: string | null
ttlMinutes: integer | null
pagingDestinationsCovered: integer
orgWide: boolean
critical: boolean
reasons: string[]
touched: string[]
refusal: {
code: string
reason: string
} | null
backtest: unknown | null
trust: {
untrustedFields: string[]
note: 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 -X POST https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/alert-rules/silencing/preview \
-H "authorization: Bearer $BUCKER_TOKEN" \
-H 'content-type: application/json' \
-d '{ … }'