# Update Settings

<figure><img src="/files/L5O6dX6A7R87qCYdSoU7" alt=""><figcaption></figcaption></figure>

Use **Update Settings** policies to centrally push configuration to endpoints (most commonly plugin configuration), without manually editing files on each machine.

## What this Policy is For

* Rolling out standardized **plugin settings**
* Updating agent-side configuration consistently across a deployment

## How it Works

Agents run a configuration processor job (often named **Process Configuration Policies**) which finds policies with `PolicyType` **`"SettingsUpdate"`** and writes the provided JSON to the appropriate location.

**Important behavior:** for plugin files, the processor **replaces the entire file** with `Extension.SettingsJson` (not a merge).

## Step-by-step: Create an Update Settings policy (via Advanced JSON)

{% stepper %}
{% step %}
**Navigate to Endpoint Privilege Manager → Policies**

<figure><img src="/files/1zuqW2iuxE0cYlLMK4G6" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Click Create Policy Button**

This will spawn the Create Policy modal form.

<figure><img src="/files/saENuE4ERTA0qZavFS7f" alt="" width="375"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Define Policy Attributes**

Choose a aptly discriptive name for your new policy.

Choose **any existing policy type available in the UI** for your new policy(this is just a starting template since Update Settings is set in JSON).

Choose a status for your new policy. We recommend monitor mode when initially setting up a policy.

Add one or more Controls by clicking on the "Add Control" button and then selecting the controls that you would like to see applied to your new policy.

Choose a User Group, a Machine Collection, and an Application Collection.
{% endstep %}

{% step %}
**Configure Policy Targeting**

Configure any **targeting** you want in the UI (collections/users/machines/apps/platforms). Who or What does your policy apply to?
{% endstep %}

{% step %}
**Open the Policy’s Advanced Mode (JSON view)**

To open the Policy's Advanced Mode, click on the "Advanced Mode" link in the bottom left corner of the Policy Form.

<figure><img src="/files/cEuE5nTSh76oKvHbGB4q" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Redefine Policy Type in JSON**

Set: `PolicyType` to **`"SettingsUpdate"`**
{% endstep %}

{% step %}
**Define Extension Fields**

Set: `Extension` fields as described in the [Required JSON Fields](#required-json-fields) section of this document
{% endstep %}

{% step %}
**Save the Policy**
{% endstep %}
{% endstepper %}

## Required JSON Fields

Set `PolicyType` and include an `Extension` object with **either** `PluginName` **or** `TargetFile`, plus `SettingsJson`.

### Option A (recommended): Update a plugin by name

* `Extension.PluginName` = plugin name (targets that plugin’s JSON)
* `Extension.SettingsJson` = **full plugin JSON** as a **string**
* `Extension.Action` = `Update` or `Add` (as used in your implementation)

### Option B (advanced): Update a file by path

* `Extension.TargetFile` = file path (e.g., `Plugins/KeeperPolicy.json`)
* `Extension.SettingsJson` = **full file contents** as a **string**
* `Extension.Action` = `Update` or `Add`

## Example JSON Snippet

### Example (TargetFile)

```
"PolicyType": "SettingsUpdate",
"Extension": {
  "TargetFile": "Plugins/KeeperPolicy.json",
  "Action": "Update",
  "SettingsJson": "{ ...full plugin json... }"
}
```

**Important:** `SettingsJson` must contain the **entire** plugin JSON, because the processor replaces the whole file.

## Validate on an endpoint

1. Ensure the endpoint is in scope for targeting.
2. Run/trigger the job that processes configuration policies.
3. Confirm the target plugin JSON file (or target file) was updated.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.keeper.io/keeperpam/endpoint-privilege-manager/policies/policy-types/advanced-policy-types/update-settings-policy-type.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
