{"components":{"schemas":{"AnyJson":{},"ApiKeyInfo":{"properties":{"akiBucketId":{"$ref":"#/components/schemas/BucketId"},"akiBucketIds":{"items":{"$ref":"#/components/schemas/BucketId"},"type":"array"},"akiClasses":{"items":{"type":"string"},"type":"array"},"akiCreatedAt":{"$ref":"#/components/schemas/UTCTime"},"akiExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"akiId":{"$ref":"#/components/schemas/UUID"},"akiIsActive":{"type":"boolean"},"akiLastUsedAt":{"$ref":"#/components/schemas/UTCTime"},"akiName":{"type":"string"},"akiRateLimitBurst":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"akiRateLimitRpm":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"akiScopes":{"items":{"$ref":"#/components/schemas/Scope"},"type":"array"}},"required":["akiId","akiName","akiScopes","akiCreatedAt","akiIsActive","akiBucketIds","akiClasses"],"type":"object"},"AsyncConfig":{"properties":{"acAutoConsume":{"type":"boolean"},"acCallbackMetadata":{"$ref":"#/components/schemas/AnyJson"},"acCallbackSecret":{"type":"string"},"acCallbackUrl":{"type":"string"},"acMaxDelaySecs":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"required":["acMaxDelaySecs","acAutoConsume"],"type":"object"},"AuctionConfig":{"description":"A bucket's auction (PUT /buckets/{id}/auction). kind quantity: each round, on schedule, a lot of whole units of unit is allocated among the standing bids, highest price per unit first (earlier bid first on a tie); each winner gets a child bucket carved off this one and collects a key on it (POST /bids/{id}/key); unit and schedule are required. kind bucket: the bucket itself is sold once, at closesAt, to the highest bid, which pays the second-highest price under uniform pricing (the reserve when there is no other bid) and collects a key on this bucket; closesAt and award.expiresAt are required, and unit, schedule, lot and class are refused. See GET /help/auctions.","properties":{"award":{"$ref":"#/components/schemas/AwardSpec"},"class":{"description":"The consume class the lot is taken as: the lot stays above that class's floors. Absent: the bucket's default class.","type":"string"},"closesAt":{"description":"Bucket auctions: when the single round clears; in the future, at most 30 days ahead.","format":"date-time","type":"string"},"funding":{"description":"unfunded (the default: the price is recorded, nothing is spent) or funded (every bid names a payer bucket; its worth is held there at placement and what a round says it owes is spent from it).","enum":["unfunded","funded"],"type":"string"},"kind":{"description":"quantity (units by rounds) or bucket (the bucket itself, once)","enum":["quantity","bucket"],"type":"string"},"lot":{"description":"\"available\" (every whole unit the bucket can supply, the default) or a positive whole number of units (capped by what is available)."},"priceUnit":{"description":"What prices are in, a word (points). In a funded auction, the dimension of the payer buckets the price is spent from (credits).","type":"string"},"pricing":{"description":"uniform (default): every winner pays the lowest winning price; pay_as_bid: each pays its own.","enum":["uniform","pay_as_bid"],"type":"string"},"reservePrice":{"description":"A bid priced below this never wins.","type":"number"},"schedule":{"$ref":"#/components/schemas/ReplenishSchedule"},"unit":{"additionalProperties":{"type":"number"},"description":"The bundle a bid buys multiples of: dimension -> positive amount; every dimension must exist on the bucket.","type":"object"},"visibility":{"description":"sealed: a bidder never sees another bidder's price. open is reserved.","enum":["sealed"],"type":"string"}},"required":["kind","priceUnit"],"type":"object"},"AuctionView":{"description":"A bucket's auction and where it stands. status: open, removed (DELETE) or closed (its bucket went, or a bucket auction's round cleared). catalogue, for a bucket auction: what is for sale, read from the bucket now (resources, status, replenishConfig, expiresAt, awardExpiresAt, keyScopes); null for a quantity auction.","properties":{"bucketId":{"format":"uuid","type":"string"},"catalogue":{"type":"object"},"config":{"$ref":"#/components/schemas/AuctionConfig"},"createdAt":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"nextRoundAt":{"format":"date-time","type":"string"},"roundsHeld":{"type":"integer"},"standingBids":{"type":"integer"},"status":{"enum":["open","removed","closed"],"type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"required":["id","bucketId","status","config","roundsHeld","standingBids","createdAt","updatedAt"],"type":"object"},"AwardSpec":{"description":"What the winner's bucket and key look like. Quantity auctions: the award bucket expires expiresAfterSeconds after the round that created it (60 to 86400, default 3600; a later round that tops it up pushes it out). Bucket auctions: expiresAt (required, after closesAt) is the sold bucket's expiry, written on it when it is sold; refused on a quantity auction. The key the winner collects expires with the award bucket and carries keyScopes (default [ScopeConsume]; never ScopeBid).","properties":{"expiresAfterSeconds":{"type":"integer"},"expiresAt":{"format":"date-time","type":"string"},"keyScopes":{"items":{"$ref":"#/components/schemas/Scope"},"type":"array"}},"type":"object"},"BidView":{"description":"A bid. bidder is the key that placed it. status: standing, filled, cancelled or expired. awardBucketId: the child bucket a won bid was given (topped up by later rounds); keyCollected: whether POST /bids/{id}/key has been answered for it. Funded bids: payerBucketId, escrow (what is held on the payer now, price x remaining units while the bid stands, 0 after) and escrowReservationId (the reservation that holds it, or last held it). callbackUrlTruncated: the bid's callback URL shortened (scheme, host and port, the first path segment only when it is at most 16 characters with no digit, … for the rest of the path, ?… for a query string), null without a callback; the callback secret is never returned. auctionKind: the kind of the auction the bid is on, quantity or bucket; on a bucket auction units is 1 and price is for the whole bucket.","properties":{"auctionId":{"format":"uuid","type":"string"},"auctionKind":{"enum":["quantity","bucket"],"type":"string"},"awardBucketId":{"format":"uuid","type":"string"},"bidder":{"format":"uuid","type":"string"},"bucketId":{"format":"uuid","type":"string"},"callbackUrlTruncated":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"escrow":{"type":"number"},"escrowReservationId":{"format":"uuid","type":"string"},"expiresAt":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"keyCollected":{"type":"boolean"},"metadata":{},"minUnits":{"type":"integer"},"payerBucketId":{"format":"uuid","type":"string"},"price":{"type":"number"},"remaining":{"type":"integer"},"resolvedAt":{"format":"date-time","type":"string"},"status":{"enum":["standing","filled","cancelled","expired"],"type":"string"},"statusReason":{"type":"string"},"units":{"type":"integer"},"unitsAwarded":{"type":"integer"},"updatedAt":{"format":"date-time","type":"string"}},"required":["id","auctionId","bucketId","bidder","units","minUnits","remaining","unitsAwarded","price","status","createdAt","updatedAt","expiresAt","keyCollected","auctionKind"],"type":"object"},"BreakdownGroup":{"description":"One value of the key in GET /buckets/:id/consume-breakdown: bgValue (a string as it is, a number or a boolean as its JSON text), how many bucket.consumed events carried it (bgConsumes) and what they consumed per dimension (bgConsumed).","properties":{"bgConsumed":{"additionalProperties":{"type":"number"},"type":"object"},"bgConsumes":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"bgValue":{"type":"string"}},"required":["bgValue","bgConsumes","bgConsumed"],"type":"object"},"BreakdownResp":{"description":"GET /buckets/:id/consume-breakdown?key=&dimension=&periods_back=&window_days=&subtree=&limit=: what the bucket consumed, grouped by the value of one key (key, required) of each consume's caller metadata (a consume's crMetadata, a commit's crqMetadata, a claim's metadata). brGroups: the first limit values (default 50, at most 500), ranked by dimension's amount when dimension is given (it also narrows every figure to that dimension), else by consumes; brOther: the rest, summed; brUnattributed: consumes without the key (or with an object, array or null under it). The window is a period (periods_back, 0 = the open one, default; up to 366) or the last window_days days (1..366), never both, and starts no earlier than the history-retention cutoff (brSince). subtree=true adds the descendants' consumes. A bucket with no such period on record has brPeriodStart null and no figure. Read from the event log on the reporting connection, which may lag the latest writes; for a key the bucket declares in its buckette/breakdown-keys metadata, whole hours and days come from a roll-up of the same events (brRolledSince..brRolledUntil, null when none), with the same figures.","properties":{"brAccuracy":{"type":"string"},"brBucketId":{"$ref":"#/components/schemas/BucketId"},"brDimension":{"type":"string"},"brDistinctValues":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"brGroups":{"items":{"$ref":"#/components/schemas/BreakdownGroup"},"type":"array"},"brKey":{"type":"string"},"brLimit":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"brOther":{"$ref":"#/components/schemas/BreakdownTotal"},"brPeriodEnd":{"$ref":"#/components/schemas/UTCTime"},"brPeriodStart":{"$ref":"#/components/schemas/UTCTime"},"brPeriodsBack":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"brRolledSince":{"$ref":"#/components/schemas/UTCTime"},"brRolledUntil":{"$ref":"#/components/schemas/UTCTime"},"brSince":{"$ref":"#/components/schemas/UTCTime"},"brSubtree":{"type":"boolean"},"brUnattributed":{"$ref":"#/components/schemas/BreakdownTotal"},"brUntil":{"$ref":"#/components/schemas/UTCTime"},"brWindowDays":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"required":["brBucketId","brKey","brSubtree","brUntil","brLimit","brGroups","brOther","brUnattributed","brDistinctValues","brAccuracy"],"type":"object"},"BreakdownTotal":{"description":"A sum in GET /buckets/:id/consume-breakdown: btValues distinct values (0 for brUnattributed), btConsumes consumes, btConsumed per dimension.","properties":{"btConsumed":{"additionalProperties":{"type":"number"},"type":"object"},"btConsumes":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"btValues":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"required":["btValues","btConsumes","btConsumed"],"type":"object"},"Bucket":{"properties":{"bucketClassConfig":{"$ref":"#/components/schemas/ClassConfig"},"bucketConfigVersion":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"bucketCreatedAt":{"$ref":"#/components/schemas/UTCTime"},"bucketExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"bucketId":{"$ref":"#/components/schemas/BucketId"},"bucketIdempotencyKey":{"type":"string"},"bucketMetadata":{"$ref":"#/components/schemas/AnyJson"},"bucketParentId":{"$ref":"#/components/schemas/BucketId"},"bucketReplenishConfig":{"$ref":"#/components/schemas/ReplenishConfig"},"bucketReplenishCount":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"bucketReservationPolicy":{"$ref":"#/components/schemas/ReservationPolicy"},"bucketResources":{"additionalProperties":{"$ref":"#/components/schemas/ResourceAmount"},"type":"object"},"bucketStatus":{"$ref":"#/components/schemas/BucketStatus"},"bucketThresholdConfig":{"additionalProperties":{"$ref":"#/components/schemas/ThresholdSpec"},"type":"object"},"bucketUnspentWarning":{"$ref":"#/components/schemas/UnspentWarningConfig"},"bucketUpdatedAt":{"$ref":"#/components/schemas/UTCTime"},"bucketVersion":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"required":["bucketId","bucketStatus","bucketResources","bucketMetadata","bucketVersion","bucketConfigVersion","bucketCreatedAt","bucketUpdatedAt","bucketReplenishCount"],"type":"object"},"BucketDeletionPolicy":{"oneOf":[{"properties":{"tag":{"enum":["KeepAllBuckets"],"type":"string"}},"required":["tag"],"title":"KeepAllBuckets","type":"object"},{"properties":{"contents":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tag":{"enum":["DeleteArchivedAfterDays"],"type":"string"}},"required":["tag","contents"],"title":"DeleteArchivedAfterDays","type":"object"}]},"BucketDeletionPolicyEffect":{"properties":{"bdpeEligibleNow":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"bdpePolicy":{"$ref":"#/components/schemas/BucketDeletionPolicy"}},"required":["bdpeEligibleNow"],"type":"object"},"BucketDeletionStatus":{"properties":{"bdsApiKeysRevoked":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"bdsBucketId":{"$ref":"#/components/schemas/BucketId"},"bdsDecommissionedAt":{"$ref":"#/components/schemas/UTCTime"},"bdsDropped":{"additionalProperties":{"type":"number"},"type":"object"},"bdsParentId":{"$ref":"#/components/schemas/BucketId"},"bdsPurgedRows":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"bdsReclaimed":{"additionalProperties":{"type":"number"},"type":"object"},"bdsRemainingRows":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"bdsRequestedAt":{"$ref":"#/components/schemas/UTCTime"},"bdsRequestedBy":{"type":"string"},"bdsReservationsVoided":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"bdsSubtreeSize":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"required":["bdsBucketId","bdsRequestedAt","bdsRequestedBy","bdsSubtreeSize","bdsReclaimed","bdsDropped","bdsApiKeysRevoked","bdsReservationsVoided","bdsPurgedRows","bdsRemainingRows"],"type":"object"},"BucketId":{"format":"uuid","type":"string"},"BucketLabelCount":{"description":"One label of GET /buckets/labels: a string of the buckette/labels metadata array, and blcCount, how many of the answered buckets carry it.","properties":{"blcCount":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"blcLabel":{"type":"string"}},"required":["blcLabel","blcCount"],"type":"object"},"BucketLabelsResp":{"description":"GET /buckets/labels: the distinct labels of every bucket GET /buckets matches with the same q, status, used_within_hours and unused_for_hours (on any page; no label filter), plus the ancestors and descendants with_parents/with_descendants add. Most common first, then by label. At most blrLimit (limit, default 200, at most 1000); blrTruncated says more labels exist, and the least common are the ones left out.","properties":{"blrLabels":{"items":{"$ref":"#/components/schemas/BucketLabelCount"},"type":"array"},"blrLimit":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"blrTruncated":{"type":"boolean"}},"required":["blrLabels","blrTruncated","blrLimit"],"type":"object"},"BucketRecencyCurve":{"properties":{"brcBands":{"items":{"$ref":"#/components/schemas/RecencyBand"},"type":"array"},"brcDormant":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"brcTotal":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"brcUsed":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"brcWindowDays":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"required":["brcWindowDays","brcTotal","brcUsed","brcDormant","brcBands"],"type":"object"},"BucketStats":{"properties":{"bsCurrentBalance":{"additionalProperties":{"type":"number"},"type":"object"},"bsFractionRemaining":{"additionalProperties":{"type":"number"},"type":"object"},"bsLastConsumedAt":{"$ref":"#/components/schemas/UTCTime"},"bsLastReplenishedAt":{"$ref":"#/components/schemas/UTCTime"},"bsOperationCounts":{"additionalProperties":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"type":"object"},"bsTotalClaimShortfallAllTime":{"additionalProperties":{"type":"number"},"type":"object"},"bsTotalConsumed":{"additionalProperties":{"type":"number"},"type":"object"},"bsTotalConsumedAllTime":{"additionalProperties":{"type":"number"},"type":"object"},"bsTotalDiscardedAllTime":{"additionalProperties":{"additionalProperties":{"type":"number"},"type":"object"},"type":"object"},"bsTotalForgivenAllTime":{"additionalProperties":{"type":"number"},"type":"object"},"bsTotalOverageAllTime":{"additionalProperties":{"type":"number"},"type":"object"},"bsTotalReplenished":{"additionalProperties":{"type":"number"},"type":"object"},"bsTotalReplenishedAllTime":{"additionalProperties":{"type":"number"},"type":"object"},"bsTotalReserveShortfallAllTime":{"additionalProperties":{"type":"number"},"type":"object"},"bsTotalShortfallAllTime":{"additionalProperties":{"type":"number"},"type":"object"},"bsTotalShortfallUnkeyedAllTime":{"additionalProperties":{"type":"number"},"type":"object"},"bsTotalTransferShortfallAllTime":{"additionalProperties":{"type":"number"},"type":"object"}},"required":["bsOperationCounts","bsTotalConsumed","bsTotalReplenished","bsTotalConsumedAllTime","bsTotalReplenishedAllTime","bsTotalShortfallAllTime","bsTotalShortfallUnkeyedAllTime","bsTotalDiscardedAllTime","bsTotalOverageAllTime","bsTotalForgivenAllTime","bsTotalReserveShortfallAllTime","bsTotalClaimShortfallAllTime","bsTotalTransferShortfallAllTime","bsCurrentBalance","bsFractionRemaining"],"type":"object"},"BucketStatus":{"enum":["Active","Frozen","Depleted","Archived"],"type":"string"},"BucketStatusCount":{"properties":{"bscCount":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"bscStatus":{"type":"string"}},"required":["bscStatus","bscCount"],"type":"object"},"BucketTreeNode":{"properties":{"btnBucket":{"$ref":"#/components/schemas/Bucket"},"btnChildren":{"items":{"$ref":"#/components/schemas/BucketTreeNode"},"type":"array"}},"required":["btnBucket","btnChildren"],"type":"object"},"CallbackAllowlistReq":{"properties":{"calrHosts":{"items":{"type":"string"},"type":"array"}},"required":["calrHosts"],"type":"object"},"CarryoverPolicy":{"enum":["CarryoverNone","CarryoverLimited","CarryoverUnlimited"],"type":"string"},"ClaimBucketShortfall":{"properties":{"cbsAvailable":{"additionalProperties":{"type":"number"},"type":"object"},"cbsBucketId":{"$ref":"#/components/schemas/BucketId"},"cbsShortfall":{"additionalProperties":{"type":"number"},"type":"object"},"cbsStatus":{"$ref":"#/components/schemas/BucketStatus"}},"required":["cbsBucketId","cbsStatus","cbsShortfall","cbsAvailable"],"type":"object"},"ClaimGrant":{"properties":{"cgBucketId":{"$ref":"#/components/schemas/BucketId"},"cgConsumed":{"additionalProperties":{"type":"number"},"type":"object"},"cgRemaining":{"additionalProperties":{"type":"number"},"type":"object"}},"required":["cgBucketId","cgConsumed","cgRemaining"],"type":"object"},"ClaimInfo":{"properties":{"ciAutoConsume":{"type":"boolean"},"ciBlockedBy":{"$ref":"#/components/schemas/UUID"},"ciCreatedAt":{"$ref":"#/components/schemas/UTCTime"},"ciDependsOn":{"items":{"$ref":"#/components/schemas/UUID"},"type":"array"},"ciExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"ciGrantResult":{"$ref":"#/components/schemas/AnyJson"},"ciGrantedAt":{"$ref":"#/components/schemas/UTCTime"},"ciId":{"$ref":"#/components/schemas/UUID"},"ciIntentsAhead":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"ciLastAttemptAt":{"$ref":"#/components/schemas/UTCTime"},"ciMetadata":{"$ref":"#/components/schemas/AnyJson"},"ciPriority":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"ciQueueDiscipline":{"$ref":"#/components/schemas/ClaimQueueDiscipline"},"ciQueuePosition":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"ciShortfalls":{"items":{"$ref":"#/components/schemas/ClaimBucketShortfall"},"type":"array"},"ciStatus":{"type":"string"},"ciStrategy":{"$ref":"#/components/schemas/ClaimStrategy"},"ciTargets":{"items":{"$ref":"#/components/schemas/ClaimTarget"},"type":"array"},"ciValue":{"additionalProperties":{"type":"number"},"type":"object"},"ciWaitReason":{"type":"string"},"ciWaitingOn":{"items":{"$ref":"#/components/schemas/UUID"},"type":"array"}},"required":["ciId","ciTargets","ciStrategy","ciAutoConsume","ciPriority","ciQueueDiscipline","ciStatus","ciCreatedAt","ciExpiresAt"],"type":"object"},"ClaimOutcome":{"oneOf":[{"properties":{"cloCorrelationId":{"$ref":"#/components/schemas/UUID"},"cloGrants":{"items":{"$ref":"#/components/schemas/ClaimGrant"},"type":"array"},"cloReceipt":{"type":"string"},"tag":{"enum":["ClaimSuccess"],"type":"string"}},"required":["cloGrants","tag"],"title":"ClaimSuccess","type":"object"},{"properties":{"cloShortfalls":{"items":{"$ref":"#/components/schemas/ClaimBucketShortfall"},"type":"array"},"tag":{"enum":["ClaimShortfall"],"type":"string"}},"required":["cloShortfalls","tag"],"title":"ClaimShortfall","type":"object"},{"properties":{"cloAutoConsume":{"type":"boolean"},"cloClaimId":{"$ref":"#/components/schemas/UUID"},"cloExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"cloPriority":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tag":{"enum":["ClaimPending"],"type":"string"}},"required":["cloClaimId","cloPriority","cloAutoConsume","cloExpiresAt","tag"],"title":"ClaimPending","type":"object"}]},"ClaimQueueDiscipline":{"enum":["QueueBlocking","QueueOpportunistic"],"type":"string"},"ClaimRequest":{"properties":{"clrClass":{"type":"string"},"clrDependsOn":{"items":{"$ref":"#/components/schemas/UUID"},"type":"array"},"clrMetadata":{"$ref":"#/components/schemas/AnyJson"},"clrMode":{"$ref":"#/components/schemas/ConsumeMode"},"clrNonce":{"type":"string"},"clrPriority":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"clrQueueDiscipline":{"$ref":"#/components/schemas/ClaimQueueDiscipline"},"clrStrategy":{"$ref":"#/components/schemas/ClaimStrategy"},"clrTargets":{"items":{"$ref":"#/components/schemas/ClaimTarget"},"type":"array"},"clrValue":{"additionalProperties":{"type":"number"},"description":"What the claim is worth to you: a number per utility kind, the kinds named by you (revenue, customers, points) and the unit per kind yours. 1 to 16 kinds, a name of 1 to 64 characters not starting with $, a number at most 1e15 in magnitude with at most 12 decimal places, negative allowed. Absent means unvalued, not zero. Recorded on the claim and written as value on the events it writes; never acted on: queued claims are still ordered by priority, then arrival.","type":"object"}},"required":["clrTargets","clrStrategy","clrMode"],"type":"object"},"ClaimReservation":{"properties":{"crCreatedAt":{"$ref":"#/components/schemas/UTCTime"},"crExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"crGrants":{"items":{"$ref":"#/components/schemas/ClaimReservationGrant"},"type":"array"},"crId":{"$ref":"#/components/schemas/UUID"},"crStatus":{"type":"string"},"crStrategy":{"$ref":"#/components/schemas/ClaimStrategy"},"crTransactionId":{"type":"string"},"crValue":{"additionalProperties":{"type":"number"},"type":"object"}},"required":["crId","crGrants","crStrategy","crCreatedAt","crStatus"],"type":"object"},"ClaimReservationGrant":{"properties":{"crgAmounts":{"additionalProperties":{"type":"number"},"type":"object"},"crgBucketId":{"$ref":"#/components/schemas/BucketId"}},"required":["crgBucketId","crgAmounts"],"type":"object"},"ClaimReserveOutcome":{"oneOf":[{"properties":{"crsCommitToken":{"type":"string"},"crsReservation":{"$ref":"#/components/schemas/ClaimReservation"},"tag":{"enum":["ClaimReserveSuccess"],"type":"string"}},"required":["crsReservation","tag"],"title":"ClaimReserveSuccess","type":"object"},{"properties":{"crsShortfalls":{"items":{"$ref":"#/components/schemas/ClaimBucketShortfall"},"type":"array"},"tag":{"enum":["ClaimReserveShortfall"],"type":"string"}},"required":["crsShortfalls","tag"],"title":"ClaimReserveShortfall","type":"object"},{"properties":{"crpAutoReserve":{"type":"boolean"},"crpExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"crpPendingId":{"$ref":"#/components/schemas/UUID"},"crpPriority":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tag":{"enum":["ClaimReservePending"],"type":"string"}},"required":["crpPendingId","crpPriority","crpAutoReserve","crpExpiresAt","tag"],"title":"ClaimReservePending","type":"object"}]},"ClaimReserveReq":{"properties":{"clrrClass":{"type":"string"},"clrrExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"clrrMetadata":{"$ref":"#/components/schemas/AnyJson"},"clrrMode":{"$ref":"#/components/schemas/ConsumeMode"},"clrrNonce":{"type":"string"},"clrrPriority":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"clrrQueueDiscipline":{"$ref":"#/components/schemas/ClaimQueueDiscipline"},"clrrStrategy":{"$ref":"#/components/schemas/ClaimStrategy"},"clrrTargets":{"items":{"$ref":"#/components/schemas/ClaimTarget"},"type":"array"},"clrrTransactionId":{"type":"string"},"clrrValue":{"additionalProperties":{"type":"number"},"description":"What the claim reservation is worth to you: a number per utility kind, the kinds named by you (revenue, customers, points) and the unit per kind yours. 1 to 16 kinds, a name of 1 to 64 characters not starting with $, a number at most 1e15 in magnitude with at most 12 decimal places, negative allowed. Absent means unvalued, not zero. Recorded on the claim reservation and written as value on the events it writes; never acted on: queued claims are still ordered by priority, then arrival.","type":"object"}},"required":["clrrTargets","clrrStrategy","clrrMode"],"type":"object"},"ClaimStrategy":{"oneOf":[{"properties":{"tag":{"enum":["AllOf"],"type":"string"}},"required":["tag"],"title":"AllOf","type":"object"},{"properties":{"contents":{"$ref":"#/components/schemas/PickPolicy"},"tag":{"enum":["FirstOf"],"type":"string"}},"required":["tag","contents"],"title":"FirstOf","type":"object"}]},"ClaimTarget":{"properties":{"ctAmounts":{"additionalProperties":{"type":"number"},"type":"object"},"ctBucketId":{"$ref":"#/components/schemas/BucketId"}},"required":["ctBucketId","ctAmounts"],"type":"object"},"ClaimValueAmountRow":{"properties":{"cvaConsumed":{"type":"number"},"cvaDimension":{"type":"string"},"cvaKind":{"type":"string"},"cvaShortfall":{"type":"number"}},"required":["cvaDimension","cvaConsumed","cvaShortfall"],"type":"object"},"ClaimValueKindRow":{"properties":{"cvkClaims":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"cvkKind":{"type":"string"},"cvkOutcome":{"type":"string"},"cvkValue":{"type":"number"}},"required":["cvkKind","cvkOutcome","cvkClaims","cvkValue"],"type":"object"},"ClaimValueOutcomeRow":{"properties":{"cvoClaims":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"cvoOutcome":{"type":"string"},"cvoUnvalued":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"required":["cvoOutcome","cvoClaims","cvoUnvalued"],"type":"object"},"ClaimValueRefusedRow":{"properties":{"cvrAt":{"$ref":"#/components/schemas/UTCTime"},"cvrBuckets":{"items":{"$ref":"#/components/schemas/UUID"},"type":"array"},"cvrClaimId":{"$ref":"#/components/schemas/UUID"},"cvrKind":{"type":"string"},"cvrOutcome":{"type":"string"},"cvrRank":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"cvrShortfall":{"additionalProperties":{"type":"number"},"type":"object"},"cvrValue":{"additionalProperties":{"type":"number"},"type":"object"}},"required":["cvrKind","cvrRank","cvrClaimId","cvrOutcome","cvrValue","cvrAt","cvrBuckets","cvrShortfall"],"type":"object"},"ClaimValueResp":{"properties":{"cvAmounts":{"items":{"$ref":"#/components/schemas/ClaimValueAmountRow"},"type":"array"},"cvBucketId":{"$ref":"#/components/schemas/UUID"},"cvKinds":{"items":{"$ref":"#/components/schemas/ClaimValueKindRow"},"type":"array"},"cvLimit":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"cvOutcomes":{"items":{"$ref":"#/components/schemas/ClaimValueOutcomeRow"},"type":"array"},"cvSince":{"$ref":"#/components/schemas/UTCTime"},"cvTopRefused":{"items":{"$ref":"#/components/schemas/ClaimValueRefusedRow"},"type":"array"},"cvUntil":{"$ref":"#/components/schemas/UTCTime"},"cvWindowDays":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"cvWindowLimitedBy":{"type":"string"}},"required":["cvWindowDays","cvWindowLimitedBy","cvSince","cvUntil","cvLimit","cvOutcomes","cvKinds","cvAmounts","cvTopRefused"],"type":"object"},"ClassConfig":{"description":"A bucket's consume classes. classes maps a class name to its floors per dimension; a class declared as {} may spend everything. default_class, when set, is the class of a request that names none.","properties":{"classes":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ClassFloor"},"type":"object"},"type":"object"},"default_class":{"type":"string"}},"required":["classes"],"type":"object"},"ClassFigures":{"properties":{"cfConsumed":{"type":"number"},"cfOverage":{"type":"number"},"cfShortfall":{"type":"number"},"cfShortfallUnkeyed":{"type":"number"}},"required":["cfConsumed","cfShortfall","cfShortfallUnkeyed","cfOverage"],"type":"object"},"ClassFloor":{"description":"One class's protection on one dimension: a consume of the class must leave at least this much available (current minus reserved). release says how the floor goes down over the bucket's replenishment period: none (constant), linear (the default: floor x time left / period length), or step (whole until lead_seconds before the next run, then zero).","properties":{"floor":{"type":"number"},"lead_seconds":{"type":"integer"},"release":{"enum":["none","linear","step"],"type":"string"}},"required":["floor"],"type":"object"},"CommitReq":{"properties":{"crqAmounts":{"additionalProperties":{"type":"number"},"type":"object"},"crqMetadata":{"description":"Caller metadata for this settlement: any JSON, at most 1 KiB encoded, the same field as a consume's crMetadata. Written as metadata in the bucket.consumed event-log record of the commit. Accepted through X-Buckette-Commit-Token as well as an API key."},"crqTransferTo":{"$ref":"#/components/schemas/BucketId"}},"type":"object"},"ConsumeMode":{"oneOf":[{"properties":{"tag":{"enum":["Strict"],"type":"string"}},"required":["tag"],"title":"Strict","type":"object"},{"properties":{"tag":{"enum":["Partial"],"type":"string"}},"required":["tag"],"title":"Partial","type":"object"},{"properties":{"contents":{"$ref":"#/components/schemas/WaitConfig"},"tag":{"enum":["Wait"],"type":"string"}},"required":["tag","contents"],"title":"Wait","type":"object"},{"properties":{"contents":{"$ref":"#/components/schemas/AsyncConfig"},"tag":{"enum":["Async"],"type":"string"}},"required":["tag","contents"],"title":"Async","type":"object"}]},"ConsumeOutcome":{"oneOf":[{"properties":{"coConsumed":{"additionalProperties":{"type":"number"},"type":"object"},"coOverage":{"additionalProperties":{"type":"number"},"type":"object"},"coProtection":{"$ref":"#/components/schemas/ConsumeProtection"},"coReceipt":{"type":"string"},"coRemaining":{"additionalProperties":{"type":"number"},"type":"object"},"tag":{"enum":["ConsumeSuccess"],"type":"string"}},"required":["coConsumed","coRemaining","tag"],"title":"ConsumeSuccess","type":"object"},{"properties":{"coAvailable":{"additionalProperties":{"type":"number"},"type":"object"},"coEta":{"$ref":"#/components/schemas/ShortfallEta"},"coProtection":{"$ref":"#/components/schemas/ConsumeProtection"},"coShortfall":{"additionalProperties":{"type":"number"},"type":"object"},"tag":{"enum":["ConsumeShortfall"],"type":"string"}},"required":["coShortfall","coAvailable","coEta","tag"],"title":"ConsumeShortfall","type":"object"},{"properties":{"coAutoConsume":{"type":"boolean"},"coAvailable":{"additionalProperties":{"type":"number"},"type":"object"},"coEta":{"$ref":"#/components/schemas/ShortfallEta"},"coExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"coPendingId":{"$ref":"#/components/schemas/UUID"},"coShortfall":{"additionalProperties":{"type":"number"},"type":"object"},"tag":{"enum":["ConsumePending"],"type":"string"}},"required":["coPendingId","coShortfall","coAvailable","coAutoConsume","coExpiresAt","coEta","tag"],"title":"ConsumePending","type":"object"}]},"ConsumeProtection":{"properties":{"cpClass":{"type":"string"},"cpFloor":{"additionalProperties":{"type":"number"},"type":"object"},"cpProtected":{"type":"boolean"}},"required":["cpClass","cpFloor","cpProtected"],"type":"object"},"ConsumeRequest":{"properties":{"crAmounts":{"additionalProperties":{"type":"number"},"type":"object"},"crClass":{"type":"string"},"crIdempotencyKey":{"description":"Runs the consume at most once per key and bucket within seven days; a retry with the same crAmounts and crClass replays the recorded outcome, and one with different amounts or class is refused with 409 idempotency_key_mismatch. The key also gates the record of a refusal: when the one call that ran the request is not served whole (Strict refused, Wait gave up, the unmet remainder of a Partial, or refused because the bucket ran out), one bucket.consume_shortfall line is written to the bucket's event log and one webhook of that name is fired with the same details (requested, available, shortfall, mode, idempotency_key, metadata; class, floor and reason under a consume class). A replay writes and fires nothing, and so does a consume with no key. A key that met a refusal because the bucket ran out keeps it: a retry under that key answers the same refusal.","type":"string"},"crMetadata":{"$ref":"#/components/schemas/AnyJson"},"crMode":{"$ref":"#/components/schemas/ConsumeMode"},"crNonce":{"type":"string"}},"required":["crAmounts","crMode"],"type":"object"},"ConsumeShortfallTotal":{"properties":{"cstBucket":{"$ref":"#/components/schemas/UUID"},"cstDimension":{"type":"string"},"cstEvents":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"cstShortfall":{"type":"number"}},"required":["cstBucket","cstDimension","cstShortfall","cstEvents"],"type":"object"},"CorsAllowedOriginsReq":{"properties":{"caorOrigins":{"items":{"type":"string"},"type":"array"}},"required":["caorOrigins"],"type":"object"},"CreateApiKeyReq":{"properties":{"cakreBucketId":{"$ref":"#/components/schemas/BucketId"},"cakreBucketIds":{"items":{"$ref":"#/components/schemas/BucketId"},"minItems":1,"type":"array"},"cakreClasses":{"items":{"type":"string"},"type":"array"},"cakreExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"cakreExpiresInMinutes":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"cakreName":{"type":"string"},"cakreRateLimitBurst":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"cakreRateLimitRpm":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"cakreScopes":{"items":{"$ref":"#/components/schemas/Scope"},"type":"array"}},"required":["cakreName","cakreScopes"],"type":"object"},"CreateApiKeyResp":{"properties":{"cakrBucketId":{"$ref":"#/components/schemas/BucketId"},"cakrBucketIds":{"items":{"$ref":"#/components/schemas/BucketId"},"type":"array"},"cakrClasses":{"items":{"type":"string"},"type":"array"},"cakrCreatedAt":{"$ref":"#/components/schemas/UTCTime"},"cakrExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"cakrId":{"$ref":"#/components/schemas/UUID"},"cakrKey":{"type":"string"},"cakrName":{"type":"string"},"cakrRateLimitBurst":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"cakrRateLimitRpm":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"cakrScopes":{"items":{"$ref":"#/components/schemas/Scope"},"type":"array"}},"required":["cakrId","cakrKey","cakrName","cakrScopes","cakrCreatedAt","cakrBucketIds","cakrClasses"],"type":"object"},"CreateBucketReq":{"properties":{"cbrExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"cbrIdempotencyKey":{"type":"string"},"cbrMetadata":{"$ref":"#/components/schemas/AnyJson"},"cbrParentId":{"$ref":"#/components/schemas/BucketId"},"cbrReservationPolicy":{"$ref":"#/components/schemas/ReservationPolicy"},"cbrResources":{"additionalProperties":{"$ref":"#/components/schemas/ResourceAmount"},"type":"object"}},"required":["cbrResources"],"type":"object"},"CreateDestinationReq":{"properties":{"cdrKind":{"type":"string"},"cdrValue":{"type":"string"}},"required":["cdrKind","cdrValue"],"type":"object"},"CreateWebhookReq":{"properties":{"cwrEvents":{"description":"Event names to deliver; an empty list means every event. GET /help/events is the reference for each name, when it fires and what its details carry. Among them, the three about budget on both sides: bucket.consume_shortfall (a consume with an idempotency key was not served whole; one delivery per line of the event log), bucket.reserve_shortfall and bucket.claim_shortfall (the same for a refused reservation, claim or claim reservation, one per bucket short), bucket.transfer_shortfall (a transfer refused because its source lacked the amount, on the source; once per trTransactionId when sent), bucket.replenish_discarded (a replenishment discarded more than zero) and bucket.unspent_expiring (the next scheduled run would discard something; needs PUT /buckets/{id}/unspent-warning).","items":{"type":"string"},"type":"array"},"cwrMetadata":{"$ref":"#/components/schemas/AnyJson"},"cwrSecret":{"type":"string"},"cwrUrl":{"type":"string"}},"required":["cwrUrl","cwrEvents"],"type":"object"},"DepletionWarningConfig":{"description":"A bucket's projected-depletion warning: one bucket.depletion_projected webhook per scheduled refill when the consumption of the trailing window, carried forward, empties a dimension more than the margin before that refill. Exactly one of margin_seconds and margin_share.","properties":{"margin_seconds":{"description":"The margin in seconds.","maximum":31622400,"minimum":0,"type":"integer"},"margin_share":{"description":"The margin as a share of the period ending at the refill.","exclusiveMaximum":true,"maximum":1,"minimum":0,"type":"number"},"window_seconds":{"description":"The trailing window the rate is measured over. Absent: a tenth of the period, at least 300.","maximum":2678400,"minimum":60,"type":"integer"}},"type":"object"},"DepletionWarningView":{"properties":{"config":{"$ref":"#/components/schemas/DepletionWarningConfig"},"projection":{"description":"The projection as it stands (null without a schedule): the next refill, the period, window and margin in seconds, and every dimension spent in the window; short says which would warn.","properties":{"dimensions":{"additionalProperties":{"properties":{"available":{"type":"number"},"consumed_in_window":{"type":"number"},"empty_at":{"format":"date-time","type":"string"},"rate_per_second":{"type":"number"},"seconds_before_refill":{"type":"integer"},"short":{"type":"boolean"}},"type":"object"},"type":"object"},"margin_seconds":{"type":"integer"},"next_refill_at":{"format":"date-time","type":"string"},"period_seconds":{"type":"integer"},"seconds_until_refill":{"type":"integer"},"window_seconds":{"type":"integer"}},"type":"object"},"warned_for":{"description":"The refill a warning was last sent for.","format":"date-time","type":"string"}},"required":["config"],"type":"object"},"DestinationCheckRecord":{"properties":{"dcrCheckedAt":{"$ref":"#/components/schemas/UTCTime"},"dcrDetail":{"type":"string"},"dcrOutcome":{"type":"string"}},"required":["dcrCheckedAt","dcrOutcome"],"type":"object"},"DestinationInfo":{"properties":{"dstCreatedAt":{"$ref":"#/components/schemas/UTCTime"},"dstId":{"$ref":"#/components/schemas/UUID"},"dstKind":{"type":"string"},"dstLastCheckedAt":{"$ref":"#/components/schemas/UTCTime"},"dstLastError":{"type":"string"},"dstProvenance":{"type":"string"},"dstRecordName":{"type":"string"},"dstRecordValue":{"type":"string"},"dstStatus":{"type":"string"},"dstValue":{"type":"string"},"dstVerifiedAt":{"$ref":"#/components/schemas/UTCTime"}},"required":["dstId","dstKind","dstValue","dstStatus","dstCreatedAt","dstProvenance"],"type":"object"},"DimensionModeChange":{"properties":{"dmcConfirmDemote":{"type":"boolean"},"dmcMode":{"$ref":"#/components/schemas/ResourceMode"},"dmcOverageLimit":{"type":"number"},"dmcResetCurrent":{"type":"number"}},"required":["dmcMode","dmcConfirmDemote"],"type":"object"},"DimensionPeriod":{"properties":{"dpClasses":{"additionalProperties":{"$ref":"#/components/schemas/ClassFigures"},"type":"object"},"dpClosing":{"type":"number"},"dpConsumed":{"type":"number"},"dpCredited":{"type":"number"},"dpDiscarded":{"additionalProperties":{"type":"number"},"type":"object"},"dpForgiven":{"type":"number"},"dpLow":{"type":"number"},"dpMode":{"type":"string"},"dpMovedIn":{"type":"number"},"dpMovedOut":{"type":"number"},"dpOpening":{"type":"number"},"dpOverage":{"type":"number"},"dpShortfall":{"type":"number"},"dpShortfallUnkeyed":{"type":"number"},"dpUnclassed":{"$ref":"#/components/schemas/ClassFigures"},"dpWithheld":{"type":"number"}},"required":["dpCredited","dpConsumed","dpShortfall","dpShortfallUnkeyed","dpDiscarded","dpClasses","dpUnclassed","dpMovedIn","dpMovedOut","dpOverage","dpForgiven","dpWithheld"],"type":"object"},"DryRunResp":{"description":"A replenishment policy for one dimension, proposed from the per-period ledger and replayed against it. bucket_id; dimension; mode and balance (live); rows_read; rows_skipped (partial, first, or outside the answered grain's whole periods); grains (offered: day, week, month, schedule); recommended_grain; grain (answered); periods; periods_censored (mode not reporting: demand is a floor); too_few_periods (fewer than 3: proposals is null); no_demand; demand {min, median, at_coverage, max, total, coverage_percent, unit_grain}; series [{start, end, demand, consumed, shortfall, mode (reporting, locking, metered_overage, unknown), observed}] oldest first; proposals {reset, carry_over (null when it saves nothing), custom (when amount, cap and carryover were sent)}, each {policy {amount, cap, carryover (none or unlimited), schedule}, replay {start (the live balance as the switch leaves it, where the replay begins), supplied, served, refused, discarded_carryover, discarded_overflow, left, periods_refused}, per_period [{start, demand, opening, served, refused, discarded_carryover, discarded_overflow}], switch {patch_bucket (body of PATCH /buckets/:id), put_replenish_config (body of PUT /buckets/:id/replenish-config)} or null, switch_blocked (why there is no switch)}; existing_replenish_config; assumptions (read them); subtree (whether subtree=true summed the demand of the buckets under this one) and subtree_buckets (how many, null without it). Nothing is applied.","type":"object"},"EnvelopeScope":{"enum":["EnvelopeSubtree","EnvelopeChildren"],"type":"string"},"EtaAnswer":{"oneOf":[{"properties":{"eaAtUnix":{"type":"integer"},"eaSeconds":{"type":"integer"},"tag":{"enum":["EtaAt"],"type":"string"}},"required":["eaSeconds","eaAtUnix","tag"],"title":"EtaAt","type":"object"},{"properties":{"eaReason":{"$ref":"#/components/schemas/EtaReason"},"tag":{"enum":["EtaNever"],"type":"string"}},"required":["eaReason","tag"],"title":"EtaNever","type":"object"},{"properties":{"eaReason":{"$ref":"#/components/schemas/EtaReason"},"tag":{"enum":["EtaUnknown"],"type":"string"}},"required":["eaReason","tag"],"title":"EtaUnknown","type":"object"}]},"EtaReason":{"enum":["ExceedsMaximum","ExceedsCarryoverNone","ExceedsCarryoverLimited","OverflowRejectStall","AfterExpiry","BucketArchived","BucketDepleted","NoSchedule","NoReplenishAmount","NotYetScheduled","BucketFrozen","HeldByReservations","HeldByClassFloor"],"type":"string"},"EtaRequest":{"properties":{"etqAmounts":{"additionalProperties":{"type":"number"},"type":"object"},"etqClass":{"type":"string"}},"required":["etqAmounts"],"type":"object"},"EventRecord":{"properties":{"erActor":{"type":"string"},"erCursor":{"type":"string"},"erDetails":{"$ref":"#/components/schemas/AnyJson"},"erEventType":{"type":"string"},"erOccurredAt":{"$ref":"#/components/schemas/UTCTime"},"erTransactionId":{"type":"string"}},"required":["erEventType","erActor","erDetails","erOccurredAt","erCursor"],"type":"object"},"FlowEdge":{"properties":{"feAmount":{"type":"number"},"feBucket":{"$ref":"#/components/schemas/UUID"},"feCount":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"feKind":{"$ref":"#/components/schemas/FlowKind"},"feOther":{"$ref":"#/components/schemas/UUID"}},"required":["feKind","feBucket","feAmount","feCount"],"type":"object"},"FlowKind":{"enum":["FlowCreated","FlowReplenish","FlowSplit","FlowReclaim","FlowConsumed"],"type":"string"},"GrowReservationReq":{"properties":{"grqAmounts":{"additionalProperties":{"type":"number"},"type":"object"},"grqTransactionId":{"type":"string"}},"required":["grqAmounts"],"type":"object"},"HealthStatus":{"properties":{"hsDb":{"type":"string"},"hsDuties":{"items":{"type":"string"},"type":"array"},"hsSchedulerCycleSecs":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"hsUnattended":{"items":{"type":"string"},"type":"array"},"hsVersion":{"type":"string"}},"required":["hsDb","hsVersion","hsSchedulerCycleSecs","hsDuties"],"type":"object"},"HelpEntry":{"properties":{"heContent":{"type":"string"},"heEndpoints":{"items":{"type":"string"},"type":"array"},"heName":{"type":"string"},"heSummary":{"type":"string"},"heTramaj":{"type":"string"}},"required":["heName","heSummary","heContent","heEndpoints"],"type":"object"},"HelpIndex":{"properties":{"hiHint":{"type":"string"},"hiTopics":{"items":{"$ref":"#/components/schemas/HelpTopicSummary"},"type":"array"}},"required":["hiTopics","hiHint"],"type":"object"},"HelpTopicSummary":{"properties":{"htsName":{"type":"string"},"htsSummary":{"type":"string"}},"required":["htsName","htsSummary"],"type":"object"},"LedgerFigures":{"properties":{"lfClasses":{"additionalProperties":{"$ref":"#/components/schemas/ClassFigures"},"type":"object"},"lfConsumed":{"type":"number"},"lfCredited":{"type":"number"},"lfDiscarded":{"additionalProperties":{"type":"number"},"type":"object"},"lfForgiven":{"type":"number"},"lfMovedIn":{"type":"number"},"lfMovedOut":{"type":"number"},"lfOverage":{"type":"number"},"lfShortfall":{"type":"number"},"lfShortfallUnkeyed":{"type":"number"},"lfUnclassed":{"$ref":"#/components/schemas/ClassFigures"},"lfWithheld":{"type":"number"}},"required":["lfCredited","lfConsumed","lfShortfall","lfShortfallUnkeyed","lfDiscarded","lfClasses","lfUnclassed","lfMovedIn","lfMovedOut","lfOverage","lfForgiven","lfWithheld"],"type":"object"},"LedgerResp":{"properties":{"lgAccuracy":{"additionalProperties":{"type":"string"},"type":"object"},"lgBucketId":{"$ref":"#/components/schemas/BucketId"},"lgDimension":{"type":"string"},"lgIncludesOpen":{"type":"boolean"},"lgLimit":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"lgRows":{"items":{"$ref":"#/components/schemas/LedgerRow"},"type":"array"},"lgSince":{"$ref":"#/components/schemas/UTCTime"},"lgSort":{"type":"string"},"lgTruncated":{"type":"boolean"},"lgUntil":{"$ref":"#/components/schemas/UTCTime"},"lgWindowDays":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"lgWindowLimitedBy":{"type":"string"}},"required":["lgRows","lgTruncated","lgSort","lgLimit","lgWindowDays","lgWindowLimitedBy","lgSince","lgUntil","lgIncludesOpen","lgAccuracy"],"type":"object"},"LedgerRow":{"properties":{"lrBucketId":{"$ref":"#/components/schemas/BucketId"},"lrDimension":{"type":"string"},"lrFirstPeriodStart":{"$ref":"#/components/schemas/UTCTime"},"lrLow":{"type":"number"},"lrOpenPeriod":{"type":"boolean"},"lrOwn":{"$ref":"#/components/schemas/LedgerFigures"},"lrParentId":{"$ref":"#/components/schemas/BucketId"},"lrPeriods":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"lrStatus":{"$ref":"#/components/schemas/BucketStatus"},"lrSubtree":{"$ref":"#/components/schemas/LedgerFigures"},"lrTitle":{"type":"string"}},"required":["lrBucketId","lrStatus","lrDimension","lrPeriods","lrOpenPeriod","lrOwn","lrSubtree"],"type":"object"},"OverflowAction":{"enum":["OverflowDiscard","OverflowReject"],"type":"string"},"PacingBucket":{"description":"One bucket of GET /buckets/pacing. pbPeriodStart: the open period's start (null when the bucket has no open period on record; no slices then). pbNextReset: the next scheduled replenishment (null without a schedule). pbPeriod: the open period as GET /buckets/:id/periods shows it (opening balance, credited and consumed so far, per class). pbCurrent / pbAvailable: the balance now, and less what is held. pbClassConfig: the classes and floors. pbSlices: oldest first, aligned on pbSlicesFrom (the period start, or the history-retention cutoff when later), each pbSliceSeconds wide.","properties":{"pbAvailable":{"additionalProperties":{"type":"number"},"type":"object"},"pbBucketId":{"$ref":"#/components/schemas/BucketId"},"pbClassConfig":{"$ref":"#/components/schemas/ClassConfig"},"pbCurrent":{"additionalProperties":{"type":"number"},"type":"object"},"pbNextReset":{"$ref":"#/components/schemas/UTCTime"},"pbPeriod":{"$ref":"#/components/schemas/PeriodView"},"pbPeriodEnd":{"$ref":"#/components/schemas/UTCTime"},"pbPeriodStart":{"$ref":"#/components/schemas/UTCTime"},"pbSliceSeconds":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"pbSlices":{"items":{"$ref":"#/components/schemas/PacingSlice"},"type":"array"},"pbSlicesFrom":{"$ref":"#/components/schemas/UTCTime"}},"required":["pbBucketId","pbCurrent","pbAvailable","pbSliceSeconds","pbSlices"],"type":"object"},"PacingResp":{"description":"GET /buckets/pacing: one entry per named bucket the key can see, in the order given; prNotFound lists the others. At most 100 bucket_id values; slice_minutes defaults to 60 (clamped to 5..1440) and is widened per bucket to keep at most 500 slices. periods_back (0..366, default 0) reads that many closed periods back instead of the open one (prPeriodsBack echoes it; pbPeriodEnd is set). Answered from the reporting connection, which may lag the latest writes.","properties":{"prAccuracy":{"type":"string"},"prBuckets":{"items":{"$ref":"#/components/schemas/PacingBucket"},"type":"array"},"prDimension":{"type":"string"},"prNotFound":{"items":{"$ref":"#/components/schemas/BucketId"},"type":"array"},"prPeriodsBack":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"prSliceMinutes":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"prUntil":{"$ref":"#/components/schemas/UTCTime"}},"required":["prBuckets","prNotFound","prSliceMinutes","prPeriodsBack","prUntil","prAccuracy"],"type":"object"},"PacingSlice":{"description":"One slice of a bucket's open period in GET /buckets/pacing: what was consumed in [psStart, psStart + pbSliceSeconds) as the class psClass (\"\" is a consume made with no class), per dimension. A slice and class with nothing consumed is absent.","properties":{"psClass":{"type":"string"},"psConsumed":{"additionalProperties":{"type":"number"},"type":"object"},"psStart":{"$ref":"#/components/schemas/UTCTime"}},"required":["psStart","psClass","psConsumed"],"type":"object"},"PatchBidReq":{"description":"Change a standing bid; counts from the next round. units is the new total and must exceed what was already awarded.","properties":{"minUnits":{"type":"integer"},"price":{"type":"number"},"units":{"type":"integer"}},"type":"object"},"PatchBucketReq":{"properties":{"pbrAddDimensions":{"additionalProperties":{"$ref":"#/components/schemas/ResourceAmount"},"type":"object"},"pbrClearExpiry":{"type":"boolean"},"pbrClearMetadata":{"description":"When true, sets the bucket's metadata to JSON null, and a pbrMetadata sent in the same request is ignored.","type":"boolean"},"pbrDimensionMode":{"additionalProperties":{"$ref":"#/components/schemas/DimensionModeChange"},"type":"object"},"pbrExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"pbrIfConfigVersion":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"pbrMetadata":{"description":"Replaces the bucket's whole metadata value; it is not merged into what is stored. A key this object leaves out is removed, so to change one key use PATCH /buckets/:id/metadata, which merges a JSON Merge Patch (RFC 7396) atomically; reading, editing and sending the whole object back here is not atomic (of two concurrent writers, the last one wins). Absent or null leaves metadata unchanged; {} empties it. Capped at 5KB of JSON."},"pbrOverageLimits":{"additionalProperties":{"type":"number"},"type":"object"},"pbrRemoveDimensions":{"items":{"type":"string"},"type":"array"},"pbrReservationPolicy":{"$ref":"#/components/schemas/ReservationPolicy"},"pbrResourceLimits":{"additionalProperties":{"type":"number"},"type":"object"},"pbrStatus":{"$ref":"#/components/schemas/BucketStatus"},"pbrStatusReason":{"type":"string"}},"type":"object"},"PendingClaimReservation":{"properties":{"pcrAutoReserve":{"type":"boolean"},"pcrBlockedBy":{"$ref":"#/components/schemas/UUID"},"pcrCreatedAt":{"$ref":"#/components/schemas/UTCTime"},"pcrExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"pcrGrantedAt":{"$ref":"#/components/schemas/UTCTime"},"pcrId":{"$ref":"#/components/schemas/UUID"},"pcrIntentsAhead":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"pcrLastAttemptAt":{"$ref":"#/components/schemas/UTCTime"},"pcrMetadata":{"$ref":"#/components/schemas/AnyJson"},"pcrPriority":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"pcrQueueDiscipline":{"$ref":"#/components/schemas/ClaimQueueDiscipline"},"pcrQueuePosition":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"pcrShortfalls":{"items":{"$ref":"#/components/schemas/ClaimBucketShortfall"},"type":"array"},"pcrStatus":{"type":"string"},"pcrStrategy":{"$ref":"#/components/schemas/ClaimStrategy"},"pcrTargets":{"items":{"$ref":"#/components/schemas/ClaimTarget"},"type":"array"},"pcrValue":{"additionalProperties":{"type":"number"},"type":"object"},"pcrWaitReason":{"type":"string"}},"required":["pcrId","pcrTargets","pcrStrategy","pcrAutoReserve","pcrPriority","pcrQueueDiscipline","pcrCreatedAt","pcrExpiresAt","pcrStatus"],"type":"object"},"PendingConsume":{"properties":{"pcAmounts":{"additionalProperties":{"type":"number"},"type":"object"},"pcAutoConsume":{"type":"boolean"},"pcBucketId":{"$ref":"#/components/schemas/BucketId"},"pcCreatedAt":{"$ref":"#/components/schemas/UTCTime"},"pcExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"pcId":{"$ref":"#/components/schemas/UUID"},"pcStatus":{"type":"string"}},"required":["pcId","pcBucketId","pcAmounts","pcAutoConsume","pcCreatedAt","pcExpiresAt","pcStatus"],"type":"object"},"PendingReserve":{"properties":{"prAmounts":{"additionalProperties":{"type":"number"},"type":"object"},"prAutoReserve":{"type":"boolean"},"prBucketId":{"$ref":"#/components/schemas/BucketId"},"prCreatedAt":{"$ref":"#/components/schemas/UTCTime"},"prExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"prId":{"$ref":"#/components/schemas/UUID"},"prMetadata":{"$ref":"#/components/schemas/AnyJson"},"prStatus":{"type":"string"}},"required":["prId","prBucketId","prAmounts","prAutoReserve","prCreatedAt","prExpiresAt","prStatus"],"type":"object"},"PendingTransfer":{"properties":{"ptAmounts":{"additionalProperties":{"type":"number"},"type":"object"},"ptAuto":{"type":"boolean"},"ptClass":{"type":"string"},"ptCreatedAt":{"$ref":"#/components/schemas/UTCTime"},"ptExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"ptFromBucketId":{"$ref":"#/components/schemas/BucketId"},"ptId":{"$ref":"#/components/schemas/UUID"},"ptMetadata":{"$ref":"#/components/schemas/AnyJson"},"ptStatus":{"type":"string"},"ptToBucketId":{"$ref":"#/components/schemas/BucketId"},"ptTransactionId":{"type":"string"}},"required":["ptId","ptFromBucketId","ptToBucketId","ptAmounts","ptAuto","ptCreatedAt","ptExpiresAt","ptStatus"],"type":"object"},"PeriodView":{"properties":{"pvDimensions":{"additionalProperties":{"$ref":"#/components/schemas/DimensionPeriod"},"type":"object"},"pvDoses":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"pvKind":{"type":"string"},"pvOpen":{"type":"boolean"},"pvPartial":{"type":"boolean"},"pvPeriodEnd":{"$ref":"#/components/schemas/UTCTime"},"pvPeriodStart":{"$ref":"#/components/schemas/UTCTime"}},"required":["pvPeriodStart","pvOpen","pvKind","pvPartial","pvDimensions"],"type":"object"},"PeriodsResp":{"properties":{"plAccuracy":{"additionalProperties":{"type":"string"},"type":"object"},"plBucketId":{"$ref":"#/components/schemas/BucketId"},"plNextBefore":{"$ref":"#/components/schemas/UTCTime"},"plPeriods":{"items":{"$ref":"#/components/schemas/PeriodView"},"type":"array"},"plSubtree":{"type":"boolean"},"plSubtreeBuckets":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"required":["plBucketId","plPeriods","plAccuracy","plSubtree"],"type":"object"},"PickPolicy":{"enum":["PickInOrder","PickMostAvailable","PickRoundRobin"],"type":"string"},"PlaceBidReq":{"description":"A bid (POST /buckets/{id}/auction/bids, ScopeBid). units: how many units in all; minUnits: the smallest fill accepted in one round (0, the default, takes any; units is all-or-nothing); price: per unit, in the auction's priceUnit. Expires at expiresAt or after expiresInSeconds, at most and by default 24 hours after placement. On a bucket auction: units is 1 or absent (minUnits 0, 1 or absent), price is for the bucket, and the bid stands by default and at most until closesAt. payerBucketId: required on a funded auction (ScopeBid alone holds the escrow there, no ScopeConsume needed; the bid's whole worth, price x units, is held there, 409 escrow_shortfall when it cannot be), refused on an unfunded one (400 unfunded_auction). callbackUrl (with callbackSecret, callbackMetadata): a one-shot callback under the callback allowlist and a destination claim, as an Async request's acCallbackUrl, for bid.won, bid.outbid, bid.cancelled and bid.expired.","properties":{"callbackMetadata":{},"callbackSecret":{"type":"string"},"callbackUrl":{"type":"string"},"expiresAt":{"format":"date-time","type":"string"},"expiresInSeconds":{"type":"integer"},"metadata":{},"minUnits":{"type":"integer"},"payerBucketId":{"format":"uuid","type":"string"},"price":{"type":"number"},"units":{"type":"integer"}},"required":["price"],"type":"object"},"PollAuth":{"properties":{"secret":{"type":"string"}},"required":["secret"],"type":"object"},"PollMapping":{"properties":{"pmPointer":{"type":"string"},"pmScale":{"type":"number"}},"required":["pmPointer"],"type":"object"},"PollMode":{"enum":["PollBump","PollSet"],"type":"string"},"PollSource":{"properties":{"psAuth":{"$ref":"#/components/schemas/PollAuth"},"psMapping":{"additionalProperties":{"$ref":"#/components/schemas/PollMapping"},"type":"object"},"psMode":{"$ref":"#/components/schemas/PollMode"},"psTimeoutMs":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"psUrl":{"type":"string"}},"required":["psUrl","psMapping","psMode"],"type":"object"},"PollState":{"properties":{"pollConsecutiveFailures":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"pollLastOutcome":{"type":"string"},"pollLastPolledAt":{"$ref":"#/components/schemas/UTCTime"},"pollLastValue":{"additionalProperties":{"type":"number"},"type":"object"}},"required":["pollConsecutiveFailures"],"type":"object"},"PutSecretReq":{"properties":{"psrValue":{"type":"string"}},"required":["psrValue"],"type":"object"},"RecencyBand":{"properties":{"rbCount":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"rbWithinHours":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"required":["rbWithinHours","rbCount"],"type":"object"},"ReclaimMode":{"enum":["ReclaimUnusedOnly","ReclaimAll"],"type":"string"},"ReclaimRequest":{"properties":{"rrCascade":{"type":"boolean"},"rrMode":{"$ref":"#/components/schemas/ReclaimMode"},"rrReason":{"type":"string"}},"required":["rrMode","rrCascade"],"type":"object"},"ReclaimResp":{"properties":{"rrDescendantsReclaimed":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"rrParentId":{"$ref":"#/components/schemas/BucketId"},"rrReclaimed":{"additionalProperties":{"type":"number"},"type":"object"},"rrReservationsVoided":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"required":["rrReclaimed","rrDescendantsReclaimed","rrReservationsVoided"],"type":"object"},"RefreshReservationReq":{"properties":{"rfrExpiresAt":{"$ref":"#/components/schemas/UTCTime"}},"type":"object"},"ReleaseReservationReq":{"properties":{"rlrMetadata":{"$ref":"#/components/schemas/AnyJson"},"rlrOutcome":{"type":"string"}},"type":"object"},"ReplenishConfig":{"properties":{"rcAmounts":{"additionalProperties":{"type":"number"},"type":"object"},"rcCarryover":{"$ref":"#/components/schemas/CarryoverPolicy"},"rcCarryoverMax":{"additionalProperties":{"type":"number"},"type":"object"},"rcEnvelope":{"$ref":"#/components/schemas/TreeEnvelope"},"rcOverflow":{"$ref":"#/components/schemas/OverflowAction"},"rcResetDimensions":{"description":"Dimensions that start from zero at every scheduled run (its catch-up of missed doses included), whatever rcCarryover says (a CarryoverNone for those dimensions only). A listed dimension the run's dose does not name is set to 0; one it names is set to its dose. A manual top-up (POST /buckets/:id/replenish) resets none of them. Made for a Reporting meter cleared each period. Absent or null is []. PUT refuses a dimension the bucket does not have (unknown_dimension) and one a PollSet source maps (reset_dimension_polled_set).","items":{"type":"string"},"type":"array"},"rcSchedule":{"$ref":"#/components/schemas/ReplenishSchedule"},"rcSource":{"$ref":"#/components/schemas/ReplenishSource"}},"required":["rcAmounts","rcCarryover","rcOverflow","rcSource"],"type":"object"},"ReplenishConfigView":{"properties":{"rcvConfig":{"$ref":"#/components/schemas/ReplenishConfig"},"rcvPollState":{"$ref":"#/components/schemas/PollState"},"rcvSchedule":{"$ref":"#/components/schemas/ScheduleView"}},"type":"object"},"ReplenishRecord":{"properties":{"rlAmountsAdded":{"additionalProperties":{"type":"number"},"type":"object"},"rlAmountsDiscarded":{"additionalProperties":{"additionalProperties":{"type":"number"},"type":"object"},"type":"object"},"rlAmountsWithheld":{"additionalProperties":{"type":"number"},"type":"object"},"rlOccurredAt":{"$ref":"#/components/schemas/UTCTime"},"rlPeriodEnd":{"$ref":"#/components/schemas/UTCTime"},"rlPeriodStart":{"$ref":"#/components/schemas/UTCTime"},"rlSource":{"type":"string"},"rlTransactionId":{"type":"string"}},"required":["rlSource","rlAmountsAdded","rlOccurredAt"],"type":"object"},"ReplenishReq":{"properties":{"repAmounts":{"additionalProperties":{"type":"number"},"type":"object"},"repMetadata":{"$ref":"#/components/schemas/AnyJson"},"repSource":{"type":"string"},"repTransactionId":{"type":"string"}},"required":["repAmounts","repSource"],"type":"object"},"ReplenishResp":{"properties":{"repAdded":{"additionalProperties":{"type":"number"},"type":"object"},"repDiscarded":{"additionalProperties":{"additionalProperties":{"type":"number"},"type":"object"},"description":"What this replenishment discarded: cause, then dimension, then amount, e.g. {\"carryover\": {\"tokens\": 40}}. Causes are carryover (balance the carry-over rule removed) and overflow (the part of the dose turned away at the maximum); ignore causes you do not know. {} when nothing was discarded. A replenishment that discards more than zero, from this route or from the schedule, also fires one bucket.replenish_discarded webhook whose details are source, discarded (this shape), credited, balance (after the run, for the dimensions named), doses (a catch-up only) and metadata.","type":"object"},"repForgiven":{"additionalProperties":{"type":"number"},"description":"The MeteredOverage debt this replenishment wrote off, per dimension: the amount that was below zero when a carry-over-none reset started the balance again from the dose. {} when nothing was forgiven, and on a replayed repTransactionId. The same figure as forgiven on the bucket.replenished audit-log row; it is in no repDiscarded cause.","type":"object"},"repNewBalance":{"additionalProperties":{"$ref":"#/components/schemas/ResourceAmount"},"type":"object"}},"required":["repAdded","repNewBalance","repDiscarded","repForgiven"],"type":"object"},"ReplenishSchedule":{"description":"When a periodic replenishment fires. tag selects the form. Legacy: {\"tag\":\"IntervalSecs\",\"contents\":300} (free-running, counted from each run) and {\"tag\":\"DailyAtUTC\",\"contents\":[9,30]}. Every: {\"tag\":\"Every\",\"count\":6,\"unit\":\"hours\",\"anchor\":\"2026-10-12T00:00:00Z\"} (unit: seconds, minutes, hours, days, weeks; anchor RFC 3339, kept as written; the step may not be shorter than 30 seconds). Daily: {\"tag\":\"Daily\",\"at\":\"09:00\",\"zone\":\"Europe/Paris\"}. Weekly: {\"tag\":\"Weekly\",\"weekday\":\"monday\",\"at\":\"09:00\",\"zone\":\"UTC\"}. Monthly: {\"tag\":\"Monthly\",\"day\":1,\"at\":\"00:00\",\"zone\":\"UTC\"} (day 1 to 31, clamped to the month's last day, or \"last\"). at is HH:MM; zone is UTC or an IANA name. Unknown fields are refused.","properties":{"anchor":{"format":"date-time","type":"string"},"at":{"pattern":"^[0-2][0-9]:[0-5][0-9]$","type":"string"},"contents":{},"count":{"minimum":1,"type":"integer"},"day":{},"tag":{"enum":["IntervalSecs","DailyAtUTC","Every","Daily","Weekly","Monthly"],"type":"string"},"unit":{"enum":["seconds","minutes","hours","days","weeks"],"type":"string"},"weekday":{"type":"string"},"zone":{"type":"string"}},"required":["tag"],"type":"object"},"ReplenishSource":{"oneOf":[{"properties":{"tag":{"enum":["FixedAmounts"],"type":"string"}},"required":["tag"],"title":"FixedAmounts","type":"object"},{"properties":{"contents":{"$ref":"#/components/schemas/PollSource"},"tag":{"enum":["PollEndpoint"],"type":"string"}},"required":["tag","contents"],"title":"PollEndpoint","type":"object"}]},"Reservation":{"properties":{"rvAmounts":{"additionalProperties":{"type":"number"},"type":"object"},"rvApiKeyId":{"$ref":"#/components/schemas/UUID"},"rvBucketId":{"$ref":"#/components/schemas/BucketId"},"rvCreatedAt":{"$ref":"#/components/schemas/UTCTime"},"rvExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"rvId":{"$ref":"#/components/schemas/UUID"},"rvMetadata":{"$ref":"#/components/schemas/AnyJson"},"rvOutcome":{"type":"string"},"rvSettlementMetadata":{"$ref":"#/components/schemas/AnyJson"},"rvStatus":{"type":"string"},"rvTransactionId":{"type":"string"}},"required":["rvId","rvBucketId","rvAmounts","rvCreatedAt","rvStatus"],"type":"object"},"ReservationPolicy":{"description":"A bucket's reservation policy, so forgotten holds free themselves. default_ttl_seconds: a hold taken (or refreshed) with no expiresAt expires this long after. max_ttl_seconds: no hold is given an expiry further than this from when it is taken or refreshed; a later one asked for is clamped, and a hold with no expiry and no default gets exactly it. Either may be null or absent; {} is no policy (a hold with no expiry never expires).","properties":{"default_ttl_seconds":{"maximum":31622400,"minimum":1,"type":"integer"},"max_ttl_seconds":{"maximum":31622400,"minimum":1,"type":"integer"}},"type":"object"},"ReserveOutcome":{"oneOf":[{"properties":{"rsCommitToken":{"type":"string"},"rsReservation":{"$ref":"#/components/schemas/Reservation"},"tag":{"enum":["ReserveSuccess"],"type":"string"}},"required":["rsReservation","tag"],"title":"ReserveSuccess","type":"object"},{"properties":{"roAvailable":{"additionalProperties":{"type":"number"},"type":"object"},"roProtection":{"$ref":"#/components/schemas/ConsumeProtection"},"roShortfall":{"additionalProperties":{"type":"number"},"type":"object"},"tag":{"enum":["ReserveShortfall"],"type":"string"}},"required":["roShortfall","roAvailable","tag"],"title":"ReserveShortfall","type":"object"},{"properties":{"roAutoReserve":{"type":"boolean"},"roAvailable":{"additionalProperties":{"type":"number"},"type":"object"},"roExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"roPendingId":{"$ref":"#/components/schemas/UUID"},"roShortfall":{"additionalProperties":{"type":"number"},"type":"object"},"tag":{"enum":["ReservePending"],"type":"string"}},"required":["roPendingId","roShortfall","roAvailable","roAutoReserve","roExpiresAt","tag"],"title":"ReservePending","type":"object"}]},"ReserveReq":{"properties":{"rrvAmounts":{"additionalProperties":{"type":"number"},"type":"object"},"rrvClass":{"type":"string"},"rrvExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"rrvMetadata":{"description":"Caller metadata for the hold, what it is for: any JSON, at most 1 KiB encoded, the same field as a consume's crMetadata. Stored on the hold (rvMetadata) and on its pending row under Async, and written as metadata on bucket.reserved, bucket.reserve_pending, bucket.reserve_shortfall, bucket.reserve_expired, bucket.reservation_expired and bucket.reservation_cancelled, and as reservation_metadata on the bucket.consumed of its commit. Recorded, never acted on."},"rrvMode":{"$ref":"#/components/schemas/ConsumeMode"},"rrvNonce":{"type":"string"},"rrvTransactionId":{"type":"string"}},"required":["rrvAmounts","rrvMode"],"type":"object"},"ResourceAmount":{"properties":{"raAvailable":{"description":"Derived on every read, never stored and ignored on a request: raCurrent - raReserved, what is free once open holds are kept aside. Not clamped: a Reporting or MeteredOverage dimension below zero reads below zero. A consume class floor is not subtracted; /check says what one request may take.","readOnly":true,"type":"number"},"raCurrent":{"type":"number"},"raMaximum":{"type":"number"},"raMode":{"$ref":"#/components/schemas/ResourceMode"},"raOverageLimit":{"type":"number"},"raReserved":{"type":"number"},"raUnit":{"type":"string"}},"required":["raCurrent","raReserved","raUnit","raMode"],"type":"object"},"ResourceMode":{"enum":["Locking","Reporting","MeteredOverage"],"type":"string"},"RoundLineView":{"description":"One bid's line in a round. unitsAsked: what it still wanted; pricePaid: per unit, null when nothing was awarded. outcome: won, partial, outbid, below_reserve, min_fill_unmet, bucket_limit, payer_unavailable (a funded bid whose payer bucket cannot pay this round).","properties":{"awardBucketId":{"format":"uuid","type":"string"},"bidId":{"format":"uuid","type":"string"},"bidder":{"format":"uuid","type":"string"},"outcome":{"enum":["won","partial","outbid","below_reserve","min_fill_unmet","bucket_limit","payer_unavailable"],"type":"string"},"price":{"type":"number"},"pricePaid":{"type":"number"},"unitsAsked":{"type":"integer"},"unitsAwarded":{"type":"integer"}},"required":["bidId","bidder","price","unitsAsked","unitsAwarded","outcome"],"type":"object"},"RoundView":{"description":"A cleared round: the lot offered, the units allocated, the clearing price (the lowest winning price), and one line per bid that stood. A participant sees its own lines and no proceeds.","properties":{"allocated":{"type":"integer"},"auctionId":{"format":"uuid","type":"string"},"bidCount":{"type":"integer"},"bucketId":{"format":"uuid","type":"string"},"clearedAt":{"format":"date-time","type":"string"},"clearingPrice":{"type":"number"},"id":{"format":"uuid","type":"string"},"lines":{"items":{"$ref":"#/components/schemas/RoundLineView"},"type":"array"},"lot":{"type":"integer"},"pricing":{"enum":["uniform","pay_as_bid"],"type":"string"},"proceeds":{"type":"number"},"seq":{"type":"integer"}},"required":["id","auctionId","bucketId","seq","clearedAt","lot","allocated","pricing","bidCount","lines"],"type":"object"},"ScheduleView":{"description":"The schedule in words, its next run and the period it is in, computed by core. period is null for the free-running IntervalSecs and before the first occurrence of an Every whose anchor is ahead.","properties":{"nextRunAt":{"format":"date-time","type":"string"},"period":{"nullable":true,"properties":{"end":{"format":"date-time","type":"string"},"start":{"format":"date-time","type":"string"}},"type":"object"},"text":{"type":"string"}},"required":["text","nextRunAt"],"type":"object"},"Scope":{"enum":["ScopeRead","ScopeConsume","ScopeRefill","ScopeAdmin","ScopeBid"],"type":"string"},"SecretInfo":{"properties":{"siCreatedAt":{"$ref":"#/components/schemas/UTCTime"},"siName":{"type":"string"}},"required":["siName","siCreatedAt"],"type":"object"},"SeriesPoint":{"description":"One point of GET /buckets/period-series: credited and consumed on one UTC calendar bucket (spStart) for one dimension. Without group, summed over the matched buckets, and spBucketId and spClasses are absent. With group=bucket, the OWN figures of the bucket spBucketId, and spClasses is the part of spConsumed made as each consume class (non-zero only; the rest had no class; credited has no class). With group=metadata:<key>, summed over the matched buckets whose value of the key is spGroup, and spGroupKind is value, none (no such key) or other (the values past the 20 kept); spGroup and spGroupKind are absent otherwise.","properties":{"spBucketId":{"$ref":"#/components/schemas/BucketId"},"spClasses":{"additionalProperties":{"type":"number"},"type":"object"},"spConsumed":{"type":"number"},"spCredited":{"type":"number"},"spDimension":{"type":"string"},"spGroup":{"type":"string"},"spGroupKind":{"type":"string"},"spStart":{"$ref":"#/components/schemas/UTCTime"}},"required":["spStart","spDimension","spCredited","spConsumed"],"type":"object"},"SeriesResp":{"description":"GET /buckets/period-series. Without group: points summed over the matched buckets, oldest first; limit defaults to 1000 (max 5000). With group=bucket: one series per bucket, oldest first then by bucket and dimension; srGroup is \"bucket\" and srBucketCount the buckets matched (subtree included), both absent without group; more than 500 matched buckets is a 400 too_many_buckets; limit defaults to and is capped at 20000. With group=metadata:<key>: one series per value of the key (20 values, plus none and other); srGroup is \"metadata\", srGroupKey the key and srGroupValues the distinct values seen; limit as for group=bucket. In all, srTruncated says the oldest points were cut. Answered from the reporting connection, which may lag the latest writes.","properties":{"srAttribution":{"type":"string"},"srBucketCount":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"srBucketIds":{"items":{"$ref":"#/components/schemas/BucketId"},"type":"array"},"srDimension":{"type":"string"},"srGranularity":{"type":"string"},"srGroup":{"type":"string"},"srGroupKey":{"type":"string"},"srGroupValues":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"srIncludesOpen":{"type":"boolean"},"srLimit":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"srPoints":{"items":{"$ref":"#/components/schemas/SeriesPoint"},"type":"array"},"srSince":{"$ref":"#/components/schemas/UTCTime"},"srSubtree":{"type":"boolean"},"srTruncated":{"type":"boolean"},"srUntil":{"$ref":"#/components/schemas/UTCTime"},"srWindowDays":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"srWindowLimitedBy":{"type":"string"}},"required":["srPoints","srTruncated","srGranularity","srLimit","srSubtree","srBucketIds","srWindowDays","srWindowLimitedBy","srSince","srUntil","srIncludesOpen","srAttribution"],"type":"object"},"SetApiKeyExpiryReq":{"properties":{"sakeExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"sakeExpiresInMinutes":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"type":"object"},"SetBucketDeletionPolicyReq":{"properties":{"sbdpConfirmImmediateDeletions":{"type":"boolean"},"sbdpPolicy":{"$ref":"#/components/schemas/BucketDeletionPolicy"}},"required":["sbdpPolicy","sbdpConfirmImmediateDeletions"],"type":"object"},"SetTenantMetadataReq":{"properties":{"stmMetadata":{"$ref":"#/components/schemas/AnyJson"}},"required":["stmMetadata"],"type":"object"},"ShortfallEta":{"properties":{"seDimensions":{"additionalProperties":{"$ref":"#/components/schemas/EtaAnswer"},"type":"object"},"seOverall":{"$ref":"#/components/schemas/EtaAnswer"}},"required":["seOverall","seDimensions"],"type":"object"},"ShortfallRankingResp":{"properties":{"sfkBucketsWithShortfall":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"sfkLimit":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"sfkRows":{"items":{"$ref":"#/components/schemas/ShortfallRankingRow"},"type":"array"}},"required":["sfkLimit","sfkBucketsWithShortfall","sfkRows"],"type":"object"},"ShortfallRankingRow":{"properties":{"srrBucket":{"$ref":"#/components/schemas/UUID"},"srrClaim":{"type":"number"},"srrConsume":{"type":"number"},"srrConsumeUnkeyed":{"type":"number"},"srrDimension":{"type":"string"},"srrReserve":{"type":"number"},"srrTransfer":{"type":"number"}},"required":["srrBucket","srrDimension","srrConsume","srrConsumeUnkeyed","srrReserve","srrClaim","srrTransfer"],"type":"object"},"SplitLimitMode":{"enum":["CapAtAllocation","InheritParentMax"],"type":"string"},"SplitRequest":{"properties":{"srAllocation":{"additionalProperties":{"type":"number"},"type":"object"},"srChildLimitMode":{"$ref":"#/components/schemas/SplitLimitMode"},"srExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"srIdempotencyKey":{"type":"string"},"srMetadata":{"$ref":"#/components/schemas/AnyJson"},"srShrinkParentMax":{"type":"boolean"}},"required":["srAllocation"],"type":"object"},"SplitResp":{"properties":{"srChildId":{"$ref":"#/components/schemas/BucketId"},"srParentRemaining":{"additionalProperties":{"$ref":"#/components/schemas/ResourceAmount"},"type":"object"}},"required":["srChildId","srParentRemaining"],"type":"object"},"SuggestionResp":{"description":"Suggested protection floors with a replay. bucket_id; order (classes, highest utility first); coverage_percent; periods_requested; periods_skipped (partial or first periods left out); dimensions: per dimension {periods_used, classes: [{class, rank, suggested ({floor, release}) or null for the top class, current, higher_class_demand_per_period {min, median, at_coverage, max}, warnings, replay {demand, actual_consumed, actual_shortfall, consumed_without, shortfall_without, consumed_with, shortfall_with, refused_by_floor, shortfall_avoided}}], unclassed, periods (the same replay per period, newest first)}; proposed_class_config (the bucket's declaration with the suggested floors in, in the body PUT /buckets/:id/class-config takes); assumptions (read them).","type":"object"},"TenantInfo":{"properties":{"tiCreatedAt":{"$ref":"#/components/schemas/UTCTime"},"tiId":{"$ref":"#/components/schemas/UUID"},"tiKeyBucketId":{"$ref":"#/components/schemas/BucketId"},"tiKeyBucketIds":{"items":{"$ref":"#/components/schemas/BucketId"},"type":"array"},"tiKeyScopes":{"items":{"$ref":"#/components/schemas/Scope"},"type":"array"},"tiName":{"type":"string"}},"required":["tiId","tiName","tiCreatedAt","tiKeyScopes","tiKeyBucketIds"],"type":"object"},"TenantMetadataResp":{"properties":{"tmMetadata":{"$ref":"#/components/schemas/AnyJson"}},"required":["tmMetadata"],"type":"object"},"TenantMetricsSecretResp":{"properties":{"tmsrSecret":{"type":"string"}},"required":["tmsrSecret"],"type":"object"},"TenantMetricsSecretStatus":{"properties":{"tmssConfigured":{"type":"boolean"},"tmssSetAt":{"$ref":"#/components/schemas/UTCTime"}},"required":["tmssConfigured"],"type":"object"},"TenantProofKey":{"properties":{"tpkAlgorithm":{"type":"string"},"tpkPublicKey":{"type":"string"},"tpkTenantId":{"$ref":"#/components/schemas/UUID"}},"required":["tpkTenantId","tpkPublicKey","tpkAlgorithm"],"type":"object"},"TenantUsage":{"properties":{"tuBucketCount":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tuBucketLimit":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tuCommitTokenRateLimitBurst":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tuCommitTokenRateLimitRpm":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tuHistoryDeletedThrough":{"$ref":"#/components/schemas/UTCTime"},"tuHistoryRetainedRows":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tuHistoryRetentionDays":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tuHistoryRowsDeleted":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tuHistoryRowsPerDay":{"format":"double","type":"number"},"tuLastKeyUsedAgeSeconds":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tuLastKeyUsedAt":{"$ref":"#/components/schemas/UTCTime"},"tuMetricsEnabled":{"type":"boolean"},"tuPendingClaimsCount":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tuPendingClaimsLimit":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tuRateLimitBurst":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tuRateLimitRpm":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tuWebhookCount":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tuWebhookLimit":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"required":["tuBucketCount","tuWebhookCount","tuPendingClaimsCount","tuHistoryRowsDeleted","tuHistoryRowsPerDay","tuMetricsEnabled"],"type":"object"},"ThresholdLevel":{"oneOf":[{"properties":{"contents":{"type":"number"},"tag":{"enum":["AbsoluteThreshold"],"type":"string"}},"required":["tag","contents"],"title":"AbsoluteThreshold","type":"object"},{"properties":{"contents":{"type":"number"},"tag":{"enum":["PercentThreshold"],"type":"string"}},"required":["tag","contents"],"title":"PercentThreshold","type":"object"}]},"ThresholdSpec":{"properties":{"tsCritical":{"$ref":"#/components/schemas/ThresholdLevel"},"tsWarning":{"$ref":"#/components/schemas/ThresholdLevel"}},"type":"object"},"TopupCap":{"properties":{"tcpAmounts":{"additionalProperties":{"type":"number"},"type":"object"},"tcpPeriodSeconds":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"required":["tcpAmounts","tcpPeriodSeconds"],"type":"object"},"TopupConfig":{"properties":{"tuCap":{"$ref":"#/components/schemas/TopupCap"},"tuClass":{"type":"string"},"tuDose":{"additionalProperties":{"type":"number"},"type":"object"},"tuSource":{"$ref":"#/components/schemas/BucketId"},"tuTrigger":{"additionalProperties":{"$ref":"#/components/schemas/ThresholdLevel"},"type":"object"}},"required":["tuSource","tuTrigger","tuDose"],"type":"object"},"TopupConfigView":{"properties":{"tcvConfig":{"$ref":"#/components/schemas/TopupConfig"},"tcvState":{"$ref":"#/components/schemas/TopupState"}},"required":["tcvConfig","tcvState"],"type":"object"},"TopupState":{"properties":{"tusLastTopupAt":{"$ref":"#/components/schemas/UTCTime"},"tusMovedInPeriod":{"additionalProperties":{"type":"number"},"type":"object"},"tusPeriodStartedAt":{"$ref":"#/components/schemas/UTCTime"},"tusShortSince":{"$ref":"#/components/schemas/UTCTime"},"tusTopups":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"required":["tusMovedInPeriod","tusTopups"],"type":"object"},"TransferOutcome":{"oneOf":[{"properties":{"tag":{"enum":["TransferSuccess"],"type":"string"},"toDestinationBalance":{"additionalProperties":{"type":"number"},"type":"object"},"toMoved":{"additionalProperties":{"type":"number"},"type":"object"},"toProtection":{"$ref":"#/components/schemas/ConsumeProtection"},"toReceipt":{"type":"string"},"toSourceRemaining":{"additionalProperties":{"type":"number"},"type":"object"}},"required":["toMoved","toSourceRemaining","toDestinationBalance","tag"],"title":"TransferSuccess","type":"object"},{"properties":{"tag":{"enum":["TransferShortfall"],"type":"string"},"toAvailable":{"additionalProperties":{"type":"number"},"type":"object"},"toDestinationRoom":{"additionalProperties":{"type":"number"},"type":"object"},"toEta":{"$ref":"#/components/schemas/ShortfallEta"},"toProtection":{"$ref":"#/components/schemas/ConsumeProtection"},"toShortfall":{"additionalProperties":{"type":"number"},"type":"object"}},"required":["toShortfall","toDestinationRoom","toAvailable","toEta","tag"],"title":"TransferShortfall","type":"object"},{"properties":{"tag":{"enum":["TransferPending"],"type":"string"},"toAuto":{"type":"boolean"},"toAvailable":{"additionalProperties":{"type":"number"},"type":"object"},"toDestinationRoom":{"additionalProperties":{"type":"number"},"type":"object"},"toEta":{"$ref":"#/components/schemas/ShortfallEta"},"toExpiresAt":{"$ref":"#/components/schemas/UTCTime"},"toPendingId":{"$ref":"#/components/schemas/UUID"},"toShortfall":{"additionalProperties":{"type":"number"},"type":"object"}},"required":["toPendingId","toShortfall","toDestinationRoom","toAvailable","toEta","toAuto","toExpiresAt","tag"],"title":"TransferPending","type":"object"}]},"TransferRequest":{"properties":{"trAmounts":{"additionalProperties":{"type":"number"},"type":"object"},"trClass":{"type":"string"},"trFrom":{"$ref":"#/components/schemas/BucketId"},"trMetadata":{"$ref":"#/components/schemas/AnyJson"},"trMode":{"$ref":"#/components/schemas/ConsumeMode"},"trNonce":{"type":"string"},"trTo":{"$ref":"#/components/schemas/BucketId"},"trTransactionId":{"type":"string"}},"required":["trFrom","trTo","trAmounts","trMode"],"type":"object"},"TreeEnvelope":{"properties":{"teScope":{"$ref":"#/components/schemas/EnvelopeScope"}},"required":["teScope"],"type":"object"},"TreeIndexEntry":{"description":"One bucket of GET /buckets/tree-index. tieAncestors: the bucket's ancestors, the root first and the parent last; for a bucket-scoped key only those the key reaches. A bucket is in the subtree of s when tieId == s or s is in tieAncestors. tieDepth: levels below the tenant's top level (0 for a top-level bucket), whatever the key's scope. tieTitle: the buckette/bucket-title metadata when it is a string. tieLabels: the strings of buckette/labels. tieResources: the live balances (raCurrent, raMaximum, raReserved per dimension) with balances=true, else null.","properties":{"tieAncestors":{"items":{"$ref":"#/components/schemas/BucketId"},"type":"array"},"tieDepth":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tieId":{"$ref":"#/components/schemas/BucketId"},"tieLabels":{"items":{"type":"string"},"type":"array"},"tieMetadata":{"$ref":"#/components/schemas/AnyJson"},"tieParentId":{"$ref":"#/components/schemas/BucketId"},"tieResources":{"additionalProperties":{"$ref":"#/components/schemas/ResourceAmount"},"type":"object"},"tieTitle":{"type":"string"}},"required":["tieId","tieAncestors","tieDepth","tieLabels","tieMetadata"],"type":"object"},"TreeIndexResp":{"description":"GET /buckets/tree-index: every live bucket the key reaches (scope_root: that bucket and its descendants only), shallowest first and then by creation, so a parent precedes its children. At most tiLimit (5000) buckets; tiTruncated says more matched, and the deepest buckets are the ones left out. Answered from the reporting connection, which may lag the latest writes.","properties":{"tiBalances":{"type":"boolean"},"tiBuckets":{"items":{"$ref":"#/components/schemas/TreeIndexEntry"},"type":"array"},"tiLimit":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"tiScopeRoot":{"$ref":"#/components/schemas/BucketId"},"tiTruncated":{"type":"boolean"}},"required":["tiBuckets","tiTruncated","tiLimit","tiBalances"],"type":"object"},"UTCTime":{"example":"2016-07-22T00:00:00Z","format":"yyyy-mm-ddThh:MM:ssZ","type":"string"},"UUID":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"UnspentWarningConfig":{"description":"A bucket's pre-reset warning: once the next scheduled replenishment is no further away than lead_seconds, one bucket.unspent_expiring webhook says what that run would discard (carry-over forfeit and overflow excess) if nothing changed. One per run, and only when something would be discarded.","properties":{"lead_seconds":{"maximum":31622400,"minimum":1,"type":"integer"}},"required":["lead_seconds"],"type":"object"},"WaitConfig":{"properties":{"wcMaxDelaySecs":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"required":["wcMaxDelaySecs"],"type":"object"},"WebhookDelivery":{"description":"The body of every webhook and callback delivery. Ignore keys you do not know: new ones can be added. details is per event (GET /help/events); where it is an API response type it uses that type's schema in this document, with its tag discriminator.","properties":{"bucket_id":{"description":"One bucket, always. Claim events carry the claim's first target (claim reservations: the first grant's bucket); the full set is in details.","format":"uuid","type":"string"},"bucket_metadata":{"description":"The bucket's own metadata, when it has any (any JSON value)."},"callback_metadata":{"description":"Callback deliveries only: acCallbackMetadata, when set on the request."},"details":{"description":"Per event; GET /help/events lists the fields of each. Dimension-keyed maps are {\"<dimension>\": <number>}.","type":"object"},"event":{"description":"The event name. New names can be added, so a receiver ignores one it does not know. Today: bucket.created, bucket.consumed, bucket.consume_shortfall, bucket.reserve_shortfall, bucket.claim_shortfall, bucket.transfer_shortfall, bucket.transferred, bucket.split, bucket.reclaimed, bucket.deleted, bucket.decommissioned, bucket.archived, bucket.frozen, bucket.unfrozen, bucket.replenished, bucket.replenish_discarded, bucket.poll_failed, bucket.low_balance, bucket.critical_balance, bucket.depleted, bucket.overflow, bucket.overage, bucket.overage_cleared, bucket.balance_recovered, bucket.unspent_expiring, bucket.depletion_projected, bucket.reserved, bucket.reservation_grown, bucket.reservation_committed, bucket.reservation_cancelled, bucket.reservation_released, bucket.reservation_expired, bucket.resources_available, bucket.consume_expired, bucket.reserve_expired, bucket.transfer_expired, claim.granted, claim.resources_available, claim.expired, claim.reserved, claim.reservation_available, claim.reservation_expired, auction.round_cleared, bid.placed, bid.changed, bid.cancelled, bid.expired, bid.won, bid.outbid.","example":"bucket.low_balance","type":"string"},"tenant_id":{"description":"The tenant the event belongs to.","format":"uuid","type":"string"},"timestamp":{"description":"When the delivery was composed, not when an earlier cause happened. A retry carries the first attempt's body unchanged.","format":"date-time","type":"string"},"webhook_metadata":{"description":"Webhook deliveries only: cwrMetadata, when set at registration."}},"required":["event","tenant_id","bucket_id","timestamp","details"],"type":"object"},"WebhookDeliveryRecord":{"properties":{"wdrAttempt":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"wdrCreatedAt":{"$ref":"#/components/schemas/UTCTime"},"wdrEvent":{"type":"string"},"wdrHttpStatus":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"wdrLastError":{"type":"string"},"wdrStatus":{"type":"string"}},"required":["wdrAttempt","wdrStatus","wdrCreatedAt"],"type":"object"},"WebhookInfo":{"properties":{"whiCreatedAt":{"$ref":"#/components/schemas/UTCTime"},"whiDestinationStatus":{"type":"string"},"whiEvents":{"items":{"type":"string"},"type":"array"},"whiId":{"$ref":"#/components/schemas/UUID"},"whiIsActive":{"type":"boolean"},"whiMetadata":{"$ref":"#/components/schemas/AnyJson"},"whiUrl":{"type":"string"}},"required":["whiId","whiUrl","whiEvents","whiIsActive","whiCreatedAt","whiDestinationStatus"],"type":"object"},"WebhookTestDelivery":{"description":"The body of the one-off probe POST /webhooks/{id}/test sends. Not the WebhookDelivery envelope. Signed like a delivery when the webhook has a secret.","properties":{"event":{"enum":["webhook.test"],"type":"string"},"sent_at":{"format":"date-time","type":"string"},"webhook_id":{"format":"uuid","type":"string"}},"required":["event","webhook_id","sent_at"],"type":"object"},"WebhookTestResult":{"properties":{"wtrError":{"type":"string"},"wtrSuccess":{"type":"boolean"}},"required":["wtrSuccess"],"type":"object"}},"securitySchemes":{"bearerAuth":{"description":"Bearer API key (Authorization: Bearer <key>)","scheme":"bearer","type":"http"}}},"externalDocs":{"description":"Guide of the account service in front of this instance: sign-up, plans, creating a tenant and a first API key.","url":"https://console-api.buckette.co/docs/llm.md"},"info":{"description":"Resource management API for workflow orchestration. Covers every route a tenant API key can reach. This instance also has an operator surface (tenant provisioning, plan limits, teardown, instance diagnostics) gated on a credential no API key carries; it is documented separately at GET /admin/openapi.json, behind that credential.\n\nProse docs on this instance: GET /docs/llm.md is the guide for agents, GET /help is the index of topics (GET /help/{topic} for one).\n\nAccounts, sign-up, plans and creating a tenant (which is where a first API key comes from) are handled by a separate account service in front of this instance, not by this API. Its own guide for agents: https://console-api.buckette.co/docs/llm.md","title":"Buckette API","version":"0.1.0"},"openapi":"3.0.0","paths":{"/api-keys":{"get":{"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/ApiKeyInfo"},"type":"array"}}},"description":""}},"security":[{"bearerAuth":[]}]},"post":{"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/CreateApiKeyReq"}}},"required":true},"responses":{"201":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/CreateApiKeyResp"}}},"description":""},"400":{"description":"Invalid `body`"}},"security":[{"bearerAuth":[]}]}},"/api-keys/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/api-keys/{id}/expiry":{"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/SetApiKeyExpiryReq"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ApiKeyInfo"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/api-keys/{id}/hard":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/bids":{"get":{"parameters":[{"in":"query","name":"status","required":false,"schema":{"type":"string"}},{"in":"query","name":"bucket_id","required":false,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/BidView"},"type":"array"}}},"description":""},"400":{"description":"Invalid `offset` or `limit` or `bucket_id` or `status`"}},"security":[{"bearerAuth":[]}]}},"/bids/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/BidView"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"patch":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/PatchBidReq"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/BidView"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/bids/{id}/key":{"post":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"201":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/CreateApiKeyResp"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets":{"get":{"parameters":[{"in":"query","name":"parent_id","required":false,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"root_only","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"status","required":false,"schema":{"type":"string"}},{"in":"query","name":"dimension","required":false,"schema":{"type":"string"}},{"in":"query","name":"dim_min","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"dim_max","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"q","required":false,"schema":{"type":"string"}},{"in":"query","name":"label","required":false,"schema":{"type":"string"}},{"in":"query","name":"with_parents","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"with_descendants","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"used_within_hours","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"unused_for_hours","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/Bucket"},"type":"array"}}},"description":"","headers":{"X-Total-Count":{"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}}},"400":{"description":"Invalid `unused_for_hours` or `used_within_hours` or `with_descendants` or `with_parents` or `label` or `q` or `offset` or `limit` or `sort` or `dim_max` or `dim_min` or `dimension` or `status` or `root_only` or `parent_id`"}},"security":[{"bearerAuth":[]}]},"post":{"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/CreateBucketReq"}}},"required":true},"responses":{"201":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/Bucket"}}},"description":""},"400":{"description":"Invalid `body`"}},"security":[{"bearerAuth":[]}]}},"/buckets/claim-value":{"get":{"parameters":[{"in":"query","name":"window_days","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"bucket_id","required":false,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ClaimValueResp"}}},"description":""},"400":{"description":"Invalid `limit` or `bucket_id` or `window_days`"}},"security":[{"bearerAuth":[]}]}},"/buckets/consume-shortfalls":{"get":{"parameters":[{"in":"query","name":"window_days","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/ConsumeShortfallTotal"},"type":"array"}}},"description":""},"400":{"description":"Invalid `window_days`"}},"security":[{"bearerAuth":[]}]}},"/buckets/deletions":{"get":{"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/BucketDeletionStatus"},"type":"array"}}},"description":""}},"security":[{"bearerAuth":[]}]}},"/buckets/export/csv":{"get":{"parameters":[{"in":"query","name":"parent_id","required":false,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"subtree_id","required":false,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"status","required":false,"schema":{"type":"string"}},{"in":"query","name":"dimension","required":false,"schema":{"type":"string"}},{"in":"query","name":"dim_min","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"dim_max","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"in":"query","name":"q","required":false,"schema":{"type":"string"}},{"in":"query","name":"label","required":false,"schema":{"type":"string"}},{"in":"query","name":"periods_window_days","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"used_within_hours","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"unused_for_hours","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"text/csv;charset=utf-8":{"schema":{"type":"string"}}},"description":"","headers":{"Content-Disposition":{"schema":{"type":"string"}},"X-Buckette-Export-Truncated":{"schema":{"type":"string"}}}},"400":{"description":"Invalid `unused_for_hours` or `used_within_hours` or `periods_window_days` or `label` or `q` or `sort` or `dim_max` or `dim_min` or `dimension` or `status` or `subtree_id` or `parent_id`"}},"security":[{"bearerAuth":[]}]}},"/buckets/flows":{"get":{"parameters":[{"in":"query","name":"dimension","required":false,"schema":{"type":"string"}},{"in":"query","name":"window_days","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/FlowEdge"},"type":"array"}}},"description":""},"400":{"description":"Invalid `window_days` or `dimension`"}},"security":[{"bearerAuth":[]}]}},"/buckets/labels":{"get":{"parameters":[{"in":"query","name":"q","required":false,"schema":{"type":"string"}},{"in":"query","name":"status","required":false,"schema":{"type":"string"}},{"in":"query","name":"used_within_hours","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"unused_for_hours","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"with_parents","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"with_descendants","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/BucketLabelsResp"}}},"description":""},"400":{"description":"Invalid `limit` or `with_descendants` or `with_parents` or `unused_for_hours` or `used_within_hours` or `status` or `q`"}},"security":[{"bearerAuth":[]}]}},"/buckets/metrics/prometheus/default":{"get":{"parameters":[{"in":"query","name":"parent_id","required":false,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"status","required":false,"schema":{"type":"string"}},{"in":"query","name":"dimension","required":false,"schema":{"type":"string"}},{"in":"query","name":"dim_min","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"dim_max","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"text/plain;charset=utf-8":{"schema":{"type":"string"}}},"description":""},"400":{"description":"Invalid `sort` or `dim_max` or `dim_min` or `dimension` or `status` or `parent_id`"}},"security":[{"bearerAuth":[]}]}},"/buckets/metrics/prometheus/secret-url/{tenantId}/{token}":{"get":{"parameters":[{"in":"path","name":"tenantId","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"token","required":true,"schema":{"type":"string"}},{"in":"query","name":"parent_id","required":false,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"status","required":false,"schema":{"type":"string"}},{"in":"query","name":"dimension","required":false,"schema":{"type":"string"}},{"in":"query","name":"dim_min","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"dim_max","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"text/plain;charset=utf-8":{"schema":{"type":"string"}}},"description":""},"400":{"description":"Invalid `sort` or `dim_max` or `dim_min` or `dimension` or `status` or `parent_id`"},"404":{"description":"`tenantId` or `token` not found"}}}},"/buckets/pacing":{"get":{"parameters":[{"in":"query","name":"bucket_id","schema":{"items":{"format":"uuid","type":"string"},"type":"array"}},{"in":"query","name":"dimension","required":false,"schema":{"type":"string"}},{"in":"query","name":"slice_minutes","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"periods_back","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/PacingResp"}}},"description":""},"400":{"description":"Invalid `periods_back` or `slice_minutes` or `dimension` or `bucket_id`"}},"security":[{"bearerAuth":[]}]}},"/buckets/period-series":{"get":{"parameters":[{"in":"query","name":"granularity","required":false,"schema":{"type":"string"}},{"in":"query","name":"window_days","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"bucket_id","schema":{"items":{"format":"uuid","type":"string"},"type":"array"}},{"in":"query","name":"subtree","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"dimension","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"include_open","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"group","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/SeriesResp"}}},"description":""},"400":{"description":"Invalid `group` or `include_open` or `limit` or `dimension` or `subtree` or `bucket_id` or `window_days` or `granularity`"}},"security":[{"bearerAuth":[]}]}},"/buckets/periods":{"get":{"parameters":[{"in":"query","name":"window_days","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"bucket_id","required":false,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"dimension","required":false,"schema":{"type":"string"}},{"in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"include_open","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/LedgerResp"}}},"description":""},"400":{"description":"Invalid `include_open` or `limit` or `sort` or `dimension` or `bucket_id` or `window_days`"}},"security":[{"bearerAuth":[]}]}},"/buckets/recency":{"get":{"parameters":[{"in":"query","name":"window_days","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/BucketRecencyCurve"}}},"description":""},"400":{"description":"Invalid `window_days`"}},"security":[{"bearerAuth":[]}]}},"/buckets/shortfall-ranking":{"get":{"parameters":[{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ShortfallRankingResp"}}},"description":""},"400":{"description":"Invalid `limit`"}},"security":[{"bearerAuth":[]}]}},"/buckets/status-counts":{"get":{"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/BucketStatusCount"},"type":"array"}}},"description":""}},"security":[{"bearerAuth":[]}]}},"/buckets/tree-index":{"get":{"parameters":[{"in":"query","name":"scope_root","required":false,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"balances","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/TreeIndexResp"}}},"description":""},"400":{"description":"Invalid `balances` or `scope_root`"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"202":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/BucketDeletionStatus"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/Bucket"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"patch":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/PatchBucketReq"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/Bucket"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/ancestors":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/Bucket"},"type":"array"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/auction":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/AuctionView"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/AuctionConfig"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/AuctionView"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/auction/bids":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"status","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/BidView"},"type":"array"}}},"description":""},"400":{"description":"Invalid `offset` or `limit` or `status`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"post":{"callbacks":{"bidCallback":{"{$request.body#/callbackUrl}":{"post":{"description":"Only when the bid has a callbackUrl, for that bid's bid.won, bid.outbid, bid.cancelled and bid.expired (not bid.placed or bid.changed). Carries callback_metadata when callbackMetadata was set.\n\nDelivery: POST, Content-Type application/json, a 10 s timeout, redirects not followed. A 2xx, a 3xx or a 4xx other than 429 counts as delivered. A transport failure (no response within 10 s, connection refused, DNS failure) or a 5xx or 429 answer is retried: 30 s after the first attempt, then doubling, capped at 1 h, 8 attempts in all, after which the delivery is exhausted. A Retry-After on a 429 or 503 (seconds or an HTTP-date) replaces the backoff for that retry, capped at 1 h. The first attempt is made as soon as the event happens, independently of any request in flight. Deliveries are not ordered, and a retry can arrive after a later event, so order by timestamp. A repeat is possible (a timeout on a request the receiver did get is retried), and so is a loss (an instance stopped mid-attempt writes no retry row). Before every attempt the URL is checked again against the tenant's callback allowlist and verified destinations; a URL no longer covered is refused and never retried. There is no event header on a delivery: the body's event field is the only place the event name is. GET /help/events documents each event's details; GET /webhooks/{id}/deliveries lists a webhook's attempts of the last 14 days by default (an instance setting; a delivery still being retried is kept).","parameters":[{"deprecated":false,"description":"Sent only when the webhook (cwrSecret) or the callback (acCallbackSecret) has a secret: sha256= followed by the lowercase hex HMAC-SHA256 of the raw request body, keyed with the secret's UTF-8 bytes. Verify it over the bytes received, before parsing, with a constant-time comparison.","in":"header","name":"X-Buckette-Signature","required":false,"schema":{"pattern":"^sha256=[0-9a-f]{64}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDelivery"}}},"required":true},"responses":{"default":{"description":"A 2xx, or a 4xx other than 429, ends the delivery: buckette records its status and does not retry. A 5xx or a 429 is a failed attempt and is retried (see the delivery rules). The response body is not read."}},"summary":"An event, POSTed by buckette to this URL"}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/PlaceBidReq"}}},"required":true},"responses":{"201":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/BidView"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/auction/rounds":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/RoundView"},"type":"array"}}},"description":""},"400":{"description":"Invalid `offset` or `limit`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/auction/rounds/{rid}":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"rid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/RoundView"}}},"description":""},"404":{"description":"`id` or `rid` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/check":{"post":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ConsumeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ConsumeOutcome"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/class-config":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ClassConfig"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/Bucket"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/class-floor-suggestion":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"order","required":false,"schema":{"type":"string"}},{"in":"query","name":"periods","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"coverage","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"dimension","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/SuggestionResp"}}},"description":""},"400":{"description":"Invalid `dimension` or `coverage` or `periods` or `order`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/consume":{"post":{"callbacks":{"asyncCallback":{"{$request.body#/crMode/contents/acCallbackUrl}":{"post":{"description":"Only when crMode is Async with an acCallbackUrl, once, when the queued consume resolves: bucket.consumed, bucket.resources_available or bucket.consume_expired. Carries callback_metadata when acCallbackMetadata was set.\n\nDelivery: POST, Content-Type application/json, a 10 s timeout, redirects not followed. A 2xx, a 3xx or a 4xx other than 429 counts as delivered. A transport failure (no response within 10 s, connection refused, DNS failure) or a 5xx or 429 answer is retried: 30 s after the first attempt, then doubling, capped at 1 h, 8 attempts in all, after which the delivery is exhausted. A Retry-After on a 429 or 503 (seconds or an HTTP-date) replaces the backoff for that retry, capped at 1 h. The first attempt is made as soon as the event happens, independently of any request in flight. Deliveries are not ordered, and a retry can arrive after a later event, so order by timestamp. A repeat is possible (a timeout on a request the receiver did get is retried), and so is a loss (an instance stopped mid-attempt writes no retry row). Before every attempt the URL is checked again against the tenant's callback allowlist and verified destinations; a URL no longer covered is refused and never retried. There is no event header on a delivery: the body's event field is the only place the event name is. GET /help/events documents each event's details; GET /webhooks/{id}/deliveries lists a webhook's attempts of the last 14 days by default (an instance setting; a delivery still being retried is kept).","parameters":[{"deprecated":false,"description":"Sent only when the webhook (cwrSecret) or the callback (acCallbackSecret) has a secret: sha256= followed by the lowercase hex HMAC-SHA256 of the raw request body, keyed with the secret's UTF-8 bytes. Verify it over the bytes received, before parsing, with a constant-time comparison.","in":"header","name":"X-Buckette-Signature","required":false,"schema":{"pattern":"^sha256=[0-9a-f]{64}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDelivery"}}},"required":true},"responses":{"default":{"description":"A 2xx, or a 4xx other than 429, ends the delivery: buckette records its status and does not retry. A 5xx or a 429 is a failed attempt and is retried (see the delivery rules). The response body is not read."}},"summary":"An event, POSTed by buckette to this URL"}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ConsumeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ConsumeOutcome"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/consume-breakdown":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"key","required":false,"schema":{"type":"string"}},{"in":"query","name":"dimension","required":false,"schema":{"type":"string"}},{"in":"query","name":"periods_back","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"window_days","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"subtree","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/BreakdownResp"}}},"description":""},"400":{"description":"Invalid `limit` or `subtree` or `window_days` or `periods_back` or `dimension` or `key`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/deletion":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/BucketDeletionStatus"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/depletion-warning":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/DepletionWarningView"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/DepletionWarningConfig"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/DepletionWarningView"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/descendants":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/Bucket"},"type":"array"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/eta":{"post":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/EtaRequest"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ShortfallEta"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/events":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"event_type","required":false,"schema":{"type":"string"}},{"in":"query","name":"before","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/EventRecord"},"type":"array"}}},"description":""},"400":{"description":"Invalid `before` or `event_type` or `offset` or `limit`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/hard":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/metadata":{"patch":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/AnyJson"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/AnyJson"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/pending-consumes":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/PendingConsume"},"type":"array"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/pending-consumes/{pcid}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"pcid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` or `pcid` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/pending-reserves":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/PendingReserve"},"type":"array"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/pending-reserves/{prid}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"prid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` or `prid` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/periods":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"before","required":false,"schema":{"format":"yyyy-mm-ddThh:MM:ssZ","type":"string"}},{"in":"query","name":"subtree","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/PeriodsResp"}}},"description":""},"400":{"description":"Invalid `subtree` or `before` or `limit`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/reclaim":{"post":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ReclaimRequest"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ReclaimResp"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/replenish":{"post":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ReplenishReq"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ReplenishResp"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/replenish-config":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ReplenishConfigView"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ReplenishConfig"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/Bucket"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/replenishment-dry-run":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"dimension","required":false,"schema":{"type":"string"}},{"in":"query","name":"period","required":false,"schema":{"type":"string"}},{"in":"query","name":"coverage","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"periods","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"amount","required":false,"schema":{"type":"string"}},{"in":"query","name":"cap","required":false,"schema":{"type":"string"}},{"in":"query","name":"carryover","required":false,"schema":{"type":"string"}},{"in":"query","name":"uncensored_only","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"subtree","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/DryRunResp"}}},"description":""},"400":{"description":"Invalid `subtree` or `uncensored_only` or `carryover` or `cap` or `amount` or `periods` or `coverage` or `period` or `dimension`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/replenishments":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/ReplenishRecord"},"type":"array"}}},"description":""},"400":{"description":"Invalid `offset` or `limit`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/reservations":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"status","required":false,"schema":{"type":"string"}},{"in":"query","name":"api_key_id","required":false,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"metadata","schema":{"items":{"type":"string"},"type":"array"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"cursor","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/Reservation"},"type":"array"}}},"description":"","headers":{"X-Next-Cursor":{"schema":{"type":"string"}}}},"400":{"description":"Invalid `cursor` or `limit` or `metadata` or `api_key_id` or `status`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"post":{"callbacks":{"asyncCallback":{"{$request.body#/rrvMode/contents/acCallbackUrl}":{"post":{"description":"Only when rrvMode is Async with an acCallbackUrl, once, when the queued reserve resolves: bucket.reserved, bucket.resources_available or bucket.reserve_expired. Carries callback_metadata when acCallbackMetadata was set.\n\nDelivery: POST, Content-Type application/json, a 10 s timeout, redirects not followed. A 2xx, a 3xx or a 4xx other than 429 counts as delivered. A transport failure (no response within 10 s, connection refused, DNS failure) or a 5xx or 429 answer is retried: 30 s after the first attempt, then doubling, capped at 1 h, 8 attempts in all, after which the delivery is exhausted. A Retry-After on a 429 or 503 (seconds or an HTTP-date) replaces the backoff for that retry, capped at 1 h. The first attempt is made as soon as the event happens, independently of any request in flight. Deliveries are not ordered, and a retry can arrive after a later event, so order by timestamp. A repeat is possible (a timeout on a request the receiver did get is retried), and so is a loss (an instance stopped mid-attempt writes no retry row). Before every attempt the URL is checked again against the tenant's callback allowlist and verified destinations; a URL no longer covered is refused and never retried. There is no event header on a delivery: the body's event field is the only place the event name is. GET /help/events documents each event's details; GET /webhooks/{id}/deliveries lists a webhook's attempts of the last 14 days by default (an instance setting; a delivery still being retried is kept).","parameters":[{"deprecated":false,"description":"Sent only when the webhook (cwrSecret) or the callback (acCallbackSecret) has a secret: sha256= followed by the lowercase hex HMAC-SHA256 of the raw request body, keyed with the secret's UTF-8 bytes. Verify it over the bytes received, before parsing, with a constant-time comparison.","in":"header","name":"X-Buckette-Signature","required":false,"schema":{"pattern":"^sha256=[0-9a-f]{64}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDelivery"}}},"required":true},"responses":{"default":{"description":"A 2xx, or a 4xx other than 429, ends the delivery: buckette records its status and does not retry. A 5xx or a 429 is a failed attempt and is retried (see the delivery rules). The response body is not read."}},"summary":"An event, POSTed by buckette to this URL"}}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ReserveReq"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ReserveOutcome"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/reservations/{rid}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"rid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` or `rid` not found"}},"security":[{"bearerAuth":[]}]},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"rid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/Reservation"}}},"description":""},"404":{"description":"`id` or `rid` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/reservations/{rid}/commit":{"post":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"rid","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/CommitReq"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ConsumeOutcome"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` or `rid` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/reservations/{rid}/grow":{"post":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"rid","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/GrowReservationReq"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ReserveOutcome"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` or `rid` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/reservations/{rid}/refresh":{"post":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"rid","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/RefreshReservationReq"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/Reservation"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` or `rid` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/reservations/{rid}/release":{"post":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"rid","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ReleaseReservationReq"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/Reservation"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` or `rid` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/split":{"post":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/SplitRequest"}}},"required":true},"responses":{"201":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/SplitResp"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/stats":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/BucketStats"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/threshold-config":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"additionalProperties":{"$ref":"#/components/schemas/ThresholdSpec"},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/Bucket"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/topup-config":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/TopupConfigView"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/TopupConfig"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/TopupConfigView"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/tree":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/BucketTreeNode"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/buckets/{id}/unspent-warning":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"put":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/UnspentWarningConfig"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/Bucket"}}},"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/callback-allowlist":{"delete":{"responses":{"204":{"description":""}},"security":[{"bearerAuth":[]}]},"get":{"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/CallbackAllowlistReq"}}},"description":""}},"security":[{"bearerAuth":[]}]},"put":{"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/CallbackAllowlistReq"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/CallbackAllowlistReq"}}},"description":""},"400":{"description":"Invalid `body`"}},"security":[{"bearerAuth":[]}]}},"/claim-reservations":{"get":{"parameters":[{"in":"query","name":"status","required":false,"schema":{"type":"string"}},{"in":"query","name":"bucket_id","required":false,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/ClaimReservation"},"type":"array"}}},"description":""},"400":{"description":"Invalid `offset` or `limit` or `bucket_id` or `status`"}},"security":[{"bearerAuth":[]}]},"post":{"callbacks":{"asyncCallback":{"{$request.body#/clrrMode/contents/acCallbackUrl}":{"post":{"description":"Only when clrrMode is Async with an acCallbackUrl, once, when the queued claim reservation resolves: claim.reserved, claim.reservation_available or claim.reservation_expired. bucket_id is the first grant's bucket. Carries callback_metadata when acCallbackMetadata was set.\n\nDelivery: POST, Content-Type application/json, a 10 s timeout, redirects not followed. A 2xx, a 3xx or a 4xx other than 429 counts as delivered. A transport failure (no response within 10 s, connection refused, DNS failure) or a 5xx or 429 answer is retried: 30 s after the first attempt, then doubling, capped at 1 h, 8 attempts in all, after which the delivery is exhausted. A Retry-After on a 429 or 503 (seconds or an HTTP-date) replaces the backoff for that retry, capped at 1 h. The first attempt is made as soon as the event happens, independently of any request in flight. Deliveries are not ordered, and a retry can arrive after a later event, so order by timestamp. A repeat is possible (a timeout on a request the receiver did get is retried), and so is a loss (an instance stopped mid-attempt writes no retry row). Before every attempt the URL is checked again against the tenant's callback allowlist and verified destinations; a URL no longer covered is refused and never retried. There is no event header on a delivery: the body's event field is the only place the event name is. GET /help/events documents each event's details; GET /webhooks/{id}/deliveries lists a webhook's attempts of the last 14 days by default (an instance setting; a delivery still being retried is kept).","parameters":[{"deprecated":false,"description":"Sent only when the webhook (cwrSecret) or the callback (acCallbackSecret) has a secret: sha256= followed by the lowercase hex HMAC-SHA256 of the raw request body, keyed with the secret's UTF-8 bytes. Verify it over the bytes received, before parsing, with a constant-time comparison.","in":"header","name":"X-Buckette-Signature","required":false,"schema":{"pattern":"^sha256=[0-9a-f]{64}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDelivery"}}},"required":true},"responses":{"default":{"description":"A 2xx, or a 4xx other than 429, ends the delivery: buckette records its status and does not retry. A 5xx or a 429 is a failed attempt and is retried (see the delivery rules). The response body is not read."}},"summary":"An event, POSTed by buckette to this URL"}}}},"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ClaimReserveReq"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ClaimReserveOutcome"}}},"description":""},"400":{"description":"Invalid `body`"}},"security":[{"bearerAuth":[]}]}},"/claim-reservations/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]},"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ClaimReservation"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/claim-reservations/{id}/commit":{"post":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ClaimOutcome"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/claim-reservations/{id}/events":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/EventRecord"},"type":"array"}}},"description":""},"400":{"description":"Invalid `offset` or `limit`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/claims":{"get":{"parameters":[{"in":"query","name":"status","required":false,"schema":{"type":"string"}},{"in":"query","name":"bucket_id","required":false,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/ClaimInfo"},"type":"array"}}},"description":""},"400":{"description":"Invalid `offset` or `limit` or `bucket_id` or `status`"}},"security":[{"bearerAuth":[]}]},"post":{"callbacks":{"asyncCallback":{"{$request.body#/clrMode/contents/acCallbackUrl}":{"post":{"description":"Only when clrMode is Async with an acCallbackUrl, once, when the queued claim resolves: claim.granted, claim.resources_available or claim.expired. bucket_id is the claim's first target. Carries callback_metadata when acCallbackMetadata was set.\n\nDelivery: POST, Content-Type application/json, a 10 s timeout, redirects not followed. A 2xx, a 3xx or a 4xx other than 429 counts as delivered. A transport failure (no response within 10 s, connection refused, DNS failure) or a 5xx or 429 answer is retried: 30 s after the first attempt, then doubling, capped at 1 h, 8 attempts in all, after which the delivery is exhausted. A Retry-After on a 429 or 503 (seconds or an HTTP-date) replaces the backoff for that retry, capped at 1 h. The first attempt is made as soon as the event happens, independently of any request in flight. Deliveries are not ordered, and a retry can arrive after a later event, so order by timestamp. A repeat is possible (a timeout on a request the receiver did get is retried), and so is a loss (an instance stopped mid-attempt writes no retry row). Before every attempt the URL is checked again against the tenant's callback allowlist and verified destinations; a URL no longer covered is refused and never retried. There is no event header on a delivery: the body's event field is the only place the event name is. GET /help/events documents each event's details; GET /webhooks/{id}/deliveries lists a webhook's attempts of the last 14 days by default (an instance setting; a delivery still being retried is kept).","parameters":[{"deprecated":false,"description":"Sent only when the webhook (cwrSecret) or the callback (acCallbackSecret) has a secret: sha256= followed by the lowercase hex HMAC-SHA256 of the raw request body, keyed with the secret's UTF-8 bytes. Verify it over the bytes received, before parsing, with a constant-time comparison.","in":"header","name":"X-Buckette-Signature","required":false,"schema":{"pattern":"^sha256=[0-9a-f]{64}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDelivery"}}},"required":true},"responses":{"default":{"description":"A 2xx, or a 4xx other than 429, ends the delivery: buckette records its status and does not retry. A 5xx or a 429 is a failed attempt and is retried (see the delivery rules). The response body is not read."}},"summary":"An event, POSTed by buckette to this URL"}}}},"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ClaimOutcome"}}},"description":""},"400":{"description":"Invalid `body`"}},"security":[{"bearerAuth":[]}]}},"/claims/check":{"post":{"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ClaimOutcome"}}},"description":""},"400":{"description":"Invalid `body`"}},"security":[{"bearerAuth":[]}]}},"/claims/{cid}":{"delete":{"parameters":[{"in":"path","name":"cid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`cid` not found"}},"security":[{"bearerAuth":[]}]},"get":{"parameters":[{"in":"path","name":"cid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ClaimInfo"}}},"description":""},"404":{"description":"`cid` not found"}},"security":[{"bearerAuth":[]}]}},"/claims/{cid}/events":{"get":{"parameters":[{"in":"path","name":"cid","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/EventRecord"},"type":"array"}}},"description":""},"400":{"description":"Invalid `offset` or `limit`"},"404":{"description":"`cid` not found"}},"security":[{"bearerAuth":[]}]}},"/cors-allowed-origins":{"delete":{"responses":{"204":{"description":""}},"security":[{"bearerAuth":[]}]},"get":{"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/CorsAllowedOriginsReq"}}},"description":""}},"security":[{"bearerAuth":[]}]},"put":{"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/CorsAllowedOriginsReq"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/CorsAllowedOriginsReq"}}},"description":""},"400":{"description":"Invalid `body`"}},"security":[{"bearerAuth":[]}]}},"/destinations":{"get":{"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/DestinationInfo"},"type":"array"}}},"description":""}},"security":[{"bearerAuth":[]}]},"post":{"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/CreateDestinationReq"}}},"required":true},"responses":{"201":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/DestinationInfo"}}},"description":""},"400":{"description":"Invalid `body`"}},"security":[{"bearerAuth":[]}]}},"/destinations/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/destinations/{id}/checks":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/DestinationCheckRecord"},"type":"array"}}},"description":""},"400":{"description":"Invalid `limit`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/destinations/{id}/verify":{"post":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/DestinationInfo"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/docs/{name}":{"get":{"parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"text/plain;charset=utf-8":{"schema":{"type":"string"}}},"description":""},"404":{"description":"`name` not found"}}}},"/health":{"get":{"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/HealthStatus"}}},"description":""}}}},"/help":{"get":{"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/HelpIndex"}}},"description":""}}}},"/help/{topic}":{"get":{"parameters":[{"in":"path","name":"topic","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/HelpEntry"}}},"description":""},"404":{"description":"`topic` not found"}}}},"/pending-claim-reservations":{"get":{"parameters":[{"in":"query","name":"status","required":false,"schema":{"type":"string"}},{"in":"query","name":"bucket_id","required":false,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/PendingClaimReservation"},"type":"array"}}},"description":""},"400":{"description":"Invalid `offset` or `limit` or `bucket_id` or `status`"}},"security":[{"bearerAuth":[]}]}},"/pending-claim-reservations/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/pending-transfers":{"get":{"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/PendingTransfer"},"type":"array"}}},"description":""}},"security":[{"bearerAuth":[]}]}},"/pending-transfers/{ptid}":{"delete":{"parameters":[{"in":"path","name":"ptid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`ptid` not found"}},"security":[{"bearerAuth":[]}]}},"/replenish-schedule/preview":{"post":{"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ReplenishSchedule"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ScheduleView"}}},"description":""},"400":{"description":"Invalid `body`"}},"security":[{"bearerAuth":[]}]}},"/secrets":{"get":{"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/SecretInfo"},"type":"array"}}},"description":""}},"security":[{"bearerAuth":[]}]}},"/secrets/{name}":{"delete":{"parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`name` not found"}},"security":[{"bearerAuth":[]}]},"put":{"parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/PutSecretReq"}}},"required":true},"responses":{"204":{"description":""},"400":{"description":"Invalid `body`"},"404":{"description":"`name` not found"}},"security":[{"bearerAuth":[]}]}},"/tenants/me":{"get":{"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/TenantInfo"}}},"description":""}},"security":[{"bearerAuth":[]}]}},"/tenants/me/bucket-deletion-policy":{"get":{"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/BucketDeletionPolicyEffect"}}},"description":""}},"security":[{"bearerAuth":[]}]},"put":{"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/SetBucketDeletionPolicyReq"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/BucketDeletionPolicyEffect"}}},"description":""},"400":{"description":"Invalid `body`"}},"security":[{"bearerAuth":[]}]}},"/tenants/me/metadata":{"get":{"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/TenantMetadataResp"}}},"description":""}},"security":[{"bearerAuth":[]}]},"put":{"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/SetTenantMetadataReq"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/TenantMetadataResp"}}},"description":""},"400":{"description":"Invalid `body`"}},"security":[{"bearerAuth":[]}]}},"/tenants/me/usage":{"get":{"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/TenantUsage"}}},"description":""}},"security":[{"bearerAuth":[]}]}},"/tenants/metrics-secret":{"delete":{"responses":{"204":{"description":""}},"security":[{"bearerAuth":[]}]},"get":{"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/TenantMetricsSecretStatus"}}},"description":""}},"security":[{"bearerAuth":[]}]},"post":{"responses":{"201":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/TenantMetricsSecretResp"}}},"description":""}},"security":[{"bearerAuth":[]}]}},"/tenants/{tenantId}/receipt-public-key":{"get":{"parameters":[{"in":"path","name":"tenantId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/TenantProofKey"}}},"description":""},"404":{"description":"`tenantId` not found"}}}},"/transfers":{"post":{"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/TransferRequest"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/TransferOutcome"}}},"description":""},"400":{"description":"Invalid `body`"}},"security":[{"bearerAuth":[]}]}},"/webhooks":{"get":{"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/WebhookInfo"},"type":"array"}}},"description":""}},"security":[{"bearerAuth":[]}]},"post":{"callbacks":{"delivery":{"{$request.body#/cwrUrl}":{"post":{"description":"Every event this webhook subscribes to (cwrEvents; empty means all), on every bucket of the tenant, until the webhook is deleted or disabled. Carries webhook_metadata when cwrMetadata was set.\n\nDelivery: POST, Content-Type application/json, a 10 s timeout, redirects not followed. A 2xx, a 3xx or a 4xx other than 429 counts as delivered. A transport failure (no response within 10 s, connection refused, DNS failure) or a 5xx or 429 answer is retried: 30 s after the first attempt, then doubling, capped at 1 h, 8 attempts in all, after which the delivery is exhausted. A Retry-After on a 429 or 503 (seconds or an HTTP-date) replaces the backoff for that retry, capped at 1 h. The first attempt is made as soon as the event happens, independently of any request in flight. Deliveries are not ordered, and a retry can arrive after a later event, so order by timestamp. A repeat is possible (a timeout on a request the receiver did get is retried), and so is a loss (an instance stopped mid-attempt writes no retry row). Before every attempt the URL is checked again against the tenant's callback allowlist and verified destinations; a URL no longer covered is refused and never retried. There is no event header on a delivery: the body's event field is the only place the event name is. GET /help/events documents each event's details; GET /webhooks/{id}/deliveries lists a webhook's attempts of the last 14 days by default (an instance setting; a delivery still being retried is kept).","parameters":[{"deprecated":false,"description":"Sent only when the webhook (cwrSecret) or the callback (acCallbackSecret) has a secret: sha256= followed by the lowercase hex HMAC-SHA256 of the raw request body, keyed with the secret's UTF-8 bytes. Verify it over the bytes received, before parsing, with a constant-time comparison.","in":"header","name":"X-Buckette-Signature","required":false,"schema":{"pattern":"^sha256=[0-9a-f]{64}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDelivery"}}},"required":true},"responses":{"default":{"description":"A 2xx, or a 4xx other than 429, ends the delivery: buckette records its status and does not retry. A 5xx or a 429 is a failed attempt and is retried (see the delivery rules). The response body is not read."}},"summary":"An event, POSTed by buckette to this URL"}}}},"requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/CreateWebhookReq"}}},"required":true},"responses":{"201":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/WebhookInfo"}}},"description":""},"400":{"description":"Invalid `body`"}},"security":[{"bearerAuth":[]}]}},"/webhooks/{id}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/webhooks/{id}/deliveries":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/WebhookDeliveryRecord"},"type":"array"}}},"description":""},"400":{"description":"Invalid `offset` or `limit`"},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/webhooks/{id}/enable":{"post":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/WebhookInfo"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/webhooks/{id}/hard":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}},"/webhooks/{id}/test":{"post":{"description":"Sends one POST to the webhook's URL now, synchronously, through the same destination checks as a real delivery, and answers with what happened. Its body is the WebhookTestDelivery schema, not the WebhookDelivery envelope: a receiver must not require tenant_id or bucket_id. No retry and no row in the webhook's delivery log.","parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"201":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/WebhookTestResult"}}},"description":""},"404":{"description":"`id` not found"}},"security":[{"bearerAuth":[]}]}}}}