PUT /resources/stores/kv/{store_id}/keys/{key_name}

Set a new value for a new or existing key in an kv store.

Authorization: API token with at least Engineer permissions.

Servers

Path parameters

Name Type Required Description
store_id String Yes
key_name String Yes

Request headers

Name Type Required Description
time_to_live_sec String No

Sets a time for the key to expire. Deletion will take place up to 24 hours after the ttl reaches 0.

if-generation-match String No

Requests for keys will return a 'generation' header specific to the version of a key. The generation header is a unique, non-serial 32-bit integer that can be used for testing against a specific KV store value.

metadata String No

An arbitrary data field which can contain up to 2000B of data.

Query parameters

Name Type Required Description
background_fetch String No

If set to true, allows fetching from the origin to occur in the background, enabling a faster response with stale content. The cache will be updated with fresh content after the request is completed.

prepend String No

Updates the contents of a key by prepending the body of the request onto the existing key's contents. If the specified key does not exist, a new key is created.

add String No

Ensures the request will only succeed if the key doesn't already exist (shortcut equivalent for using the if-generation-match header with a value of 0).

append String No

Updates the contents of a key by appending the body of the request to the existing key's contents. If the specified key does not exist, a new key is created.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.