---
updatedAt: 2026-05-11T22:41:56.000Z
agentTools:
  siteIndex: https://techdocs.akamai.com/llms.txt
  projectIndex: https://techdocs.akamai.com/powershell/llms.txt
---

# Client settings

Set-PropertyClientSettings

## Synopsis

Update client settings.

## Syntax

```powershell
Set-PropertyClientSettings [-RuleFormat] <String> [-UsePrefixes] <Boolean> [[-UpgradeRules] <Boolean>] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## Description

Updates the current set of default values that apply to API clients keyed by the current authorization token.

You can use this function to disable the use of prefixes in the Property API, which is recommended.

## Parameters

<table>
  <tbody>
    <tr>
      <td class="ps-td"><code>&#8209;AccountSwitchKey</code></td> 
      <td class="ps-tableinner">
        <div class="ps-metadata">
          <span class="ps-param-metadata">String</span>
          <span class="ps-param-metadata">Pipeline input: False</span>
        </div>
        <div>
          <p>An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use <a href="https://techdocs.akamai.com/powershell/docs/get-accountswitchkey">Get-AccountSwitchKey</a>.</p>
        </div>
      </td>
    </tr>
    <tr>
      <td class="ps-td"><code>&#8209;EdgeRCFile</code></td> 
      <td class="ps-tableinner">
        <div class="ps-metadata">
          <span class="ps-param-metadata">String</span>
          <span class="ps-param-metadata">Pipeline input: False</span>
        </div>
        <div>
          <p>Your EdgeGrid resource file to authenticate your command. Defaults to <code>~/.edgerc</code>.</p>
        </div>
      </td>
    </tr>
    <tr>
      <td class="ps-td"><code>&#8209;RuleFormat</code><br/><span style="color: red; padding-left: 11px; font-size: 13px;"><em>Required</em></span></td> 
      <td class="ps-tableinner">
        <div class="ps-metadata">
          <span class="ps-param-metadata">String</span>
          <span class="ps-param-metadata">Pipeline input: False</span>
        </div>
        <div>
          <p>The name of the rule format. The rule format can be frozen to a specific version, or represent the <code>latest</code> set of behaviors and criteria. You can retrieve rule formats with <code>Get-RuleFormat</code>.</p>
        </div>
      </td>
    </tr>
    <tr>
      <td class="ps-td"><code>&#8209;Section</code></td> 
      <td class="ps-tableinner">
        <div class="ps-metadata">
          <span class="ps-param-metadata">String</span>
          <span class="ps-param-metadata">Pipeline input: False</span>
        </div>
        <div>
          <p>The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to <code>default</code>.</p>
        </div>
      </td>
    </tr>
    <tr>
      <td class="ps-td"><code>&#8209;UpgradeRules</code></td> 
      <td class="ps-tableinner">
        <div class="ps-metadata">
          <span class="ps-param-metadata">Boolean</span>
          <span class="ps-param-metadata">Pipeline input: False</span>
        </div>
        <div>
          <p>When this switch parameter is present, PAPI upgrades the input rule tree object to ensure backward compatibility. You can continuously use the latest rule format and keep working with your current rule tree without causing new validation errors as Akamai dynamically modifies catalog options. Upgrade applies renames, and transformations, fills in default values for new features, and removes extraneous options. New PAPI users have this set to <code>true</code> automatically. Otherwise, you can set the default value manually in your API client.</p>
        </div>
      </td>
    </tr>
    <tr>
      <td class="ps-td"><code>&#8209;UsePrefixes</code><br/><span style="color: red; padding-left: 11px; font-size: 13px;"><em>Required</em></span></td> 
      <td class="ps-tableinner">
        <div class="ps-metadata">
          <span class="ps-param-metadata">Boolean</span>
          <span class="ps-param-metadata">Pipeline input: False</span>
        </div>
        <div>
          <p>When enabled, the ID values in response data feature three-letter prefixes to indicate their type. You can set the <code>PAPI-Use-Prefixes</code> header to override the client's default for each request.</p>
        </div>
      </td>
    </tr>
  </tbody>
</table>

## Related Links

* [User Guide: Property](https://techdocs.akamai.com/powershell/docs/property-manager)
* [API Reference](https://techdocs.akamai.com/property-mgr/reference/put-client-settings)

# Sibling pages

* [Include rules](https://techdocs.akamai.com/powershell/docs/set-propertyincluderules.md)
* [Property hostname](https://techdocs.akamai.com/powershell/docs/set-propertyhostname.md)
* [Property rules](https://techdocs.akamai.com/powershell/docs/set-propertyrules.md)