DictionaryApi.md

DictionaryApi

Note

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

Method	HTTP request	Description
create_dictionary	POST /service/{service_id}/version/{version_id}/dictionary	Create an edge dictionary
delete_dictionary	DELETE /service/{service_id}/version/{version_id}/dictionary/{dictionary_name}	Delete an edge dictionary
get_dictionary	GET /service/{service_id}/version/{version_id}/dictionary/{dictionary_name}	Get an edge dictionary
list_dictionaries	GET /service/{service_id}/version/{version_id}/dictionary	List edge dictionaries
update_dictionary	PUT /service/{service_id}/version/{version_id}/dictionary/{dictionary_name}	Update an edge dictionary

create_dictionary

Create named dictionary for a particular service and version.

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

Parameters

Name	Type	Description	Required	Notes
service_id	String	Alphanumeric string identifying the service.	[required]
version_id	i32	Integer identifying a service version.	[required]
name	Option<String>	Name for the Dictionary (must start with an alphabetic character and can contain only alphanumeric characters, underscores, and whitespace).
write_only	Option<bool>	Determines if items in the dictionary are readable or not.		[default to false]

Return type

crate::models::DictionaryResponse

Authorization

token

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: application/json

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

delete_dictionary

Delete named dictionary for a particular service and version.

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

Parameters

Name	Type	Description	Required	Notes
service_id	String	Alphanumeric string identifying the service.	[required]
version_id	i32	Integer identifying a service version.	[required]
dictionary_name	String	Name for the Dictionary (must start with an alphabetic character and can contain only alphanumeric characters, underscores, and whitespace).	[required]

Return type

crate::models::InlineResponse200

Authorization

token

HTTP request headers

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

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

get_dictionary

Retrieve a single dictionary by name for the version and service.

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

Parameters

Name	Type	Description	Required	Notes
service_id	String	Alphanumeric string identifying the service.	[required]
version_id	i32	Integer identifying a service version.	[required]
dictionary_name	String	Name for the Dictionary (must start with an alphabetic character and can contain only alphanumeric characters, underscores, and whitespace).	[required]

Return type

crate::models::DictionaryResponse

Authorization

token

HTTP request headers

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

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

list_dictionaries

List all dictionaries for the version of the service.

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

Parameters

Name	Type	Description	Required	Notes
service_id	String	Alphanumeric string identifying the service.	[required]
version_id	i32	Integer identifying a service version.	[required]

Return type

Vec<crate::models::DictionaryResponse>

Authorization

token

HTTP request headers

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

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

update_dictionary

Update named dictionary for a particular service and version.

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

Parameters

Name	Type	Description	Required	Notes
service_id	String	Alphanumeric string identifying the service.	[required]
version_id	i32	Integer identifying a service version.	[required]
dictionary_name	String	Name for the Dictionary (must start with an alphabetic character and can contain only alphanumeric characters, underscores, and whitespace).	[required]
name	Option<String>	Name for the Dictionary (must start with an alphabetic character and can contain only alphanumeric characters, underscores, and whitespace).
write_only	Option<bool>	Determines if items in the dictionary are readable or not.		[default to false]

Return type

crate::models::DictionaryResponse

Authorization

token

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: application/json

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