Metadata

Create or update branch metadata

Sets multiple metadata with one call. If the given key already exists for the branch, the data will be updated with the new value and timestamp. All metadata associated with the branch are returned.

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. Or you can use placeholder default to use with project's default branch.

post/v2/storage/branch/{branchId}/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/branch/:branchId/metadata/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

branchIdstring required

Id of the development branch. Use default for the project default branch.

Request body

Example request

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

Response

All metadata associated with the branch.

idstring required

Metadata record identifier

keystring required

Metadata key

valuestring nullable required

Metadata value

timestampstring required

When the metadata was created or last updated, ISO 8601 with a +hhmm offset

Example response

[
  {
    "id": "19509",
    "key": "some-key",
    "value": "Some value",
    "timestamp": "2017-02-13T23:36:10+0100"
  }
]

Changes

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