Search component configurations by metadata

Search all component configurations accessible by the token by any combination of idComponent, configurationId and metadataKeys. Available only in branch context.

By default, each matching configuration is returned with just its idComponent and configurationId. Pass include=filteredMetadata to also return the metadata entries that matched the search.

get/v2/storage/branch/{branchId}/search/component-configurations

Request

Base URL
https://connection.keboola.com
Auth
- API key in header X-StorageApi-Token
- or API key in header X-KBC-ManageApiToken
- or HTTP bearer
TypeScript
https://skmtc.dev/keboola/apis/keboola-storage-api/docs/v2/storage/branch/:branchId/search/component-configurations/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

branchIdstring required

Query parameters

idComponentstring

Component identifier to filter by.

configurationIdstring

Configuration identifier to filter by.

metadataKeysstring[]

Metadata keys to search for.

includestring

Comma-separated list of resources to include (e.g. "filteredMetadata").

Response

List of component configurations matching the search criteria.

idComponentstring required

configurationIdstring required

Example response

[
  {
    "metadata": [
      {
        "id": "19509",
        "key": "some-key",
        "value": "Some value",
        "timestamp": "2017-02-13T12:01:05+0100"
      }
    ]
  }
]

Changes

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