Skip to content

Latest commit

 

History

History
247 lines (176 loc) · 9.44 KB

WafFirewallVersionsApi.md

File metadata and controls

247 lines (176 loc) · 9.44 KB
Raw

Fastly\Api\WafFirewallVersionsApi

$apiInstance = new Fastly\Api\WafFirewallVersionsApi(
    // 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

Method Fastly API endpoint Description
cloneWafFirewallVersion() PUT /waf/firewalls/{firewall_id}/versions/{firewall_version_number}/clone Clone a firewall version
createWafFirewallVersion() POST /waf/firewalls/{firewall_id}/versions Create a firewall version
deployActivateWafFirewallVersion() PUT /waf/firewalls/{firewall_id}/versions/{firewall_version_number}/activate Deploy or activate a firewall version
getWafFirewallVersion() GET /waf/firewalls/{firewall_id}/versions/{firewall_version_number} Get a firewall version
listWafFirewallVersions() GET /waf/firewalls/{firewall_id}/versions List firewall versions
updateWafFirewallVersion() PATCH /waf/firewalls/{firewall_id}/versions/{firewall_version_number} Update a firewall version

cloneWafFirewallVersion()

cloneWafFirewallVersion($options): \Fastly\Model\WafFirewallVersionResponse // Clone a firewall version

Clone a specific, existing firewall version into a new, draft firewall version.

Example

    $options['firewall_id'] = 'firewall_id_example'; // string | Alphanumeric string identifying a WAF Firewall.
$options['firewall_version_number'] = 56; // int | Integer identifying a WAF firewall version.

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

Options

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

Name Type Description Notes
firewall_id string Alphanumeric string identifying a WAF Firewall.
firewall_version_number int Integer identifying a WAF firewall version.

Return type

\Fastly\Model\WafFirewallVersionResponse

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

createWafFirewallVersion()

createWafFirewallVersion($options): \Fastly\Model\WafFirewallVersionResponse // Create a firewall version

Create a new, draft firewall version.

Example

    $options['firewall_id'] = 'firewall_id_example'; // string | Alphanumeric string identifying a WAF Firewall.
$options['waf_firewall_version'] = {}; // \Fastly\Model\WafFirewallVersion

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

Options

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

Name Type Description Notes
firewall_id string Alphanumeric string identifying a WAF Firewall.
waf_firewall_version \Fastly\Model\WafFirewallVersion [optional]

Return type

\Fastly\Model\WafFirewallVersionResponse

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

deployActivateWafFirewallVersion()

deployActivateWafFirewallVersion($options): object // Deploy or activate a firewall version

Deploy or activate a specific firewall version. If a firewall has been disabled, deploying a firewall version will automatically enable the firewall again.

Example

    $options['firewall_id'] = 'firewall_id_example'; // string | Alphanumeric string identifying a WAF Firewall.
$options['firewall_version_number'] = 56; // int | Integer identifying a WAF firewall version.

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

Options

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

Name Type Description Notes
firewall_id string Alphanumeric string identifying a WAF Firewall.
firewall_version_number int Integer identifying a WAF firewall version.

Return type

object

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

getWafFirewallVersion()

getWafFirewallVersion($options): \Fastly\Model\WafFirewallVersionResponse // Get a firewall version

Get details about a specific firewall version.

Example

    $options['include'] = waf_firewall,waf_active_rules; // string | Include relationships. Optional, comma-separated values. Permitted values: `waf_firewall` and `waf_active_rules`.
$options['firewall_id'] = 'firewall_id_example'; // string | Alphanumeric string identifying a WAF Firewall.
$options['firewall_version_number'] = 56; // int | Integer identifying a WAF firewall version.

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

Options

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

Name Type Description Notes
include string Include relationships. Optional, comma-separated values. Permitted values: waf_firewall and waf_active_rules. [optional]
firewall_id string Alphanumeric string identifying a WAF Firewall.
firewall_version_number int Integer identifying a WAF firewall version.

Return type

\Fastly\Model\WafFirewallVersionResponse

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

listWafFirewallVersions()

listWafFirewallVersions($options): \Fastly\Model\WafFirewallVersionsResponse // List firewall versions

Get a list of firewall versions associated with a specific firewall.

Example

    $options['include'] = waf_firewall; // string | Include relationships. Optional.
$options['page_number'] = 1; // int | Current page.
$options['page_size'] = 20; // int | Number of records per page.
$options['firewall_id'] = 'firewall_id_example'; // string | Alphanumeric string identifying a WAF Firewall.

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

Options

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

Name Type Description Notes
include string Include relationships. Optional. [optional]
page_number int Current page. [optional]
page_size int Number of records per page. [optional] [defaults to 20]
firewall_id string Alphanumeric string identifying a WAF Firewall.

Return type

\Fastly\Model\WafFirewallVersionsResponse

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

updateWafFirewallVersion()

updateWafFirewallVersion($options): \Fastly\Model\WafFirewallVersionResponse // Update a firewall version

Update a specific firewall version.

Example

    $options['firewall_id'] = 'firewall_id_example'; // string | Alphanumeric string identifying a WAF Firewall.
$options['firewall_version_number'] = 56; // int | Integer identifying a WAF firewall version.
$options['waf_firewall_version'] = {"data":{"type":"waf_firewall_version","attributes":{"notice_anomaly_score":12}}}; // \Fastly\Model\WafFirewallVersion

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

Options

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

Name Type Description Notes
firewall_id string Alphanumeric string identifying a WAF Firewall.
firewall_version_number int Integer identifying a WAF firewall version.
waf_firewall_version \Fastly\Model\WafFirewallVersion [optional]

Return type

\Fastly\Model\WafFirewallVersionResponse

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