WebService::Fastly::RequestSettingsApi

Load the API package

use WebService::Fastly::Object::RequestSettingsApi;

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

Method | HTTP request | Description ------ | ------------ | ----------- create_request_settings | POST /service/{service_id}/version/{version_id}/request_settings | Create a Request Settings object delete_request_settings | DELETE /service/{service_id}/version/{version_id}/request_settings/{request_settings_name} | Delete a Request Settings object get_request_settings | GET /service/{service_id}/version/{version_id}/request_settings/{request_settings_name} | Get a Request Settings object list_request_settings | GET /service/{service_id}/version/{version_id}/request_settings | List Request Settings objects update_request_settings | PUT /service/{service_id}/version/{version_id}/request_settings/{request_settings_name} | Update a Request Settings object

create_request_settings

RequestSettingsResponse create_request_settings(service_id => $service_id, version_id => $version_id)

Create a Request Settings object

Creates a new Request Settings object.

Example

use Data::Dumper;
use WebService::Fastly::RequestSettingsApi;
my $api_instance = WebService::Fastly::RequestSettingsApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.

eval {
    my $result = $api_instance->create_request_settings(service_id => $service_id, version_id => $version_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RequestSettingsApi->create_request_settings: $@\n";
}

Parameters

Return type

RequestSettingsResponse

Authorization

token

HTTP request headers

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

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

delete_request_settings

InlineResponse200 delete_request_settings(service_id => $service_id, version_id => $version_id, request_settings_name => $request_settings_name)

Delete a Request Settings object

Removes the specified Request Settings object.

Example

use Data::Dumper;
use WebService::Fastly::RequestSettingsApi;
my $api_instance = WebService::Fastly::RequestSettingsApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $request_settings_name = "request_settings_name_example"; # string | Name for the request settings.

eval {
    my $result = $api_instance->delete_request_settings(service_id => $service_id, version_id => $version_id, request_settings_name => $request_settings_name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RequestSettingsApi->delete_request_settings: $@\n";
}

Parameters

Return type

InlineResponse200

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_request_settings

RequestSettingsResponse get_request_settings(service_id => $service_id, version_id => $version_id, request_settings_name => $request_settings_name)

Get a Request Settings object

Gets the specified Request Settings object.

Example

use Data::Dumper;
use WebService::Fastly::RequestSettingsApi;
my $api_instance = WebService::Fastly::RequestSettingsApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $request_settings_name = "request_settings_name_example"; # string | Name for the request settings.

eval {
    my $result = $api_instance->get_request_settings(service_id => $service_id, version_id => $version_id, request_settings_name => $request_settings_name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RequestSettingsApi->get_request_settings: $@\n";
}

Parameters

Return type

RequestSettingsResponse

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

list_request_settings

ARRAY[RequestSettingsResponse] list_request_settings(service_id => $service_id, version_id => $version_id)

List Request Settings objects

Returns a list of all Request Settings objects for the given service and version.

Example

use Data::Dumper;
use WebService::Fastly::RequestSettingsApi;
my $api_instance = WebService::Fastly::RequestSettingsApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.

eval {
    my $result = $api_instance->list_request_settings(service_id => $service_id, version_id => $version_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RequestSettingsApi->list_request_settings: $@\n";
}

Parameters

Return type

ARRAY[RequestSettingsResponse]

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

update_request_settings

RequestSettingsResponse update_request_settings(service_id => $service_id, version_id => $version_id, request_settings_name => $request_settings_name, action => $action, default_host => $default_host, hash_keys => $hash_keys, name => $name, request_condition => $request_condition, xff => $xff, bypass_busy_wait => $bypass_busy_wait, force_miss => $force_miss, force_ssl => $force_ssl, geo_headers => $geo_headers, max_stale_age => $max_stale_age, timer_support => $timer_support)

Update a Request Settings object

Updates the specified Request Settings object.

Example

use Data::Dumper;
use WebService::Fastly::RequestSettingsApi;
my $api_instance = WebService::Fastly::RequestSettingsApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $request_settings_name = "request_settings_name_example"; # string | Name for the request settings.
my $action = "action_example"; # string | Allows you to terminate request handling and immediately perform an action.
my $default_host = "default_host_example"; # string | Sets the host header.
my $hash_keys = "hash_keys_example"; # string | Comma separated list of varnish request object fields that should be in the hash key.
my $name = "name_example"; # string | Name for the request settings.
my $request_condition = "request_condition_example"; # string | Condition which, if met, will select this configuration during a request. Optional.
my $xff = "xff_example"; # string | Short for X-Forwarded-For.
my $bypass_busy_wait = 56; # int | Disable collapsed forwarding, so you don't wait for other objects to origin.
my $force_miss = 56; # int | Allows you to force a cache miss for the request. Replaces the item in the cache if the content is cacheable.
my $force_ssl = 56; # int | Forces the request use SSL (redirects a non-SSL to SSL).
my $geo_headers = 56; # int | Injects Fastly-Geo-Country, Fastly-Geo-City, and Fastly-Geo-Region into the request headers.
my $max_stale_age = 56; # int | How old an object is allowed to be to serve stale-if-error or stale-while-revalidate.
my $timer_support = 56; # int | Injects the X-Timer info into the request for viewing origin fetch durations.

eval {
    my $result = $api_instance->update_request_settings(service_id => $service_id, version_id => $version_id, request_settings_name => $request_settings_name, action => $action, default_host => $default_host, hash_keys => $hash_keys, name => $name, request_condition => $request_condition, xff => $xff, bypass_busy_wait => $bypass_busy_wait, force_miss => $force_miss, force_ssl => $force_ssl, geo_headers => $geo_headers, max_stale_age => $max_stale_age, timer_support => $timer_support);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RequestSettingsApi->update_request_settings: $@\n";
}

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. | version_id | int| Integer identifying a service version. | request_settings_name | string| Name for the request settings. | action | string| Allows you to terminate request handling and immediately perform an action. | [optional] default_host | string| Sets the host header. | [optional] hash_keys | string| Comma separated list of varnish request object fields that should be in the hash key. | [optional] name | string| Name for the request settings. | [optional] request_condition | string| Condition which, if met, will select this configuration during a request. Optional. | [optional] xff | string| Short for X-Forwarded-For. | [optional] bypass_busy_wait | int| Disable collapsed forwarding, so you don't wait for other objects to origin. | [optional] force_miss | int| Allows you to force a cache miss for the request. Replaces the item in the cache if the content is cacheable. | [optional] force_ssl | int| Forces the request use SSL (redirects a non-SSL to SSL). | [optional] geo_headers | int| Injects Fastly-Geo-Country, Fastly-Geo-City, and Fastly-Geo-Region into the request headers. | [optional] max_stale_age | int| How old an object is allowed to be to serve stale-if-error or stale-while-revalidate. | [optional] timer_support | int| Injects the X-Timer info into the request for viewing origin fetch durations. | [optional]

Return type

RequestSettingsResponse

Authorization

token

HTTP request headers

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

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

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)