Validate

Validate column names

Validate strings if they can be used as column names. Column names can be used for example:

creating a table (POST /buckets/{bucketId}/tables-definition)
adding a column (POST /tables/{tableId}/columns)

post/v2/storage/branch/{branchId}/validate/column-names

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/validate/column-names/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

branchIdstring required

Request body

columnNamesstring[] required

Candidate column names to check against the StorageColumnName rule. The items are deliberately plain strings — an invalid candidate is the point of the call.

Example request

{
  "columnNames": [
    "First$$Column-Name",
    "Second Column-Name"
  ]
}

Response

All column names are valid.

Changes

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