Update a policy

put

https://{hostname}/etp-config/v3/configs/{configId}/policies/{policyId}

Modifies the specified policy.

Path Params

configId

integer

required

A unique identifier for the configuration.

policyId

integer

required

A unique identifier for the policy.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

The security policy to assign to a site. Configure the accepted use policy and set responses for known and suspected threats under the specified categories.

accessConfig

object

Provides access configuration details.

akamaiDefined

boolean

Marks a policy as Akamai-defined.

aupSettings

array of objects

required

length ≥ 0

Contains the acceptable use policy settings.

aupSettings*

aupSource

string

length ≥ 1

Name of acceptable use policy source for the policy.

authPolicy

object

Details of the authorization policy adopted for the policy.

authenticationMode

string

enum

Specifies the authentication mode. Either REQUIRED, OPTIONAL, or NONE.

Allowed:

avcSettings

object

Contains the AVC setting properties.

basicSettings

object

Contains the basic policy settings.

classifiers

object

Contains classifier details for a policy.

createdBy

string

length ≥ 1

Name of the user who created this policy.

customHeaders

array of objects

length ≥ 0

Lists the policy custom header settings.

customHeaders

customRequestHeaders

object

Lists the policy custom request header settings.

description

string

required

length ≥ 1

A description of the policy that you provide.

dlpExceptions

object

Lists the DLP exceptions for the policy.

dlpSettings

array of objects

length ≥ 0

Data loss prevention (DLP) actions and details.

dlpSettings

fWaasSettings

array of objects

length ≥ 0

Lists firewall as a service settings.

fWaasSettings

fileTypeSettings

array of objects

length ≥ 0

Lists the filetype settings for the policy.

fileTypeSettings

ipaSettings

object

Contains IPA settings.

modifiedBy

string

length ≥ 1

Name of the user who most recently modified this policy.

name

string

required

length ≥ 1

The name of the policy.

originPorts

array of strings

length ≥ 0

Lists origin ports for a policy.

originPorts

policyGeneralSettings

object

Specifies the policy's general settings.

proxyHostname

string

Name of proxy host machine.

riskyFileHandlingSettings

object

Describes file handling settings.

safeSearchSettings

object

Contains safe search settings.

securitySettings

array of objects

required

length ≥ 0

Contains the policy security settings.

securitySettings*

sites

array of integers

length ≥ 0

Contains associated site IDs.

sites

sitesInfo

array of objects

length ≥ 0

Contains data about associated sites.

sitesInfo

sublocationInfo

array of objects

length ≥ 0

Lists sublocation info.

sublocationInfo

sublocations

array of integers

length ≥ 0

Lists the sublocations configured for this policy.

sublocations

trafficLogging

object

Provides details of traffic logging in different modes.

Headers

If-Match

string

required

Use the x_etag value included in the GET response. See Concurrency control for details.

Responses

200

Successful response.

400Validation error.

401Authentication error. See Get started for help setting up your API token.

403Insufficient permissions See Get started for help setting up your API token.

404Configuration not Found.

412Precondition failed. Use the x_etag string returned in the response header as If-Match in write requests to avoid overwriting edits by any other API clients. See Concurrency control for details.