--- title: Get a restriction query description: Get a restriction query in the organization specified by the restriction query's restriction_query_id. breadcrumbs: Docs > API > Get a restriction query --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/llms.txt). # Get a restriction query ## v2 (latest) {% alert level="warning" %} **Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help.md). {% /alert %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/logs/config/restriction_queries/{restriction_query_id} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/logs/config/restriction_queries/{restriction_query_id} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/logs/config/restriction_queries/{restriction_query_id} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/logs/config/restriction_queries/{restriction_query_id} | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/logs/config/restriction_queries/{restriction_query_id} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/logs/config/restriction_queries/{restriction_query_id} | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/logs/config/restriction_queries/{restriction_query_id} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/logs/config/restriction_queries/{restriction_query_id} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/logs/config/restriction_queries/{restriction_query_id} | ### Overview Get a restriction query in the organization specified by the restriction query's `restriction_query_id`. This endpoint requires the `logs_read_config` permission. ### Arguments #### Path Parameters | Field | Type | Description | | --------------------------------- | ------ | -------------------------------- | | restriction_query_id [*required*] | string | The ID of the restriction query. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="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. Read-only. | | attributes | last_modifier_email | string | Email of the user who last modified this restriction query. Read-only. | | attributes | last_modifier_name | string | Name of the user who last modified this restriction query. Read-only. | | attributes | modified_at | date-time | Time of last restriction query modification. Read-only. | | 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. Read-only. | | attributes | user_count | int64 | Number of users associated with this restriction query. Read-only. | | data | id | string | ID of the restriction query. | | data | relationships | object | Relationships of the user object. | | relationships | roles | object | Relationship to roles. | | roles | data | [object] | An array containing type and the unique identifier of a role. | | data | id | string | The unique identifier of the role. | | data | type | enum | Roles type. Allowed enum values: `roles`. Default: `roles`. | | data | type | enum | Restriction query resource type. Allowed enum values: `logs_restriction_queries`. Default: `logs_restriction_queries`. | | | included | [] | Array of objects related to the restriction query. | | included | | object | Partial role object. | | | attributes [*required*] | object | Attributes of the role for a restriction query. | | attributes | name | string | The role name. | | | id [*required*] | string | ID of the role. | | | type [*required*] | enum | Roles type. Allowed enum values: `roles`. Default: `roles`. | {% /tab %} {% tab label="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", "relationships": { "roles": { "data": [ { "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", "type": "roles" } ] } }, "type": "logs_restriction_queries" }, "included": [ { "attributes": { "name": "Datadog Admin Role" }, "id": "", "type": "roles" } ] } ``` {% /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="404" %} Not found {% 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 # Path parameters export restriction_query_id="CHANGE_ME" # 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/logs/config/restriction_queries/${restriction_query_id}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Get 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() { // there is a valid "restriction_query" in the system RestrictionQueryDataID := os.Getenv("RESTRICTION_QUERY_DATA_ID") ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.GetRestrictionQuery", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewLogsRestrictionQueriesApi(apiClient) resp, r, err := api.GetRestrictionQuery(ctx, RestrictionQueryDataID) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `LogsRestrictionQueriesApi.GetRestrictionQuery`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `LogsRestrictionQueriesApi.GetRestrictionQuery`:\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 // Get 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.RestrictionQueryWithRelationshipsResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); defaultClient.setUnstableOperationEnabled("v2.getRestrictionQuery", true); LogsRestrictionQueriesApi apiInstance = new LogsRestrictionQueriesApi(defaultClient); // there is a valid "restriction_query" in the system String RESTRICTION_QUERY_DATA_ID = System.getenv("RESTRICTION_QUERY_DATA_ID"); try { RestrictionQueryWithRelationshipsResponse result = apiInstance.getRestrictionQuery(RESTRICTION_QUERY_DATA_ID); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling LogsRestrictionQueriesApi#getRestrictionQuery"); 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 """ Get a restriction query returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.logs_restriction_queries_api import LogsRestrictionQueriesApi # there is a valid "restriction_query" in the system RESTRICTION_QUERY_DATA_ID = environ["RESTRICTION_QUERY_DATA_ID"] configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] configuration.unstable_operations["get_restriction_query"] = True with ApiClient(configuration) as api_client: api_instance = LogsRestrictionQueriesApi(api_client) response = api_instance.get_restriction_query( restriction_query_id=RESTRICTION_QUERY_DATA_ID, ) 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 # Get a restriction query returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] config.unstable_operations["v2.get_restriction_query".to_sym] = true end api_instance = DatadogAPIClient::V2::LogsRestrictionQueriesAPI.new # there is a valid "restriction_query" in the system RESTRICTION_QUERY_DATA_ID = ENV["RESTRICTION_QUERY_DATA_ID"] p api_instance.get_restriction_query(RESTRICTION_QUERY_DATA_ID) ``` #### 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 // Get a restriction query returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_logs_restriction_queries::LogsRestrictionQueriesAPI; #[tokio::main] async fn main() { // there is a valid "restriction_query" in the system let restriction_query_data_id = std::env::var("RESTRICTION_QUERY_DATA_ID").unwrap(); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.get_restriction_query", true); let api = LogsRestrictionQueriesAPI::with_config(configuration); let resp = api .get_restriction_query(restriction_query_data_id.clone()) .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 /** * Get a restriction query 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, }, }, }); configuration.unstableOperations["v2.getRestrictionQuery"] = true; const apiInstance = new v2.LogsRestrictionQueriesApi(configuration); // there is a valid "restriction_query" in the system const RESTRICTION_QUERY_DATA_ID = process.env .RESTRICTION_QUERY_DATA_ID as string; const params: v2.LogsRestrictionQueriesApiGetRestrictionQueryRequest = { restrictionQueryId: RESTRICTION_QUERY_DATA_ID, }; apiInstance .getRestrictionQuery(params) .then((data: v2.RestrictionQueryWithRelationshipsResponse) => { 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 %}