--- title: List standard patterns description: Returns all standard patterns. breadcrumbs: Docs > API > List standard patterns --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # List standard patterns ## v2 (latest) | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/sensitive-data-scanner/config/standard-patterns | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/sensitive-data-scanner/config/standard-patterns | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/sensitive-data-scanner/config/standard-patterns | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/sensitive-data-scanner/config/standard-patterns | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/sensitive-data-scanner/config/standard-patterns | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/sensitive-data-scanner/config/standard-patterns | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/sensitive-data-scanner/config/standard-patterns | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/sensitive-data-scanner/config/standard-patterns | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/sensitive-data-scanner/config/standard-patterns | ### Overview Returns all standard patterns. This endpoint requires the `data_scanner_read` permission. ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} List Standard patterns response data. | Parent field | Field | Type | Description | | ------------ | ---------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | [object] | List Standard patterns response. | | data | attributes | object | Attributes of the Sensitive Data Scanner standard pattern. | | attributes | description | string | Description of the standard pattern. | | attributes | included_keywords | [string] | List of included keywords. | | attributes | name | string | Name of the standard pattern. | | attributes | pattern | string | **DEPRECATED**: (Deprecated) Regex to match, optionally documented for older standard rules. Refer to the `description` field to understand what the rule does. | | attributes | priority | int64 | Integer from 1 (high) to 5 (low) indicating standard pattern issue severity. | | attributes | suppressions | object | Object describing suppressions for a rule, or the recommended suppression lists published by a standard pattern. There are three types of suppressions, `starts_with`, `ends_with`, and `exact_match`. Rules based on the Datadog library can use recommended or custom suppressions. Custom rules can only use custom suppressions. Suppressed matches are not obfuscated, counted in metrics, or displayed in the Findings page. | | suppressions | ends_with | [string] | List of strings to use for suppression of matches ending with these strings. | | suppressions | exact_match | [string] | List of strings to use for suppression of matches exactly matching these strings. | | suppressions | starts_with | [string] | List of strings to use for suppression of matches starting with these strings. | | suppressions | use_recommended_suppressions | boolean | Should the rule use the underlying standard pattern suppression configuration. If set to `true`, the rule must be tied to a standard pattern. If set to `false`, the specified suppressions are applied. | | attributes | tags | [string] | List of tags. | | data | id | string | ID of the standard pattern. | | data | type | enum | Sensitive Data Scanner standard pattern type. Allowed enum values: `sensitive_data_scanner_standard_pattern`. Default: `sensitive_data_scanner_standard_pattern`. | {% /tab %} {% tab label="Example" %} ```json { "data": [ { "attributes": { "description": "string", "included_keywords": [], "name": "string", "pattern": "string", "priority": "integer", "suppressions": { "ends_with": [ "@example.com", "another.example.com" ], "exact_match": [ "admin@example.com", "user@example.com" ], "starts_with": [ "admin", "user" ], "use_recommended_suppressions": false }, "tags": [] }, "id": "string", "type": "sensitive_data_scanner_standard_pattern" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Authentication Error {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v2/sensitive-data-scanner/config/standard-patterns" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // List standard patterns returns "OK" response package main import ( "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" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewSensitiveDataScannerApi(apiClient) resp, r, err := api.ListStandardPatterns(ctx) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SensitiveDataScannerApi.ListStandardPatterns`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `SensitiveDataScannerApi.ListStandardPatterns`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // List standard patterns returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.SensitiveDataScannerApi; import com.datadog.api.client.v2.model.SensitiveDataScannerStandardPatternsResponseData; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); SensitiveDataScannerApi apiInstance = new SensitiveDataScannerApi(defaultClient); try { SensitiveDataScannerStandardPatternsResponseData result = apiInstance.listStandardPatterns(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling SensitiveDataScannerApi#listStandardPatterns"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ List standard patterns returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.sensitive_data_scanner_api import SensitiveDataScannerApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = SensitiveDataScannerApi(api_client) response = api_instance.list_standard_patterns() print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # List standard patterns returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V2::SensitiveDataScannerAPI.new p api_instance.list_standard_patterns() ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // List standard patterns returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_sensitive_data_scanner::SensitiveDataScannerAPI; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = SensitiveDataScannerAPI::with_config(configuration); let resp = api.list_standard_patterns().await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * List standard patterns returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v2.SensitiveDataScannerApi(configuration); apiInstance .listStandardPatterns() .then((data: v2.SensitiveDataScannerStandardPatternsResponseData) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}