Skip to content

Latest commit

 

History

History
235 lines (174 loc) · 10.3 KB

RequestSettingsApi.md

File metadata and controls

235 lines (174 loc) · 10.3 KB
Raw

Fastly\Api\RequestSettingsApi

$apiInstance = new Fastly\Api\RequestSettingsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

Methods

Note

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

Method HTTP request Description
createRequestSettings() POST /service/{service_id}/version/{version_id}/request_settings Create a Request Settings object
deleteRequestSettings() DELETE /service/{service_id}/version/{version_id}/request_settings/{request_settings_name} Delete a Request Settings object
getRequestSettings() GET /service/{service_id}/version/{version_id}/request_settings/{request_settings_name} Get a Request Settings object
listRequestSettings() GET /service/{service_id}/version/{version_id}/request_settings List Request Settings objects
updateRequestSettings() PUT /service/{service_id}/version/{version_id}/request_settings/{request_settings_name} Update a Request Settings object

createRequestSettings()

createRequestSettings($options): \Fastly\Model\RequestSettingsResponse // Create a Request Settings object

Creates a new Request Settings object.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.

try {
    $result = $apiInstance->createRequestSettings($options);
} catch (Exception $e) {
    echo 'Exception when calling RequestSettingsApi->createRequestSettings: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int Integer identifying a service version.

Return type

\Fastly\Model\RequestSettingsResponse

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

deleteRequestSettings()

deleteRequestSettings($options): \Fastly\Model\InlineResponse200 // Delete a Request Settings object

Removes the specified Request Settings object.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['request_settings_name'] = 'request_settings_name_example'; // string | Name for the request settings.

try {
    $result = $apiInstance->deleteRequestSettings($options);
} catch (Exception $e) {
    echo 'Exception when calling RequestSettingsApi->deleteRequestSettings: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

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.

Return type

\Fastly\Model\InlineResponse200

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

getRequestSettings()

getRequestSettings($options): \Fastly\Model\RequestSettingsResponse // Get a Request Settings object

Gets the specified Request Settings object.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['request_settings_name'] = 'request_settings_name_example'; // string | Name for the request settings.

try {
    $result = $apiInstance->getRequestSettings($options);
} catch (Exception $e) {
    echo 'Exception when calling RequestSettingsApi->getRequestSettings: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

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.

Return type

\Fastly\Model\RequestSettingsResponse

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

listRequestSettings()

listRequestSettings($options): \Fastly\Model\RequestSettingsResponse[] // List Request Settings objects

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

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.

try {
    $result = $apiInstance->listRequestSettings($options);
} catch (Exception $e) {
    echo 'Exception when calling RequestSettingsApi->listRequestSettings: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int Integer identifying a service version.

Return type

\Fastly\Model\RequestSettingsResponse[]

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

updateRequestSettings()

updateRequestSettings($options): \Fastly\Model\RequestSettingsResponse // Update a Request Settings object

Updates the specified Request Settings object.

Example

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

try {
    $result = $apiInstance->updateRequestSettings($options);
} catch (Exception $e) {
    echo 'Exception when calling RequestSettingsApi->updateRequestSettings: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

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] [one of: 'lookup', 'pass']
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] [one of: 'clear', 'leave', 'append', 'append_all', 'overwrite']
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

\Fastly\Model\RequestSettingsResponse

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