KEkeboola
Search

Search storage objects

Search across storage objects (buckets, tables, columns, configurations) within the organization, optionally narrowed to specific projects via projectIds.

get/v2/storage/global-search

Request

Query parameters

querystring required

Search query string.

limitinteger

Maximum number of results to return.

offsetinteger

Number of results to skip (pagination).

types[]string[] nullable

Filter by object type. Repeatable.

projectIds[]integer[] nullable

Narrow the search to specific project ids. Repeatable.

branchTypes[]string[] nullable

Filter by branch type. Repeatable.

branchIds[]integer[] nullable

Filter by branch ids. Repeatable.

mode'standard' | 'regex'

Search mode. Allowed values: standard, regex. Default: standard.

standard: full-text search with normalisation (accent folding, lower-casing, word splitting). regex: Lucene regexp matched against the original (un-normalised) storage id and object name.

  • Matches if the pattern matches the id OR the name.
  • Whole-term semantics: "report" does NOT match "monthly_report"; use ".report." to match a substring.
  • Case-insensitive.
  • Object names longer than 256 characters are not searchable in regex mode (ids are not length-limited).
  • An invalid or overly long pattern returns HTTP 400.

Response

Search results.

allinteger required

Total number of matches across the organization, ignoring limit and offset.

Example response

{
  "all": 42,
  "items": [
    {
      "id": "in.c-main.users",
      "fullPath": {
        "project": {
          "id": 10
        }
      },
      "uri": "https://connection.keboola.com/v2/storage/tables/in.c-main.users"
    }
  ],
  "byType": {
    "total": 42,
    "table": 30,
    "configuration": 12
  }
}

Changes

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