KEkeboola
Buckets

Shared buckets list

Lists buckets which may be shared to the project (buckets shared within the organization the token can link). Requires the token to be able to manage buckets.

get/v2/storage/branch/{branchId}/shared-buckets

Request

Path parameters

branchIdstring required

Query parameters

includestring

Comma-separated list of resources to include for each bucket. Available resources: metadata.

Response

List of shared buckets.

idstring required

Bucket identifier in the source project.

namestring required

Bucket name.

displayNamestring required

Bucket display name.

stage'in' | 'out' | 'sys' required

Bucket stage.

descriptionstring required

Bucket description.

sharing'organization' | 'organization-project' | 'specific-projects' | 'specific-users' | 'null' nullable required

Sharing type.

createdstring required

Creation timestamp, ISO 8601 with a +hhmm offset; "" when none was recorded.

lastChangeDatestring nullable required

Timestamp of the last data change, ISO 8601 with a +hhmm offset.

dataSizeBytesinteger required
rowsCountinteger required
backendstring required

Storage backend of the bucket: snowflake, bigquery or postgres (external buckets); older buckets may carry another backend name.

hasExternalSchemaboolean required

Whether the bucket is an external (registered) bucket.

databaseNamestring required

Database of a Snowflake external bucket or of a linked bucket's source; "" otherwise.

pathstring required

Dot-separated path of the bucket on the backend.

colorstring nullable required

Example response

[
  {
    "id": "in.c-main",
    "name": "c-main",
    "displayName": "main",
    "stage": "in",
    "description": "Organization shared data",
    "sharing": "organization-project",
    "created": "2020-01-12T18:28:31+0100",
    "lastChangeDate": "2020-01-12T18:31:49+0100",
    "dataSizeBytes": 1536,
    "rowsCount": 32,
    "backend": "snowflake",
    "path": "database_name.c-main",
    "project": {
      "id": 123,
      "name": "Project name"
    },
    "tables": [
      {
        "id": "in.c-main.languages",
        "name": "languages",
        "displayName": "languages-display-name",
        "path": "/1234-languages"
      }
    ],
    "sharingParameters": {
      "projects": [
        {
          "id": 321,
          "name": "Some Project"
        }
      ],
      "users": [
        {
          "id": 5,
          "name": "Jan Developer",
          "email": "jan.dev@keboola.com"
        }
      ]
    },
    "sharedBy": {
      "id": 5,
      "name": "dev@keboola.com",
      "date": "2020-02-03T14:58:29+0100"
    },
    "owner": {
      "id": 123,
      "name": "Jan Developer",
      "email": "jan.dev@keboola.com"
    },
    "metadata": [
      {
        "id": "19509",
        "key": "some-key",
        "value": "Some value",
        "provider": "test-component",
        "timestamp": "2017-02-13T23:36:10+0100"
      }
    ]
  }
]

Changes

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