Modify a key-value or delete a key

Changes the value of the selected key in the key-value pair, deletes a key by setting the key value to <literal>null</literal>, changes expiration time of a key-value pair. If <a href="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</a> of keyval zones in a cluster is enabled, deletes a key only on a target cluster node. Expiration time in milliseconds can be specified for a key-value pair with the expire parameter which overrides the timeout parameter of the <a href="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">keyval_zone</a> directive.

patch/http/keyvals/{httpKeyvalZoneName}

Request body

NginxHTTPKeyvalZonePostPatch required

Contents of an HTTP keyval shared memory zone when using the POST or PATCH methods.

Example request

{
  "key1": "value1",
  "key2": "value2",
  "key3": {
    "value": "value3",
    "expire": 30000
  }
}

Response

Success

Changes

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