Skip to content

KvStoreApi.md

Latest commit

 

History

History
193 lines (119 loc) · 4.55 KB

KvStoreApi.md

File metadata and controls

193 lines (119 loc) · 4.55 KB

KvStoreApi

Note

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

Method HTTP request Description
kv_store_create POST /resources/stores/kv Create a KV store.
kv_store_delete DELETE /resources/stores/kv/{store_id} Delete a KV store.
kv_store_get GET /resources/stores/kv/{store_id} Describe a KV store.
kv_store_list GET /resources/stores/kv List all KV stores.
kv_store_put PUT /resources/stores/kv/{store_id} Update a KV store.

kv_store_create

Create a KV store.

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

Parameters

Name Type Description Required Notes
location Option<String>
kv_store_request_create_or_update Option<KvStoreRequestCreateOrUpdate>

Return type

crate::models::KvStoreDetails

Authorization

token

HTTP request headers

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

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

kv_store_delete

A KV store must be empty before it can be deleted. Attempting to delete a KV store that contains items will result in a response with a 409 status code.

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

Parameters

Name Type Description Required Notes
store_id String [required]

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

Get details of a KV store.

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

Parameters

Name Type Description Required Notes
store_id String [required]

Return type

crate::models::KvStoreDetails

Authorization

token

HTTP request headers

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

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

kv_store_list

List all KV stores.

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

Parameters

Name Type Description Required Notes
cursor Option<String>
limit Option<i32> [default to 1000]
name Option<String> Returns a one-element array containing the details for the named KV store.

Return type

crate::models::InlineResponse20010

Authorization

token

HTTP request headers

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

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

kv_store_put

Update the name of a KV store.

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

Parameters

Name Type Description Required Notes
store_id String [required]
kv_store_request_create_or_update Option<KvStoreRequestCreateOrUpdate>

Return type

(empty response body)

Authorization

token

HTTP request headers

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

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