KEkeboola
Buckets

Update bucket listing

Update metadata and/or subscribers of an existing bucket listing. Only provided fields are updated, but the request body must include at least one of exposureName, exposureDescription, bigquery.subscribers, snowflake.grantees or snowflake.accounts — an empty JSON object is rejected with 400. The bigquery.listingId and snowflake.mode are immutable and cannot be changed. A sent snowflake.grantees list is granted in full, not only its new members, and every member that may still hold access and is no longer listed is revoked; the job result reports both lists as snowflake.added and snowflake.removed.

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 BucketListingUpdateJobResponse.

Parameters of job will be BucketListingUpdateJobParams.

patch/v2/storage/buckets/{bucketId}/listing

Request

Path parameters

bucketIdstring required

Identifier of the bucket whose listing should be updated.

Request body

OR
OR
OR
OR

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.