egress-map
1 operation. Shapes are sketches of the declared schemas, bounded in depth — the authoritative document is linked from the index.
GET/orgs/{orgSlug}/egress-map
Requires bearerAuth
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
Response 200
{
generatedAt: string
windowHours: integer
entries: {
id: string
kind: "outbound_webhook" | "alert_channel" | "integration" | "pagerduty_change_event" | "warehouse_sink" | "audit_sink" | "status_subscriber" | "digest_mail" | … 4 more
name: string | null
subtype: string | null
host: string | null
hostAllowed: boolean | null
scope: "org" | "project"
projectId: string | null
enabled: boolean
fieldsSent: {
shape: string
paths: string[]
}
scrubTier: "stored" | "agent" | "not_applicable"
personalData: string[]
streams: string[]
createdBy: {
principalId: string
name: string
kind: "HUMAN" | "AGENT" | "SERVICE" | "GUEST"
via: string | null
} | null
approvalId: string | null
lastSuccessAt: string | null
deliveries24h: {
sent: integer
failed: integer
dead: integer
rateLimited: integer
p50ms: integer | null
} | null
healthBasis: string
state: "healthy" | "degraded" | "failing" | "idle" | "paused" | "unknown" | "inbound_only" | "listed"
}[]
hiddenOrgLevel: {
kind: "outbound_webhook" | "alert_channel" | "integration" | "pagerduty_change_event" | "warehouse_sink" | "audit_sink" | "status_subscriber" | "digest_mail" | … 4 more
count: integer
}[]
hosts: {
host: string
paths: integer
kinds: "outbound_webhook" | "alert_channel" | "integration" | "pagerduty_change_event" | "warehouse_sink" | "audit_sink" | "status_subscriber" | "digest_mail" | … 4 more[]
allowed: boolean | null
}[]
totals: {
paths: integer
byKind: Record<string, integer>
}
allowListEnforced: boolean
truncated24h: 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}/egress-map \
-H "authorization: Bearer $BUCKER_TOKEN"