KV Buckets

Create a new KV bucket

Changed on

Creates a new key-value bucket with optional indexing configuration

post/storage/kv

Request

Request body

bucketstring required

Name of the bucket to create

compressionboolean

Whether to enable compression

descriptionstring

Description of the bucket

historyinteger

Number of historical versions to keep

max_bytesinteger

Maximum size of the bucket in bytes

max_value_sizeinteger

Maximum size of individual values in bytes

replicasinteger

Number of replicas

storage'file' | 'memory'

Response

Bad Request

messagestring

Example response

{
  "message": "success"
}

Changes

    • breaking

      removed the enum value 0.00 of the request property /

    • breaking

      removed the enum value 0.00 of the request property

    • breaking

      removed the enum value 1.00 of the request property /

    • breaking

      removed the enum value 1.00 of the request property

    • breaking

      the / request property type changed from integer to string

    • breaking

      the request property format changed from no format to int64

    • breaking

      the request property format changed from no format to int32

    • breaking

      the request property type changed from integer to string

    • info

      the request property default value 0 was removed

    • info

      the request property default value 0 was removed

    • info

      added the new file enum value to the request property /

    • info

      added the new file enum value to the request property

    • info

      added the new memory enum value to the request property /

    • info

      added the new memory enum value to the request property

    • breaking

      removed the enum value file of the request property

    • breaking

      removed the enum value geo_point of the request property ///

    • breaking

      removed the enum value memory of the request property

    • breaking

      the request property type changed from string to integer

    • breaking

      removed the success response with the status

    • warning

      the request property's min was set to 1.00

    • warning

      the request property's min was set to 1.00

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      the request property default value 0 was added

    • info

      the request property default value changed from file to 0

    • info

      the request property default value -1 was removed

    • info

      the request property default value -1 was removed

    • info

      added the new 0.00 enum value to the request property

    • info

      added the new 1.00 enum value to the request property

    • info

      added the new keyword enum value to the request property ///

    • info

      removed the pattern ^[a-zA-Z0-9_-]+$ from the request property

    • info

      the request property format was generalized from int8 to no format

    • info

      the request property format was generalized from int64 to no format

    • info

      the request property format was generalized from int32 to no format

    • info

      added the success response with the status