Skip to content

Latest commit

 

History

History
347 lines (254 loc) · 14.7 KB

WafActiveRulesApi.md

File metadata and controls

347 lines (254 loc) · 14.7 KB
Raw

Fastly\Api\WafActiveRulesApi

$apiInstance = new Fastly\Api\WafActiveRulesApi(
    // 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
bulkDeleteWafActiveRules() DELETE /waf/firewalls/{firewall_id}/versions/{version_id}/active-rules Delete multiple active rules from a WAF
bulkUpdateWafActiveRules() PATCH /waf/firewalls/{firewall_id}/versions/{version_id}/active-rules/bulk Update multiple active rules
createWafActiveRule() POST /waf/firewalls/{firewall_id}/versions/{version_id}/active-rules Add a rule to a WAF as an active rule
createWafActiveRulesTag() POST /waf/firewalls/{firewall_id}/versions/{version_id}/tags/{waf_tag_name}/active-rules Create active rules by tag
deleteWafActiveRule() DELETE /waf/firewalls/{firewall_id}/versions/{version_id}/active-rules/{waf_rule_id} Delete an active rule
getWafActiveRule() GET /waf/firewalls/{firewall_id}/versions/{version_id}/active-rules/{waf_rule_id} Get an active WAF rule object
listWafActiveRules() GET /waf/firewalls/{firewall_id}/versions/{version_id}/active-rules List active rules on a WAF
updateWafActiveRule() PATCH /waf/firewalls/{firewall_id}/versions/{version_id}/active-rules/{waf_rule_id} Update an active rule

bulkDeleteWafActiveRules()

bulkDeleteWafActiveRules($options) // Delete multiple active rules from a WAF

Delete many active rules on a particular firewall version using the active rule ID. Limited to 500 rules per request.

Example

    $options['firewall_id'] = 'firewall_id_example'; // string | Alphanumeric string identifying a WAF Firewall.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['request_body'] = {"data":[{"type":"waf_active_rule","id":"3krg2uUGZzb2W9Euo4moOR"}]}; // array<string,object>

try {
    $apiInstance->bulkDeleteWafActiveRules($options);
} catch (Exception $e) {
    echo 'Exception when calling WafActiveRulesApi->bulkDeleteWafActiveRules: ', $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.
version_id int Integer identifying a service version.
request_body array<string,object> [optional]

Return type

void (empty response body)

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

bulkUpdateWafActiveRules()

bulkUpdateWafActiveRules($options) // Update multiple active rules

Bulk update all active rules on a firewall version. This endpoint will not add new active rules, only update existing active rules.

Example

    $options['firewall_id'] = 'firewall_id_example'; // string | Alphanumeric string identifying a WAF Firewall.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['body'] = {"type":"waf_active_rule","attributes":{"revision":"latest"}}; // \Fastly\Model\WafActiveRuleData

try {
    $apiInstance->bulkUpdateWafActiveRules($options);
} catch (Exception $e) {
    echo 'Exception when calling WafActiveRulesApi->bulkUpdateWafActiveRules: ', $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.
version_id int Integer identifying a service version.
body \Fastly\Model\WafActiveRuleData [optional]

Return type

void (empty response body)

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

createWafActiveRule()

createWafActiveRule($options): \Fastly\Model\WafActiveRuleCreationResponse // Add a rule to a WAF as an active rule

Create an active rule for a particular firewall version.

Example

    $options['firewall_id'] = 'firewall_id_example'; // string | Alphanumeric string identifying a WAF Firewall.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['waf_active_rule'] = {"data":{"type":"waf_active_rule","attributes":{"status":"log"},"relationships":{"waf_rule_revision":{"data":[{"type":"waf_rule_revision","id":"r3Vg2uUGZzb2W9Euo4mo0R"}]}}}}; // \Fastly\Model\WafActiveRule

try {
    $result = $apiInstance->createWafActiveRule($options);
} catch (Exception $e) {
    echo 'Exception when calling WafActiveRulesApi->createWafActiveRule: ', $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.
version_id int Integer identifying a service version.
waf_active_rule \Fastly\Model\WafActiveRule [optional]

Return type

\Fastly\Model\WafActiveRuleCreationResponse

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

createWafActiveRulesTag()

createWafActiveRulesTag($options) // Create active rules by tag

Create active rules by tag. This endpoint will create active rules using the latest revision available for each rule.

Example

    $options['firewall_id'] = 'firewall_id_example'; // string | Alphanumeric string identifying a WAF Firewall.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['waf_tag_name'] = 'waf_tag_name_example'; // string | Name of the tag.
$options['waf_active_rule'] = {"data":{"type":"waf_active_rule","attributes":{"status":"log"}}}; // \Fastly\Model\WafActiveRule

try {
    $apiInstance->createWafActiveRulesTag($options);
} catch (Exception $e) {
    echo 'Exception when calling WafActiveRulesApi->createWafActiveRulesTag: ', $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.
version_id int Integer identifying a service version.
waf_tag_name string Name of the tag.
waf_active_rule \Fastly\Model\WafActiveRule [optional]

Return type

void (empty response body)

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

deleteWafActiveRule()

deleteWafActiveRule($options) // Delete an active rule

Delete an active rule for a particular firewall version.

Example

    $options['firewall_id'] = 'firewall_id_example'; // string | Alphanumeric string identifying a WAF Firewall.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['waf_rule_id'] = 'waf_rule_id_example'; // string | Alphanumeric string identifying a WAF rule.

try {
    $apiInstance->deleteWafActiveRule($options);
} catch (Exception $e) {
    echo 'Exception when calling WafActiveRulesApi->deleteWafActiveRule: ', $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.
version_id int Integer identifying a service version.
waf_rule_id string Alphanumeric string identifying a WAF rule.

Return type

void (empty response body)

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

getWafActiveRule()

getWafActiveRule($options): \Fastly\Model\WafActiveRuleResponse // Get an active WAF rule object

Get a specific active rule object. Includes details of the rule revision associated with the active rule object by default.

Example

    $options['include'] = waf_rule_revision,waf_firewall_version; // string | Include relationships. Optional, comma-separated values. Permitted values: `waf_rule_revision` and `waf_firewall_version`.
$options['firewall_id'] = 'firewall_id_example'; // string | Alphanumeric string identifying a WAF Firewall.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['waf_rule_id'] = 'waf_rule_id_example'; // string | Alphanumeric string identifying a WAF rule.

try {
    $result = $apiInstance->getWafActiveRule($options);
} catch (Exception $e) {
    echo 'Exception when calling WafActiveRulesApi->getWafActiveRule: ', $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_rule_revision and waf_firewall_version. [optional]
firewall_id string Alphanumeric string identifying a WAF Firewall.
version_id int Integer identifying a service version.
waf_rule_id string Alphanumeric string identifying a WAF rule.

Return type

\Fastly\Model\WafActiveRuleResponse

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

listWafActiveRules()

listWafActiveRules($options): \Fastly\Model\WafActiveRulesResponse // List active rules on a WAF

List all active rules for a particular firewall version.

Example

    $options['filter_status'] = 'filter_status_example'; // string | Limit results to active rules with the specified status.
$options['filter_waf_rule_revision_message'] = 'filter_waf_rule_revision_message_example'; // string | Limit results to active rules with the specified message.
$options['filter_waf_rule_revision_modsec_rule_id'] = 'filter_waf_rule_revision_modsec_rule_id_example'; // string | Limit results to active rules that represent the specified ModSecurity modsec_rule_id.
$options['filter_outdated'] = 'filter_outdated_example'; // string | Limit results to active rules referencing an outdated rule revision.
$options['include'] = waf_rule_revision,waf_firewall_version; // string | Include relationships. Optional, comma-separated values. Permitted values: `waf_rule_revision` and `waf_firewall_version`.
$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.
$options['version_id'] = 56; // int | Integer identifying a service version.

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

Options

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

Name Type Description Notes
filter_status string Limit results to active rules with the specified status. [optional]
filter_waf_rule_revision_message string Limit results to active rules with the specified message. [optional]
filter_waf_rule_revision_modsec_rule_id string Limit results to active rules that represent the specified ModSecurity modsec_rule_id. [optional]
filter_outdated string Limit results to active rules referencing an outdated rule revision. [optional]
include string Include relationships. Optional, comma-separated values. Permitted values: waf_rule_revision and waf_firewall_version. [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.
version_id int Integer identifying a service version.

Return type

\Fastly\Model\WafActiveRulesResponse

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

updateWafActiveRule()

updateWafActiveRule($options): \Fastly\Model\WafActiveRuleResponse // Update an active rule

Update an active rule's status for a particular firewall version.

Example

    $options['firewall_id'] = 'firewall_id_example'; // string | Alphanumeric string identifying a WAF Firewall.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['waf_rule_id'] = 'waf_rule_id_example'; // string | Alphanumeric string identifying a WAF rule.
$options['waf_active_rule'] = {"data":{"id":"3krg2uUGZzb2W9Euo4moOR","type":"waf_active_rule","attributes":{"status":"block"}}}; // \Fastly\Model\WafActiveRule

try {
    $result = $apiInstance->updateWafActiveRule($options);
} catch (Exception $e) {
    echo 'Exception when calling WafActiveRulesApi->updateWafActiveRule: ', $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.
version_id int Integer identifying a service version.
waf_rule_id string Alphanumeric string identifying a WAF rule.
waf_active_rule \Fastly\Model\WafActiveRule [optional]

Return type

\Fastly\Model\WafActiveRuleResponse

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