Retrieve a list of execution policies for the current organization.
This endpoint requires the execution_groups_read permission.
Arguments
Query Strings
Name
Type
Description
page[size]
integer
The number of execution policies to return per page.
page[number]
integer
The page number to return.
filter[name]
string
Filter execution policies by name.
filter[ids]
array
Filter execution policies by a list of IDs.
filter[integration]
array
Filter execution policies by a list of integrations.
filter[effects]
array
Filter execution policies by a list of effects.
filter[creator_ids]
array
Filter execution policies by a list of creator IDs.
sort
array
The sort order for the results. Prefix a field with - to sort in
descending order. Valid fields are name, effect, integration,
created_at, and updated_at.
Response object that includes a list of execution policies.
Expand All
Field
Type
Description
data [required]
[object]
The execution policies.
attributes [required]
object
An execution policy.
action_pattern [required]
object
The set of actions this policy applies to.
action_fqns [required]
[string]
The fully qualified action names this policy matches. Use * to match all actions
of the integration, or a fully qualified name prefixed with the integration's action
namespace (for example com.datadoghq.script.* for the Script integration).
integration [required]
enum
The integration the action pattern applies to.
Allowed enum values: INTEGRATION_KUBERNETES,INTEGRATION_SCRIPT,INTEGRATION_REMOTE_ACTION
created_at [required]
date-time
The date and time the execution policy was created.
created_by [required]
string
The ID of the user who created the execution policy.
effect [required]
enum
Whether the policy allows or denies matching actions.
Allowed enum values: allow,deny
name [required]
string
The name of the execution policy.
scope
object
Restricts where the policy applies. At most one of kubernetes, scripts,
or remote_action_rshell can be set. An empty object means the policy has
no scope restriction.
kubernetes
object
Restricts the policy to specific Kubernetes namespaces.
rules [required]
[object]
The Kubernetes scope rules.
target_namespaces [required]
[string]
The Kubernetes namespaces this rule applies to.
remote_action_rshell
object
Restricts the policy to specific remote shell paths.
rules [required]
[object]
The remote shell scope rules.
access [required]
enum
The level of remote shell access granted for the target paths.
Allowed enum values: read_only,read_write
target_paths [required]
[string]
The file system paths this rule applies to.
scripts
object
Restricts the policy to specific scripts.
rules [required]
[object]
The script scope rules.
target_script_names [required]
[string]
The script names this rule applies to.
targets [required]
[object]
The targets this policy applies to.
agent_tags [required]
[string]
The Agent tags identifying the target.
name
string
A human-readable name for the target.
updated_at [required]
date-time
The date and time the execution policy was last updated.
updated_by [required]
string
The ID of the user who last updated the execution policy.
version [required]
int32
The version of the execution policy. Incremented on every update.
id [required]
string
The ID of the execution policy.
type [required]
enum
The type of the resource. The value should always be execution_policy.
Allowed enum values: execution_policy
default: execution_policy
meta [required]
object
Pagination metadata for the list of execution policies.
page [required]
object
Pagination details.
total [required]
int32
The total number of execution policies matching the query.
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<API-KEY>"DD_APP_KEY="<APP-KEY>"cargo run
/**
* List execution policies returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.listExecutionPolicies"]=true;constapiInstance=newv2.ExecutionPolicyApi(configuration);apiInstance.listExecutionPolicies().then((data: v2.ExecutionPolicyListResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));