Empty a bucket

Starts a job that deletes every object in the bucket, and returns at once. Poll get_job until the job status is succeeded or failed. Objects under retention stay, and the job result lists their keys. An object written while the job runs can stay. Send the exact bucket name as confirmName. Role: editor or higher.

POST/v1/workspaces/{workspaceId}/buckets/{bucketId}/empty

Authentication

Send your Graphon API key with every request. The value is the whole API key that Graphon showed when you created it. See Authentication.

Authorization: Bearer <GRAPHON_API_KEY>

curl \
  --url "https://storage.graphon.sh/v1/workspaces/wspq7ws2np5l8z4/buckets/bktA1b2C3d4E5/empty" \
  --header "Authorization: Bearer $GRAPHON_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"confirmName":"support-tickets"}'

Request

Loading your session…

Response

This operation does not return a response body.

Path parameters

workspaceIdstring

The workspace id.

bucketIdstring

The bucket id.

Request body

confirmNamestring

The exact current bucket name.

Was this page helpful?

View as Markdown