Skip to content

Latest commit

 

History

History
170 lines (110 loc) · 4.37 KB

KvStoreItemApi.md

File metadata and controls

170 lines (110 loc) · 4.37 KB

KvStoreItemApi

Note

All URIs are relative to https://api.fastly.com

Method HTTP request Description
kv_store_delete_item DELETE /resources/stores/kv/{store_id}/keys/{key} Delete an item.
kv_store_get_item GET /resources/stores/kv/{store_id}/keys/{key} Get an item.
kv_store_list_item_keys GET /resources/stores/kv/{store_id}/keys List item keys.
kv_store_upsert_item PUT /resources/stores/kv/{store_id}/keys/{key} Insert or update an item.

kv_store_delete_item

Delete an item.

let cfg = &Configuration::default();
let params = KvStoreDeleteItemParams {
    // parameters
};
kv_store_delete_item(cfg, params)

Parameters

Name Type Description Required Notes
store_id String [required]
key String [required]
if_generation_match Option<i32>
force Option<bool> [default to false]

Return type

(empty response body)

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to README]

kv_store_get_item

Get an item, including its value, metadata (if any), and generation marker.

let cfg = &Configuration::default();
let params = KvStoreGetItemParams {
    // parameters
};
kv_store_get_item(cfg, params)

Parameters

Name Type Description Required Notes
store_id String [required]
key String [required]

Return type

std::path::PathBuf

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

[Back to top] [Back to API list] [Back to README]

kv_store_list_item_keys

Lists the matching item keys (or all item keys, if no prefix is supplied).

let cfg = &Configuration::default();
let params = KvStoreListItemKeysParams {
    // parameters
};
kv_store_list_item_keys(cfg, params)

Parameters

Name Type Description Required Notes
store_id String [required]
cursor Option<String>
limit Option<i32> [default to 100]
prefix Option<String>
consistency Option<String> [default to strong]

Return type

crate::models::InlineResponse2004

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]

kv_store_upsert_item

Inserts or updates an item's value and metadata.

let cfg = &Configuration::default();
let params = KvStoreUpsertItemParams {
    // parameters
};
kv_store_upsert_item(cfg, params)

Parameters

Name Type Description Required Notes
store_id String [required]
key String [required]
if_generation_match Option<i32>
time_to_live_sec Option<i32>
metadata Option<String>
add Option<bool> [default to false]
append Option<bool> [default to false]
prepend Option<bool> [default to false]
background_fetch Option<bool> [default to false]
body Option<std::path::PathBuf>

Return type

(empty response body)

Authorization

token

HTTP request headers

  • Content-Type: application/octet-stream
  • Accept: Not defined

[Back to top] [Back to API list] [Back to README]