--- title: Create a restriction query description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Logs Restriction Queries --- # Create a restriction query{% #create-a-restriction-query %} Copy pageCopied {% tab title="v2" %} **Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/logs/config/restriction_queries | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/logs/config/restriction_queries | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/logs/config/restriction_queries | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/logs/config/restriction_queries | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/logs/config/restriction_queries | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/logs/config/restriction_queries | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/logs/config/restriction_queries | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/logs/config/restriction_queries | ### Overview Create a new restriction query for your organization. This endpoint requires the `user_access_manage` permission. ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ----------------------------------- | ------ | -------------------------------------------------------------------------------- | | | data | object | Data related to the creation of a restriction query. | | data | attributes | object | Attributes of the created restriction query. | | attributes | restriction_query [*required*] | string | The restriction query. | | data | type | enum | Restriction query resource type. Allowed enum values: `logs_restriction_queries` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "restriction_query": "env:sandbox" }, "type": "logs_restriction_queries" } } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing information about a single restriction query. | Parent field | Field | Type | Description | | ------------ | ------------------- | --------- | -------------------------------------------------------------------------------------------- | | | data | object | Restriction query object returned by the API. | | data | attributes | object | Attributes of the restriction query. | | attributes | created_at | date-time | Creation time of the restriction query. | | attributes | last_modifier_email | string | Email of the user who last modified this restriction query. | | attributes | last_modifier_name | string | Name of the user who last modified this restriction query. | | attributes | modified_at | date-time | Time of last restriction query modification. | | attributes | restriction_query | string | The query that defines the restriction. Only the content matching the query can be returned. | | attributes | role_count | int64 | Number of roles associated with this restriction query. | | attributes | user_count | int64 | Number of users associated with this restriction query. | | data | id | string | ID of the restriction query. | | data | type | string | Restriction queries type. | {% /tab %} {% tab title="Example" %} ```json { "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" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Authentication error {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/logs/config/restriction_queries" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "restriction_query": "env:sandbox" }, "type": "logs_restriction_queries" } } EOF ##### ```go // Create a restriction query 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() { body := datadogV2.RestrictionQueryCreatePayload{ Data: &datadogV2.RestrictionQueryCreateData{ Attributes: &datadogV2.RestrictionQueryCreateAttributes{ RestrictionQuery: "env:sandbox", }, Type: datadogV2.LOGSRESTRICTIONQUERIESTYPE_LOGS_RESTRICTION_QUERIES.Ptr(), }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.CreateRestrictionQuery", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewLogsRestrictionQueriesApi(apiClient) resp, r, err := api.CreateRestrictionQuery(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `LogsRestrictionQueriesApi.CreateRestrictionQuery`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `LogsRestrictionQueriesApi.CreateRestrictionQuery`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Create a restriction query 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.LogsRestrictionQueriesType; import com.datadog.api.client.v2.model.RestrictionQueryCreateAttributes; import com.datadog.api.client.v2.model.RestrictionQueryCreateData; import com.datadog.api.client.v2.model.RestrictionQueryCreatePayload; import com.datadog.api.client.v2.model.RestrictionQueryWithoutRelationshipsResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.createRestrictionQuery", true); LogsRestrictionQueriesApi apiInstance = new LogsRestrictionQueriesApi(defaultClient); RestrictionQueryCreatePayload body = new RestrictionQueryCreatePayload() .data( new RestrictionQueryCreateData() .attributes( new RestrictionQueryCreateAttributes().restrictionQuery("env:sandbox")) .type(LogsRestrictionQueriesType.LOGS_RESTRICTION_QUERIES)); try { RestrictionQueryWithoutRelationshipsResponse result = apiInstance.createRestrictionQuery(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling LogsRestrictionQueriesApi#createRestrictionQuery"); 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://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python """ Create a restriction query returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi from datadog_api_client.v2.model.logs_restriction_queries_type import LogsRestrictionQueriesType from datadog_api_client.v2.model.restriction_query_create_attributes import RestrictionQueryCreateAttributes from datadog_api_client.v2.model.restriction_query_create_data import RestrictionQueryCreateData from datadog_api_client.v2.model.restriction_query_create_payload import RestrictionQueryCreatePayload body = RestrictionQueryCreatePayload( data=RestrictionQueryCreateData( attributes=RestrictionQueryCreateAttributes( restriction_query="env:sandbox", ), type=LogsRestrictionQueriesType.LOGS_RESTRICTION_QUERIES, ), ) configuration = Configuration() configuration.unstable_operations["create_restriction_query"] = True with ApiClient(configuration) as api_client: api_instance = LogsRestrictionQueriesApi(api_client) response = api_instance.create_restriction_query(body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Create a restriction query returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.create_restriction_query".to_sym] = true end api_instance = DatadogAPIClient::V2::LogsRestrictionQueriesAPI.new body = DatadogAPIClient::V2::RestrictionQueryCreatePayload.new({ data: DatadogAPIClient::V2::RestrictionQueryCreateData.new({ attributes: DatadogAPIClient::V2::RestrictionQueryCreateAttributes.new({ restriction_query: "env:sandbox", }), type: DatadogAPIClient::V2::LogsRestrictionQueriesType::LOGS_RESTRICTION_QUERIES, }), }) p api_instance.create_restriction_query(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Create a restriction query returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_logs_restriction_queries::LogsRestrictionQueriesAPI; use datadog_api_client::datadogV2::model::LogsRestrictionQueriesType; use datadog_api_client::datadogV2::model::RestrictionQueryCreateAttributes; use datadog_api_client::datadogV2::model::RestrictionQueryCreateData; use datadog_api_client::datadogV2::model::RestrictionQueryCreatePayload; #[tokio::main] async fn main() { let body = RestrictionQueryCreatePayload::new().data( RestrictionQueryCreateData::new() .attributes(RestrictionQueryCreateAttributes::new( "env:sandbox".to_string(), )) .type_(LogsRestrictionQueriesType::LOGS_RESTRICTION_QUERIES), ); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.CreateRestrictionQuery", true); let api = LogsRestrictionQueriesAPI::with_config(configuration); let resp = api.create_restriction_query(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Create a restriction query returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.createRestrictionQuery"] = true; const apiInstance = new v2.LogsRestrictionQueriesApi(configuration); const params: v2.LogsRestrictionQueriesApiCreateRestrictionQueryRequest = { body: { data: { attributes: { restrictionQuery: "env:sandbox", }, type: "logs_restriction_queries", }, }, }; apiInstance .createRestrictionQuery(params) .then((data: v2.RestrictionQueryWithoutRelationshipsResponse) => { 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://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}