fastly-api 13.1.0

Fastly API client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

# KvStoreItemApi

> [!NOTE]
> All URIs are relative to `https://api.fastly.com`

Method | HTTP request | Description
------ | ------------ | -----------
[**kv_store_delete_item**](KvStoreItemApi.md#kv_store_delete_item) | **DELETE** /resources/stores/kv/{store_id}/keys/{key} | Delete an item.
[**kv_store_get_item**](KvStoreItemApi.md#kv_store_get_item) | **GET** /resources/stores/kv/{store_id}/keys/{key} | Get an item.
[**kv_store_list_item_keys**](KvStoreItemApi.md#kv_store_list_item_keys) | **GET** /resources/stores/kv/{store_id}/keys | List item keys.
[**kv_store_upsert_item**](KvStoreItemApi.md#kv_store_upsert_item) | **PUT** /resources/stores/kv/{store_id}/keys/{key} | Insert or update an item.



## kv_store_delete_item

Delete an item.

```rust
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](../README.md#token)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


## kv_store_get_item

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

```rust
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

**String**

### Authorization

[token](../README.md#token)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


## kv_store_list_item_keys

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

```rust
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::InlineResponse20011**](InlineResponse20011.md)

### Authorization

[token](../README.md#token)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


## kv_store_upsert_item

Inserts or updates an item's value and metadata.

```rust
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\<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[token](../README.md#token)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)