Key Value Store

Kv Set

Changed on

KV Set

post/api/v1.kv.set

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Request body

namespacestring nullable
keystring required
valueinteger[] required
ttl_msinteger nullable

Time to live in milliseconds

behavior'upsert' | 'insert' | 'update'
versioninteger nullable

If set, the write only succeeds when the stored version matches this value. Use the version field from a prior get response.

Example request

{
  "namespace": "some_namespace",
  "key": "some_key"
}

Response

versioninteger required

Changes

  • eef244bc652dRevision changes
    • warning

      changed the pattern of the request property from ^[a-zA-Z0-9\-/_.=+:]+$ to ^[a-zA-Z0-9\-/_.=+:{}]+$

  • a542ced3f593Revision changes
    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status