Client settings

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 Get-AccountSwitchKey.

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

The name of the rule format. The rule format can be frozen to a specific version, or represent the latest set of behaviors and criteria. You can retrieve rule formats with Get-RuleFormat.

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

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 true automatically. Otherwise, you can set the default value manually in your API client.

When enabled, the ID values in response data feature three-letter prefixes to indicate their type. You can set the PAPI-Use-Prefixes header to override the client's default for each request.