records

Insert Records

Inserts a record in the specified table.<br /><br />The time-to-live (TTL) for a transient field begins when the field value is set during record insertion.<br /><br />Columns that have a string data type and a uniqueness constraint accept strings up to 2500 characters. If an inserted string exceeds 2500 characters, the call returns a token insertion error.

post/v1/vaults/{vaultID}/{objectName}

Request

  • Base URL: https://%7B%7Bvault_uri%7D%7D.vault.skyflowapis.com
  • URL: https://%7B%7Bvault_uri%7D%7D.vault.skyflowapis.com/v1/vaults/{vaultID}/{objectName}
  • Auth: HTTP bearer

Path parameters

vaultIDstring required
objectNamestring required

Request body

tokenizationboolean

If true, this operation returns tokens for fields with tokenization enabled.

upsertstring

Name of a unique column in the table. Uses upsert operations to check if a record exists based on the unique column's value. If a matching record exists, the record updates with the values you provide. If a matching record doesn't exist, the upsert operation inserts a new record.<br /><br />When you upsert a field, include the entire contents you want the field to store. For JSON fields, include all nested fields and values. If a nested field isn't included, it's removed.

homogeneousboolean

If true, this operation mandates that all the records have the same fields. This parameter does not work with upsert.

byot'DISABLE' | 'ENABLE' | 'ENABLE_STRICT'

Token insertion behavior.

Response

OK

Changes

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