Note : This endpoint is in public beta.
If you have any feedback, contact Datadog support .
GET https://api.ap1.datadoghq.com/api/v2/logs/config/restriction_queries https://api.ap2.datadoghq.com/api/v2/logs/config/restriction_queries https://api.datadoghq.eu/api/v2/logs/config/restriction_queries https://api.ddog-gov.com/api/v2/logs/config/restriction_queries https://api.us2.ddog-gov.com/api/v2/logs/config/restriction_queries https://api.datadoghq.com/api/v2/logs/config/restriction_queries https://api.us3.datadoghq.com/api/v2/logs/config/restriction_queries https://api.us5.datadoghq.com/api/v2/logs/config/restriction_queries
Overview Returns all restriction queries, including their names and IDs.
This endpoint requires the logs_read_config permission.
Arguments Query Strings Size for a given page. The maximum allowed value is 100.
Specific page number to return.
Response OK
Response containing information about multiple restriction queries.
Expand All
Array of returned restriction queries.
Attributes of the restriction query.
Creation time of the restriction query.
Email of the user who last modified this restriction query.
Name of the user who last modified this restriction query.
Time of last restriction query modification.
The query that defines the restriction. Only the content matching the query can be returned.
Number of roles associated with this restriction query.
Number of users associated with this restriction query.
ID of the restriction query.
Restriction queries type.
default: logs_restriction_queries
{
"data" : [
{
"attributes" : {
"created_at" : "2020-03-17T21:06:44.000Z" ,
"last_modifier_email" : "user@example.com" ,
"last_modifier_name" : "John Doe" ,
"modified_at" : "2020-03-17T21:15:15.000Z" ,
"restriction_query" : "env:sandbox" ,
"role_count" : 3 ,
"user_count" : 5
},
"id" : "79a0e60a-644a-11ea-ad29-43329f7f58b5" ,
"type" : "logs_restriction_queries"
}
]
} Authentication error
{
"errors" : [
"Bad Request"
]
} Too many requests
{
"errors" : [
"Bad Request"
]
} Code Example Copy
# Curl command curl -X GET "https://api.ap1.datadoghq.com "https://api.ap2.datadoghq.com "https://api.datadoghq.eu "https://api.ddog-gov.com "https://api.us2.ddog-gov.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/logs/config/restriction_queries " \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} "
"""
List restriction queries returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi
configuration = Configuration ()
configuration . unstable_operations [ "list_restriction_queries" ] = True
with ApiClient ( configuration ) as api_client :
api_instance = LogsRestrictionQueriesApi ( api_client )
response = api_instance . list_restriction_queries ()
print ( response )
Instructions First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" python3 "example.py"
# List restriction queries returns "OK" response
require "datadog_api_client"
DatadogAPIClient . configure do | config |
config . unstable_operations [ "v2.list_restriction_queries" . to_sym ] = true
end
api_instance = DatadogAPIClient :: V2 :: LogsRestrictionQueriesAPI . new
p api_instance . list_restriction_queries ()
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" rb "example.rb"
// List restriction queries 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 ())
configuration := datadog . NewConfiguration ()
configuration . SetUnstableOperationEnabled ( "v2.ListRestrictionQueries" , true )
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewLogsRestrictionQueriesApi ( apiClient )
resp , r , err := api . ListRestrictionQueries ( ctx , * datadogV2 . NewListRestrictionQueriesOptionalParameters ())
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `LogsRestrictionQueriesApi.ListRestrictionQueries`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `LogsRestrictionQueriesApi.ListRestrictionQueries`:\n%s\n" , responseContent )
}
Instructions First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" go run "main.go"
// List restriction queries returns "OK" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.LogsRestrictionQueriesApi ;
import com.datadog.api.client.v2.model.RestrictionQueryListResponse ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
defaultClient . setUnstableOperationEnabled ( "v2.listRestrictionQueries" , true );
LogsRestrictionQueriesApi apiInstance = new LogsRestrictionQueriesApi ( defaultClient );
try {
RestrictionQueryListResponse result = apiInstance . listRestrictionQueries ();
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling LogsRestrictionQueriesApi#listRestrictionQueries" );
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 and then save the example to Example.java and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" java "Example.java"
// List restriction queries returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_logs_restriction_queries ::ListRestrictionQueriesOptionalParams ;
use datadog_api_client ::datadogV2 ::api_logs_restriction_queries ::LogsRestrictionQueriesAPI ;
#[tokio::main]
async fn main () {
let mut configuration = datadog ::Configuration ::new ();
configuration . set_unstable_operation_enabled ( "v2.ListRestrictionQueries" , true );
let api = LogsRestrictionQueriesAPI ::with_config ( configuration );
let resp = api
. list_restriction_queries ( ListRestrictionQueriesOptionalParams ::default ())
. await ;
if let Ok ( value ) = resp {
println! ( " {:#?} " , value );
} else {
println! ( " {:#?} " , resp . unwrap_err ());
}
}
Instructions First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" cargo run
/**
* List restriction queries returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
configuration . unstableOperations [ "v2.listRestrictionQueries" ] = true ;
const apiInstance = new v2 . LogsRestrictionQueriesApi ( configuration );
apiInstance
. listRestrictionQueries ()
. then (( data : v2.RestrictionQueryListResponse ) => {
console . log (
"API called successfully. Returned data: " + JSON . stringify ( data )
);
})
. catch (( error : any ) => console . error ( error ));
Instructions First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" tsc "example.ts"