KEkeboola
Components and Configurations

Create Configuration

Creates a new component configuration for Development Branch.

The variant without branch/{branchId} in the URL is deprecated, use the branch endpoint and set branch/default.

post/v2/storage/branch/{branchId}/components/{componentId}/configs

Request

Path parameters

componentIdstring required

Id of the component.

branchIdstring required

Request body

namestring required

Configuration name.

configurationIdstring nullable

Configuration id, must be unique within the component (max 100 characters). Auto-generated when omitted.

descriptionstring nullable

Configuration description.

configurationobject nullable

Configuration data; the maximum allowed size is 4MB.

stateobject nullable

State data; the maximum allowed size is 4MB.

changeDescriptionstring nullable

Description of the configuration modification.

isDisabledboolean nullable

Disabled flag. Accepts booleanish values.

folderstring nullable

Folder to put the configuration in, at most 400 characters after trimming. Surrounding whitespace is trimmed; omitted, null or an empty string means no folder.

Example request

{
  "name": "My new configuration",
  "configurationId": "main-1",
  "configuration": {
    "key": "value"
  },
  "changeDescription": "Initial configuration",
  "folder": "Marketing"
}

Response

Configuration created.

idstring required

Configuration id, unique within the component.

namestring required

Configuration name.

descriptionstring required

Configuration description.

createdstring required

When the configuration was created, ISO 8601 with a +hhmm offset; "" when none was recorded.

versioninteger required

Current version number. Use it as the If-Match precondition for update, delete and purge.

changeDescriptionstring nullable required

Change description of the current version.

isDisabledboolean required

Whether the configuration is disabled.

isDeletedboolean required

Whether the configuration is in the trash.

folderstring nullable required

Folder the configuration is grouped under; null when it is in none.

folderUpdatedstring nullable required

When the folder was last written (set, cleared, copied to a branch or merged), ISO 8601 with a +hhmm offset; null when the configuration has no folder. Read-only.

rowsSortOrderstring[]

Row ids in the desired order; empty when the default order (by id) applies.

Example response

{
  "id": "236606822",
  "name": "My new configuration",
  "created": "2017-02-13T12:01:05+0100",
  "creatorToken": {
    "id": 27978,
    "description": "dev@keboola.com"
  },
  "version": 1,
  "changeDescription": "Initial configuration",
  "folder": "Marketing",
  "folderUpdated": "2017-02-13T12:01:05+0100",
  "rows": [
    {
      "id": "row1",
      "name": "First row",
      "version": 1,
      "created": "2017-02-13T12:01:05+0100",
      "creatorToken": {
        "id": 27978,
        "description": "dev@keboola.com"
      },
      "changeDescription": "Row created",
      "versionIdentifier": "01H2W8N0ZJJB6V126C8ZSND28N"
    }
  ],
  "currentVersion": {
    "created": "2017-02-13T12:01:05+0100",
    "creatorToken": {
      "id": 27978,
      "description": "dev@keboola.com"
    },
    "changeDescription": "Initial configuration",
    "versionIdentifier": "01H2W7DAN0QT78NZQ2BD2BZT4S"
  }
}

Changes

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