Metadata

Create or Update configuration metadata

Sets multiple metadata with one call. If the given key and provider combination already exist for the configuration, the data will be updated with the new value and timestamp. All metadata associated with the configuration are returned in the response.

All requests must include the branch (/branch/{branchId}) in the URL. This is also true for default (production) branch. You can find out the id of your default branch by calling List Branches and finding branch with attribute isDefault set to true.

post/v2/storage/components/{componentId}/configs/{configurationId}/metadata

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/components/:componentId/configs/:configurationId/metadata/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

componentIdstring required

Id of the component.

configurationIdstring required

Id of the configuration.

Request body

Example request

{
  "metadata": [
    {
      "key": "some-key",
      "value": "Some value"
    }
  ]
}

Response

All metadata of the configuration after the upsert.

idstring required

Metadata entry id.

keystring required

Metadata key.

valuestring required

Metadata value.

timestampstring required

When the entry was last set, ISO 8601 with a +hhmm offset.

Example response

[
  {
    "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.