KvStoreApi.md

Fastly::KvStoreApi

require 'fastly'
api_instance = Fastly::KvStoreApi.new

Methods

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()

kv_store_create(opts): <KvStoreDetails> # Create a KV store.

Create a KV store.

Examples

api_instance = Fastly::KvStoreApi.new
opts = {
    location: 'US', # String | 
    kv_store_request_create_or_update: Fastly::KvStoreRequestCreateOrUpdate.new({name: 'name_example'}), # KvStoreRequestCreateOrUpdate | 
}

begin
  # Create a KV store.
  result = api_instance.kv_store_create(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling KvStoreApi->kv_store_create: #{e}"
end

Options

Name	Type	Description	Notes
location	String		[optional]
kv_store_request_create_or_update	KvStoreRequestCreateOrUpdate		[optional]

Return type

KvStoreDetails

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

kv_store_delete()

kv_store_delete(opts) # Delete a KV store.

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.

Examples

api_instance = Fastly::KvStoreApi.new
opts = {
    store_id: 'store_id_example', # String | 
}

begin
  # Delete a KV store.
  api_instance.kv_store_delete(opts)
rescue Fastly::ApiError => e
  puts "Error when calling KvStoreApi->kv_store_delete: #{e}"
end

Options

Name	Type	Description	Notes
store_id	String

Return type

nil (empty response body)

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

kv_store_get()

kv_store_get(opts): <KvStoreDetails> # Describe a KV store.

Get details of a KV store.

Examples

api_instance = Fastly::KvStoreApi.new
opts = {
    store_id: 'store_id_example', # String | 
}

begin
  # Describe a KV store.
  result = api_instance.kv_store_get(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling KvStoreApi->kv_store_get: #{e}"
end

Options

Name	Type	Description	Notes
store_id	String

Return type

KvStoreDetails

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

kv_store_list()

kv_store_list(opts): <InlineResponse20010> # List all KV stores.

List all KV stores.

Examples

api_instance = Fastly::KvStoreApi.new
opts = {
    cursor: 'cursor_example', # String | 
    limit: 56, # Integer | 
    name: 'name_example', # String | Returns a one-element array containing the details for the named KV store.
}

begin
  # List all KV stores.
  result = api_instance.kv_store_list(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling KvStoreApi->kv_store_list: #{e}"
end

Options

Name	Type	Description	Notes
cursor	String		[optional]
limit	Integer		[optional][default to 1000]
name	String	Returns a one-element array containing the details for the named KV store.	[optional]

Return type

InlineResponse20010

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

kv_store_put()

kv_store_put(opts) # Update a KV store.

Update the name of a KV store.

Examples

api_instance = Fastly::KvStoreApi.new
opts = {
    store_id: 'store_id_example', # String | 
    kv_store_request_create_or_update: Fastly::KvStoreRequestCreateOrUpdate.new({name: 'name_example'}), # KvStoreRequestCreateOrUpdate | 
}

begin
  # Update a KV store.
  api_instance.kv_store_put(opts)
rescue Fastly::ApiError => e
  puts "Error when calling KvStoreApi->kv_store_put: #{e}"
end

Options

Name	Type	Description	Notes
store_id	String
kv_store_request_create_or_update	KvStoreRequestCreateOrUpdate		[optional]

Return type

nil (empty response body)

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