Components and Configurations

Create Configuration Row

Creates a new row (item) of an existing configuration in Development Branch (see the Development Branches section).

The variant without branch/{branchId} in the URL is deprecated; use the branch endpoint with branch/default.

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

Request

Path parameters

componentIdstring required

ID of the component, e.g. keboola.ex-db-mysql.

configurationIdstring required

ID of the configuration.

Request body

rowIdstring

Row id (must be unique for each configuration); if not set, it will be generated.

configurationobject

Configuration data; the maximum allowed size is 4MB.

stateobject

Configuration state data; the maximum allowed size is 4MB.

namestring

Row name.

descriptionstring

Row description.

isDisabledboolean

Disabled flag.

changeDescriptionstring

Version change description.

Example request

{
  "rowId": "orders",
  "configuration": {
    "host": "localhost",
    "port": 4406
  },
  "state": {
    "lastId": 123
  },
  "name": "My row",
  "description": "Extracts the orders table",
  "changeDescription": "Added new row"
}

Response

Created configuration row.

idstring required

Row identifier, unique within the configuration.

namestring required

Row name.

descriptionstring required

Row description.

isDisabledboolean required

Disabled flag.

versioninteger required

Current row version number.

createdstring required

Row creation time, ISO 8601 with a +hhmm offset; "" when none was recorded.

changeDescriptionstring nullable required

Description of the change that produced the current version.

versionIdentifierstring nullable required

Unique identifier of the current row version.

stateobject required

Row state data; {} when none is stored.

configurationobject required

Row configuration data.

Example response

{
  "id": "236781646",
  "name": "My row",
  "version": 1,
  "created": "2017-02-13T12:01:05+0100",
  "creatorToken": {
    "id": 27978,
    "description": "dev@keboola.com"
  },
  "changeDescription": "Added new row",
  "versionIdentifier": "01H59WQGTDQT8AC7XNWKQDS75P",
  "configuration": {
    "host": "localhost",
    "port": 4406
  }
}

Changes

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