List tables with row counts for a bucket

GET

/api/v1/{bucket}/tables

• Production
• Development

Returns all warehouse tables with the number of rows for the specified bucket. Requires authentication.

Authorizations

• BearerAuth
• ApiKeyAuth

Parameters

Path Parameters

bucket

required

string

/^[a-zA-Z0-9][a-zA-Z0-9\-]*$/

Flock bucket ID. The caller must have access to this bucket.

Example

example

Responses

200

Table list with row counts

object

data

required

Array<object>

object

table

required

string

Example

person

row_count

required

integer

Example

1250

Example

{
  "data": [
    {
      "table": "person",
      "row_count": 1250
    },
    {
      "table": "organisation",
      "row_count": 340
    },
    {
      "table": "member",
      "row_count": 980
    },
    {
      "table": "payment",
      "row_count": 4200
    }
  ]
}

401

Authentication required

object

error

required

object

code

required

Machine-readable error code.

string

Example

unauthorized

message

required

Human-readable error message.

string

Example

Authentication required

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

403

Access denied to bucket

object

error

required

object

code

required

Machine-readable error code.

string

Example

unauthorized

message

required

Human-readable error message.

string

Example

Authentication required

Example

{
  "error": {
    "code": "forbidden",
    "message": "Access denied to bucket 'example'"
  }
}