Update a restriction policy
https://api.datadoghq.com/api/v2/restriction_policy/{resource_id}https://api.us3.datadoghq.com/api/v2/restriction_policy/{resource_id}https://api.us5.datadoghq.com/api/v2/restriction_policy/{resource_id}https://api.datadoghq.eu/api/v2/restriction_policy/{resource_id}https://api.ap1.datadoghq.com/api/v2/restriction_policy/{resource_id}https://api.ap2.datadoghq.com/api/v2/restriction_policy/{resource_id}https://api.uk1.datadoghq.com/api/v2/restriction_policy/{resource_id}https://api.ddog-gov.com/api/v2/restriction_policy/{resource_id}https://api.us2.ddog-gov.com/api/v2/restriction_policy/{resource_id}Overview
Updates the restriction policy associated with a resource.
Supported resources
Restriction policies can be applied to the following resources:
- Dashboards:
dashboard - Integration Services:
integration-service - Integration Webhooks:
integration-webhook - Notebooks:
notebook - Powerpacks:
powerpack - Reference Tables:
reference-table - Security Rules:
security-rule - Service Level Objectives:
slo - Synthetic Global Variables:
synthetics-global-variable - Synthetic Tests:
synthetics-test - Synthetic Private Locations:
synthetics-private-location - Monitors:
monitor - Workflows:
workflow - App Builder Apps:
app-builder-app - Connections:
connection - Connection Groups:
connection-group - RUM Applications:
rum-application - Cross Org Connections:
cross-org-connection - Spreadsheets:
spreadsheet - On-Call Schedules:
on-call-schedule - On-Call Escalation Policies:
on-call-escalation-policy - On-Call Team Routing Rules:
on-call-team-routing-rules - Logs Pipelines:
logs-pipeline - Case Management Projects:
case-management-project - Monitor Notification Rules:
monitor-notification-rule - Status Pages:
status-page - Feature Flags:
feature-flag - Network Path Configs:
network-path-config
Supported relations for resources
| Resource Type | Supported Relations |
|---|---|
| Dashboards | viewer, editor |
| Integration Services | viewer, editor |
| Integration Webhooks | viewer, editor |
| Notebooks | viewer, editor |
| Powerpacks | viewer, editor |
| Security Rules | viewer, editor |
| Service Level Objectives | viewer, editor |
| Synthetic Global Variables | viewer, editor |
| Synthetic Tests | viewer, editor |
| Synthetic Private Locations | viewer, editor |
| Monitors | viewer, editor |
| Reference Tables | viewer, editor |
| Workflows | viewer, runner, editor |
| App Builder Apps | viewer, editor |
| Connections | viewer, resolver, editor |
| Connection Groups | viewer, editor |
| RUM Application | viewer, editor |
| Cross Org Connections | viewer, editor |
| Spreadsheets | viewer, editor |
| On-Call Schedules | viewer, overrider, editor |
| On-Call Escalation Policies | viewer, editor |
| On-Call Team Routing Rules | viewer, editor |
| Logs Pipelines | viewer, processors_editor, editor |
| Case Management Projects | viewer, contributor, manager |
| Monitor Notification Rules | viewer, editor |
| Status Pages | viewer, responder, manager |
| Feature Flags | viewer, contributor, editor |
| Network Path Configs | viewer, editor |
Arguments
Path Parameters
resource_id [required]Identifier, formatted as type:id. Supported types: dashboard, integration-service, integration-webhook, notebook, powerpack, reference-table, security-rule, slo, synthetics-global-variable, synthetics-test, synthetics-private-location, monitor, workflow, app-builder-app, connection, connection-group, rum-application, cross-org-connection, spreadsheet, on-call-schedule, on-call-escalation-policy, on-call-team-routing-rules, logs-pipeline, case-management-project, monitor-notification-rule, status-page, feature-flag, network-path-config.
Query Strings
allow_self_lockoutAllows admins (users with the user_access_manage permission) to remove their own access from the resource if set to true. By default, this is set to false, preventing admins from locking themselves out.
Request
Body Data (required)
Restriction policy payload
data [required]Restriction policy object.
attributes [required]Restriction policy attributes.
bindings [required]An array of bindings.
principals [required]An array of principals. A principal is a subject or group of subjects.
Each principal is formatted as type:id. Supported types: role, team, user, and org.
The org ID can be obtained through the api/v2/current_user API.
The user principal type accepts service account IDs.
relation [required]The role/level of access.
id [required]The identifier, always equivalent to the value specified in the resource_id path parameter.
type [required]Restriction policy type.
restriction_policyrestriction_policy{
"data": {
"attributes": {
"bindings": [
{
"principals": [
"user:4dee724d-00cc-11ea-a77b-570c9d03c6c5"
],
"relation": "editor"
}
]
},
"id": "dashboard:abc-def-ghi",
"type": "restriction_policy"
}
}Response
OK
Response containing information about a single restriction policy.
data [required]Restriction policy object.
attributes [required]Restriction policy attributes.
bindings [required]An array of bindings.
principals [required]An array of principals. A principal is a subject or group of subjects.
Each principal is formatted as type:id. Supported types: role, team, user, and org.
The org ID can be obtained through the api/v2/current_user API.
The user principal type accepts service account IDs.
relation [required]The role/level of access.
id [required]The identifier, always equivalent to the value specified in the resource_id path parameter.
type [required]Restriction policy type.
restriction_policyrestriction_policy{
"data": {
"attributes": {
"bindings": [
{
"principals": [
"role:00000000-0000-1111-0000-000000000000"
],
"relation": "editor"
}
]
},
"id": "dashboard:abc-def-ghi",
"type": "restriction_policy"
}
}Bad Request
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Not Authorized
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Code Example
# Path parameters
export resource_id="dashboard:abc-def-ghi"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/restriction_policy/${resource_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"bindings": [
{
"principals": [
"user:4dee724d-00cc-11ea-a77b-570c9d03c6c5"
],
"relation": "editor"
}
]
},
"id": "dashboard:abc-def-ghi",
"type": "restriction_policy"
}
}
EOF# Path parameters
export resource_id="dashboard:abc-def-ghi"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/restriction_policy/${resource_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"bindings": [
{
"principals": [
"user:4dee724d-00cc-11ea-a77b-570c9d03c6c5"
],
"relation": "editor"
}
]
},
"id": "dashboard:abc-def-ghi",
"type": "restriction_policy"
}
}
EOF# Path parameters
export resource_id="dashboard:abc-def-ghi"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/restriction_policy/${resource_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"bindings": [
{
"principals": [
"user:4dee724d-00cc-11ea-a77b-570c9d03c6c5"
],
"relation": "editor"
}
]
},
"id": "dashboard:abc-def-ghi",
"type": "restriction_policy"
}
}
EOF# Path parameters
export resource_id="dashboard:abc-def-ghi"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/restriction_policy/${resource_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"bindings": [
{
"principals": [
"user:4dee724d-00cc-11ea-a77b-570c9d03c6c5"
],
"relation": "editor"
}
]
},
"id": "dashboard:abc-def-ghi",
"type": "restriction_policy"
}
}
EOF# Path parameters
export resource_id="dashboard:abc-def-ghi"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/restriction_policy/${resource_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"bindings": [
{
"principals": [
"user:4dee724d-00cc-11ea-a77b-570c9d03c6c5"
],
"relation": "editor"
}
]
},
"id": "dashboard:abc-def-ghi",
"type": "restriction_policy"
}
}
EOF# Path parameters
export resource_id="dashboard:abc-def-ghi"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/restriction_policy/${resource_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"bindings": [
{
"principals": [
"user:4dee724d-00cc-11ea-a77b-570c9d03c6c5"
],
"relation": "editor"
}
]
},
"id": "dashboard:abc-def-ghi",
"type": "restriction_policy"
}
}
EOF# Path parameters
export resource_id="dashboard:abc-def-ghi"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/restriction_policy/${resource_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"bindings": [
{
"principals": [
"user:4dee724d-00cc-11ea-a77b-570c9d03c6c5"
],
"relation": "editor"
}
]
},
"id": "dashboard:abc-def-ghi",
"type": "restriction_policy"
}
}
EOF# Path parameters
export resource_id="dashboard:abc-def-ghi"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/restriction_policy/${resource_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"bindings": [
{
"principals": [
"user:4dee724d-00cc-11ea-a77b-570c9d03c6c5"
],
"relation": "editor"
}
]
},
"id": "dashboard:abc-def-ghi",
"type": "restriction_policy"
}
}
EOF# Path parameters
export resource_id="dashboard:abc-def-ghi"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/restriction_policy/${resource_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"bindings": [
{
"principals": [
"user:4dee724d-00cc-11ea-a77b-570c9d03c6c5"
],
"relation": "editor"
}
]
},
"id": "dashboard:abc-def-ghi",
"type": "restriction_policy"
}
}
EOF// Update a restriction policy 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 "user" in the system
body := datadogV2.RestrictionPolicyUpdateRequest{
Data: datadogV2.RestrictionPolicy{
Id: "dashboard:test-update",
Type: datadogV2.RESTRICTIONPOLICYTYPE_RESTRICTION_POLICY,
Attributes: datadogV2.RestrictionPolicyAttributes{
Bindings: []datadogV2.RestrictionPolicyBinding{
{
Relation: "editor",
Principals: []string{
"org:00000000-0000-beef-0000-000000000000",
},
},
},
},
},
}
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.NewRestrictionPoliciesApi(apiClient)
resp, r, err := api.UpdateRestrictionPolicy(ctx, "dashboard:test-update", body, *datadogV2.NewUpdateRestrictionPolicyOptionalParameters())
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RestrictionPoliciesApi.UpdateRestrictionPolicy`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `RestrictionPoliciesApi.UpdateRestrictionPolicy`:\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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"// Update a restriction policy returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RestrictionPoliciesApi;
import com.datadog.api.client.v2.model.RestrictionPolicy;
import com.datadog.api.client.v2.model.RestrictionPolicyAttributes;
import com.datadog.api.client.v2.model.RestrictionPolicyBinding;
import com.datadog.api.client.v2.model.RestrictionPolicyResponse;
import com.datadog.api.client.v2.model.RestrictionPolicyType;
import com.datadog.api.client.v2.model.RestrictionPolicyUpdateRequest;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
RestrictionPoliciesApi apiInstance = new RestrictionPoliciesApi(defaultClient);
// there is a valid "user" in the system
String USER_DATA_RELATIONSHIPS_ORG_DATA_ID =
System.getenv("USER_DATA_RELATIONSHIPS_ORG_DATA_ID");
RestrictionPolicyUpdateRequest body =
new RestrictionPolicyUpdateRequest()
.data(
new RestrictionPolicy()
.id("dashboard:test-update")
.type(RestrictionPolicyType.RESTRICTION_POLICY)
.attributes(
new RestrictionPolicyAttributes()
.bindings(
Collections.singletonList(
new RestrictionPolicyBinding()
.relation("editor")
.principals(
Collections.singletonList(
"org:00000000-0000-beef-0000-000000000000"))))));
try {
RestrictionPolicyResponse result =
apiInstance.updateRestrictionPolicy("dashboard:test-update", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RestrictionPoliciesApi#updateRestrictionPolicy");
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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java""""
Update a restriction policy returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.restriction_policies_api import RestrictionPoliciesApi
from datadog_api_client.v2.model.restriction_policy import RestrictionPolicy
from datadog_api_client.v2.model.restriction_policy_attributes import RestrictionPolicyAttributes
from datadog_api_client.v2.model.restriction_policy_binding import RestrictionPolicyBinding
from datadog_api_client.v2.model.restriction_policy_type import RestrictionPolicyType
from datadog_api_client.v2.model.restriction_policy_update_request import RestrictionPolicyUpdateRequest
# there is a valid "user" in the system
USER_DATA_RELATIONSHIPS_ORG_DATA_ID = environ["USER_DATA_RELATIONSHIPS_ORG_DATA_ID"]
body = RestrictionPolicyUpdateRequest(
data=RestrictionPolicy(
id="dashboard:test-update",
type=RestrictionPolicyType.RESTRICTION_POLICY,
attributes=RestrictionPolicyAttributes(
bindings=[
RestrictionPolicyBinding(
relation="editor",
principals=[
"org:00000000-0000-beef-0000-000000000000",
],
),
],
),
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
api_instance = RestrictionPoliciesApi(api_client)
response = api_instance.update_restriction_policy(resource_id="dashboard:test-update", body=body)
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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"# Update a restriction policy returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::RestrictionPoliciesAPI.new
# there is a valid "user" in the system
USER_DATA_RELATIONSHIPS_ORG_DATA_ID = ENV["USER_DATA_RELATIONSHIPS_ORG_DATA_ID"]
body = DatadogAPIClient::V2::RestrictionPolicyUpdateRequest.new({
data: DatadogAPIClient::V2::RestrictionPolicy.new({
id: "dashboard:test-update",
type: DatadogAPIClient::V2::RestrictionPolicyType::RESTRICTION_POLICY,
attributes: DatadogAPIClient::V2::RestrictionPolicyAttributes.new({
bindings: [
DatadogAPIClient::V2::RestrictionPolicyBinding.new({
relation: "editor",
principals: [
"org:00000000-0000-beef-0000-000000000000",
],
}),
],
}),
}),
})
p api_instance.update_restriction_policy("dashboard:test-update", body)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"// Update a restriction policy returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_restriction_policies::RestrictionPoliciesAPI;
use datadog_api_client::datadogV2::api_restriction_policies::UpdateRestrictionPolicyOptionalParams;
use datadog_api_client::datadogV2::model::RestrictionPolicy;
use datadog_api_client::datadogV2::model::RestrictionPolicyAttributes;
use datadog_api_client::datadogV2::model::RestrictionPolicyBinding;
use datadog_api_client::datadogV2::model::RestrictionPolicyType;
use datadog_api_client::datadogV2::model::RestrictionPolicyUpdateRequest;
#[tokio::main]
async fn main() {
// there is a valid "user" in the system
let body = RestrictionPolicyUpdateRequest::new(RestrictionPolicy::new(
RestrictionPolicyAttributes::new(vec![RestrictionPolicyBinding::new(
vec!["org:00000000-0000-beef-0000-000000000000".to_string()],
"editor".to_string(),
)]),
"dashboard:test-update".to_string(),
RestrictionPolicyType::RESTRICTION_POLICY,
));
let configuration = datadog::Configuration::new();
let api = RestrictionPoliciesAPI::with_config(configuration);
let resp = api
.update_restriction_policy(
"dashboard:test-update".to_string(),
body,
UpdateRestrictionPolicyOptionalParams::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" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run/**
* Update a restriction policy 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.RestrictionPoliciesApi(configuration);
// there is a valid "user" in the system
const params: v2.RestrictionPoliciesApiUpdateRestrictionPolicyRequest = {
body: {
data: {
id: "dashboard:test-update",
type: "restriction_policy",
attributes: {
bindings: [
{
relation: "editor",
principals: ["org:00000000-0000-beef-0000-000000000000"],
},
],
},
},
},
resourceId: "dashboard:test-update",
};
apiInstance
.updateRestrictionPolicy(params)
.then((data: v2.RestrictionPolicyResponse) => {
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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"