KEkeboola
Buckets

Drop Bucket

Deletes a bucket from the project, or unlinks it when it is a linked bucket. In the default mode, only empty buckets can be deleted. Use the optional force parameter to delete all bucket content too. With async=true the bucket is dropped in a background job (recommended); the synchronous variant is deprecated.

Initial response returns job details JobResponse. The result of the asynchronous job can be fetched via /v2/storage/jobs/{id}. When the job completes, final result is BucketDeleteResponse.

Parameters of job will be BucketDeleteJobParams.

[Deprecated] This endpoint can be used synchronously as well.

delete/v2/storage/branch/{branchId}/buckets/{bucketId}

Request

Path parameters

bucketIdstring required

Bucket ID.

branchIdstring required

Query parameters

asyncboolean

Drops the bucket in a background job. This is useful if dropping takes too much time and times out.

forceboolean

Drops all tables and aliases. Tables must not have any dependencies (aliases, etc.).

Headers

contextstring nullable

Response

Job accepted; returns job details.

idstring required

Job ID.

statusstring required

Current status of the job.

urlstring required

API detail URL for the job.

tableIdstring nullable required

ID of the table affected by the job.

operationNamestring required

Type of operation performed.

operationParamsobject required

Parameters for the operation.

createdTimestring date-time required

Job creation timestamp.

startTimestring date-time nullable required

Job start timestamp.

endTimestring date-time nullable required

Job end timestamp.

runIdstring nullable required

Run ID for the job.

Example response

{
  "id": "22077337",
  "status": "waiting",
  "url": "https://connection.keboola.com/v2/storage/jobs/22077337",
  "tableId": null,
  "operationName": "workspaceLoad",
  "operationParams": {
    "workspaceId": "78423",
    "preserve": false,
    "input": [
      {
        "source": "in.c-application-testing.cashier-data",
        "destination": "my-table"
      }
    ],
    "queue": "main_fast"
  },
  "createdTime": "2017-02-13T16:41:18+0100",
  "startTime": null,
  "endTime": null,
  "runId": null,
  "results": null,
  "creatorToken": {
    "id": "27978",
    "description": "john.doe@keboola.com"
  },
  "actor": {
    "type": "token",
    "id": "27978",
    "name": "john.doe@keboola.com",
    "adminId": 1234
  },
  "metrics": {
    "inCompressed": false,
    "inBytes": 0,
    "inBytesUncompressed": 0,
    "outCompressed": false,
    "outBytes": 0,
    "outBytesUncompressed": 0
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.