Sign in

v1

latestOpenAPI 3.1.02026-07-243035381.4 MB
Storage API

Cancel Walrus storage renewal

/v4/data/storage/upload/{jobId}

Soft cancel: 0 credits. Instant delete: billed via Walrus on-chain storage fees (same credit check as upload).

Cancel renewal for a certified Walrus storage upload. Two modes are available:

  • Soft cancel (default, instant=false): marks the blob as noRenewal=true. The file remains on-chain until its current storage epoch expires (walrusEndEpoch), then decommissions naturally. No additional fee is incurred — the remaining prepaid epochs are simply not renewed.
  • Instant delete (instant=true): queues an immediate on-chain delete transaction. Requires sufficient Walrus storage credits (same check as upload). The Walrus worker executes the delete tx and the on-chain delete fee is charged to your Walrus storage balance afterward. Can be applied even if soft cancel was already set — it upgrades to instant.

Both modes are idempotent. The job must be in CERTIFIED status and not already decommissioned.

delete/v4/data/storage/upload/{jobId}

Path parameters

jobIdstring required
Example:68000000000000000000abcd

The job ID returned by <code>POST /v4/data/storage/upload</code>.

Query parameters

instantboolean
Example:true

Set to <code>true</code> to queue an immediate on-chain delete (costs Walrus storage credits). Omit or set to <code>false</code> (default) for a free soft cancel — blob stays on-chain until its epoch expires.

Response

Renewal cancelled successfully.

jobIdstring required

The upload job ID.

noRenewalboolean required

Always true — renewal has been cancelled.

pendingInstantDeleteboolean

Present and true when an instant on-chain delete has been queued.

renewalBillingStatus'active' | 'pending_initial_charge' | 'pending_renewal_credit' | 'pending_decommission' | 'pending_instant_delete' | 'decommissioned'

Billing and renewal lifecycle of a certified Walrus blob.

  • active — blob is live; renewal credits applied on schedule.
  • pending_initial_charge — certified but first-period credits not yet charged.
  • pending_renewal_credit — on-chain extend succeeded; scanner posts renewal credits.
  • pending_decommission — blob past its end epoch; worker will decommission.
  • pending_instant_delete — immediate on-chain delete queued by user.
  • decommissioned — blob has been removed from Walrus storage.
walrusEndEpochinteger

Walrus epoch at which the blob expires or was deleted.

Example response

{
  "jobId": "68000000000000000000abcd",
  "noRenewal": true,
  "pendingInstantDelete": true,
  "renewalBillingStatus": "active",
  "walrusEndEpoch": 33
}