Response object that includes a single WAF policy.
Expand All
Field
Type
Description
data
object
Object for a single WAF policy.
attributes
object
A WAF policy.
description [required]
string
Description of the WAF policy.
isDefault
boolean
Make this policy the default policy. The default policy is applied to
every service not specifically assigned to another policy.
name [required]
string
The name of the WAF policy.
protectionPresets
[string]
Presets enabled on this policy.
rules
[object]
Rule overrides applied by the policy.
blocking [required]
boolean
When blocking is enabled, the rule will block the traffic matched by this rule.
enabled [required]
boolean
When false, this rule will not match any traffic.
extended_data_collection
boolean
When true, collects additional data from the WAF for this rule.
id [required]
string
Override the parameters for this WAF rule identifier.
rulesets
[object]
DEPRECATED: Deprecated: Ruleset overrides. Use protectionPresets instead.
blocking [required]
boolean
When blocking is enabled, the ruleset will block the traffic it matches.
enabled [required]
boolean
When false, this ruleset will not match any traffic.
id [required]
string
The identifier of the ruleset to override.
scope
[object]
The scope of the WAF policy.
env [required]
string
The environment scope for the WAF policy.
service [required]
string
The service scope for the WAF policy.
version
int64
Version of the WAF ruleset maintained by Datadog used by this policy. 0 is the default value.
id
string
The ID of the policy.
meta
object
Metadata associated with the WAF policy.
added_at
date-time
The date and time the WAF policy was created.
added_by
string
The handle of the user who created the WAF policy.
added_by_name
string
The name of the user who created the WAF policy.
modified_at
date-time
The date and time the WAF policy was last updated.
modified_by
string
The handle of the user who last updated the WAF policy.
modified_by_name
string
The name of the user who last updated the WAF policy.
type
enum
The type of the resource. The value should always be policy.
Allowed enum values: policy
default: policy
{"data":{"attributes":{"description":"Policy applied to internal web applications.","isDefault":false,"name":"Internal Network Policy","protectionPresets":["attack-tools"],"rules":[{"blocking":false,"enabled":true,"extended_data_collection":false,"id":"rasp-001-002"}],"rulesets":[{"blocking":false,"enabled":true,"id":"attack_tool"}],"scope":[{"env":"prod","service":"billing-service"}],"version":0},"id":"2857c47d-1e3a-4300-8b2f-dc24089c084b","meta":{"added_at":"2021-01-01T00:00:00Z","added_by":"john.doe@datadoghq.com","added_by_name":"John Doe","modified_at":"2021-01-01T00:00:00Z","modified_by":"john.doe@datadoghq.com","modified_by_name":"John Doe"},"type":"policy"}}
"""
Get a WAF Policy returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.application_security_apiimportApplicationSecurityApi# there is a valid "policy" in the systemPOLICY_DATA_ID=environ["POLICY_DATA_ID"]configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=ApplicationSecurityApi(api_client)response=api_instance.get_application_security_waf_policy(policy_id=POLICY_DATA_ID,)print(response)
# Get a WAF Policy returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::ApplicationSecurityAPI.new# there is a valid "policy" in the systemPOLICY_DATA_ID=ENV["POLICY_DATA_ID"]papi_instance.get_application_security_waf_policy(POLICY_DATA_ID)
// Get a WAF Policy returns "OK" responsepackagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2")funcmain(){// there is a valid "policy" in the systemPolicyDataID:=os.Getenv("POLICY_DATA_ID")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewApplicationSecurityApi(apiClient)resp,r,err:=api.GetApplicationSecurityWafPolicy(ctx,PolicyDataID)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ApplicationSecurityApi.GetApplicationSecurityWafPolicy`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ApplicationSecurityApi.GetApplicationSecurityWafPolicy`:\n%s\n",responseContent)}
// Get a WAF Policy returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.ApplicationSecurityApi;importcom.datadog.api.client.v2.model.ApplicationSecurityPolicyResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ApplicationSecurityApiapiInstance=newApplicationSecurityApi(defaultClient);// there is a valid "policy" in the systemStringPOLICY_DATA_ID=System.getenv("POLICY_DATA_ID");try{ApplicationSecurityPolicyResponseresult=apiInstance.getApplicationSecurityWafPolicy(POLICY_DATA_ID);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ApplicationSecurityApi#getApplicationSecurityWafPolicy");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get a WAF Policy returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_application_security::ApplicationSecurityAPI;#[tokio::main]asyncfnmain(){// there is a valid "policy" in the system
letpolicy_data_id=std::env::var("POLICY_DATA_ID").unwrap();letconfiguration=datadog::Configuration::new();letapi=ApplicationSecurityAPI::with_config(configuration);letresp=api.get_application_security_waf_policy(policy_data_id.clone()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<API-KEY>"DD_APP_KEY="<APP-KEY>"cargo run
/**
* Get a WAF Policy returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.ApplicationSecurityApi(configuration);// there is a valid "policy" in the system
constPOLICY_DATA_ID=process.env.POLICY_DATA_IDasstring;constparams: v2.ApplicationSecurityApiGetApplicationSecurityWafPolicyRequest={policyId: POLICY_DATA_ID,};apiInstance.getApplicationSecurityWafPolicy(params).then((data: v2.ApplicationSecurityPolicyResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));