API
Start typing to search…

Get a policy

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

Returns the details of a policy.

Path Params
integer
required

A unique identifier for the configuration.

integer
required

A unique identifier for the policy.

Query Params
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.

Headers
string
required

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

Responses

Response body
object
accessConfig
object

Provides access configuration details.

boolean
required

Marks a policy as configurable.

delegatedAdmins
array of strings
required
length ≥ 0

A list of delegated administrators for the policy.

delegatedAdmins*
boolean
required

Marks a policy as readable.

boolean

Marks a policy as Akamai-defined.

aupSettings
array of objects
required
length ≥ 0

Contains the acceptable use policy settings.

aupSettings*
object
integer
required
≥ 1

Read-only A unique identifier for the category.

categoryInfo
object

AUP category data.

groups
array of strings
length ≥ 0

List of groups users belong to.

groups
operationSettings
array of objects
length ≥ 0

Describes the operation settings on the AUP setting.

operationSettings
object
integer
≥ 0

The AVC application count.

integer
≥ 1

Read-only Unique identifier for the AVC category.

categoryInfo
object

AVC category details.

boolean

Deprecates the AVC entity.

string
length ≥ 1

Describes the AVC entity.

devicePostureRiskTiers
array of strings
length ≥ 0

The selected device posture risk tiers.

devicePostureRiskTiers
boolean

Specifies a domain-based AVC entity.

string
length ≥ 1

The filetype category based on MIME type. Either message, application, audio, video, image, text, model, or x-epoc.
Use x-epoc for Symbian Series 3 install packages.

message application audio video image text model x-epoc

groups
array of strings
required
length ≥ 0

List of user groups for the AVC categories.

groups*
integer
required
≥ 1

Unique identifier for the AVC entity.

string
required
length ≥ 1

Name of the AVC entity.

operationSettings
array of objects
required
length ≥ 0

List of AVC operation settings with details.

operationSettings*
object
response
object

AVC response details.

integer
required
≥ 1

Read-only Response ID of the AVC entity.

responseInfo
object

Contains data for the response.

responseOverrides
array of objects
required
length ≥ 0

List of AUP response overrides with details.

responseOverrides*
object
groupIds
array of strings
required
length ≥ 0

List of user groups for the AVC categories.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

List of AVC users for the AVC entity.

userIds*
risk
object

AVC risk details.

Has additional fields
string
length ≥ 1

The file type.

users
array of strings
required
length ≥ 0

List of AVC users for the AVC entity.

users*
integer
≥ 1

Unique identifier for the vendor app.

integer
required
≥ 1

Read-only A unique identifier for the response.

responseInfo
object

Contains data for the response.

responseOverrides
array of objects
length ≥ 0

A list of response overrides.

responseOverrides
object
integer
required
≥ 1

Read-only A unique identifier for the response.

string
required
length ≥ 1

The name of a response.

users
array of strings
length ≥ 0

Lists user emails assigned to the policy.

users
string
length ≥ 1

Name of acceptable use policy source for the policy.

authPolicy
object

Details of the authorization policy adopted for the policy.

Oidc
object
required

Provides OpenID Connect (OIDC) provider and client details.

boolean
required

Allows unauthenticated users.

boolean
required

Enables an authorization policy.

integer
required
≥ 1

Read-only A unique identifier for the authorization policy.

boolean
required

Indicates IDP pre-authorization consent.

integer
required
≥ 0

The number of retries for an unauthenticated session.

integer
required
≥ 0

The duration of a session.

date-time
required

Read-only ISO 8601 timestamp marking the last user authentication refresh.

string

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

REQUIRED OPTIONAL NONE

avcSettings
object

Contains the AVC setting properties.

applicationSettings
array of objects
required
length ≥ 0

Policy metadata with details.

applicationSettings*
object
integer
≥ 0

The AVC application count.

integer
≥ 1

Read-only Unique identifier for the AVC category.

categoryInfo
object

AVC category details.

boolean

Deprecates the AVC entity.

string
length ≥ 1

Describes the AVC entity.

devicePostureRiskTiers
array of strings
length ≥ 0

The selected device posture risk tiers.

devicePostureRiskTiers
boolean

Specifies a domain-based AVC entity.

string
length ≥ 1

The filetype category based on MIME type. Either message, application, audio, video, image, text, model, or x-epoc.
Use x-epoc for Symbian Series 3 install packages.

message application audio video image text model x-epoc

groups
array of strings
required
length ≥ 0

List of user groups for the AVC categories.

groups*
integer
required
≥ 1

Unique identifier for the AVC entity.

string
required
length ≥ 1

Name of the AVC entity.

operationSettings
array of objects
required
length ≥ 0

List of AVC operation settings with details.

operationSettings*
object
response
object

AVC response details.

integer
required
≥ 1

Read-only Response ID of the AVC entity.

responseInfo
object

Contains data for the response.

responseOverrides
array of objects
required
length ≥ 0

List of AUP response overrides with details.

responseOverrides*
object
groupIds
array of strings
required
length ≥ 0

List of user groups for the AVC categories.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

List of AVC users for the AVC entity.

userIds*
risk
object

AVC risk details.

Has additional fields
string
length ≥ 1

The file type.

users
array of strings
required
length ≥ 0

List of AVC users for the AVC entity.

users*
integer
≥ 1

Unique identifier for the vendor app.

categorySettings
array of objects
required
length ≥ 0

Lists the AVC category setting properties.

categorySettings*
object
integer
required
≥ 1

Read-only A unique identifier for the category.

categoryInfo
object
required

Contains data for a category.

string
required
length ≥ 1

Description for the category settings.

groups
array of strings
required
length ≥ 0

List of groups that users belong to.

groups*
operationSettings
array of objects
required
length ≥ 0

Policy metadata with details.

operationSettings*
object
integer
≥ 0

The AVC application count.

integer
≥ 1

Read-only Unique identifier for the AVC category.

categoryInfo
object

AVC category details.

boolean

Deprecates the AVC entity.

string
length ≥ 1

Describes the AVC entity.

devicePostureRiskTiers
array of strings
length ≥ 0

The selected device posture risk tiers.

devicePostureRiskTiers
boolean

Specifies a domain-based AVC entity.

string
length ≥ 1

The filetype category based on MIME type. Either message, application, audio, video, image, text, model, or x-epoc.
Use x-epoc for Symbian Series 3 install packages.

message application audio video image text model x-epoc

groups
array of strings
required
length ≥ 0

List of user groups for the AVC categories.

groups*
integer
required
≥ 1

Unique identifier for the AVC entity.

string
required
length ≥ 1

Name of the AVC entity.

operationSettings
array of objects
required
length ≥ 0

List of AVC operation settings with details.

operationSettings*
object
response
object

AVC response details.

integer
required
≥ 1

Read-only Response ID of the AVC entity.

responseInfo
object

Contains data for the response.

responseOverrides
array of objects
required
length ≥ 0

List of AUP response overrides with details.

responseOverrides*
object
groupIds
array of strings
required
length ≥ 0

List of user groups for the AVC categories.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

List of AVC users for the AVC entity.

userIds*
risk
object

AVC risk details.

Has additional fields
string
length ≥ 1

The file type.

users
array of strings
required
length ≥ 0

List of AVC users for the AVC entity.

users*
integer
≥ 1

Unique identifier for the vendor app.

response
object
required

Contains response data.

integer
required
≥ 1

Read-only A unique identifier for the response.

responseOverrides
array of objects
required
length ≥ 0

A list of response overrides.

responseOverrides*
object
integer
required
≥ 1

Read-only A unique identifier for the response.

string
required
length ≥ 1

The name of a response.

users
array of strings
required
length ≥ 0

Specifies user emails assigned to the policy.

users*
riskSettings
array of objects
required
length ≥ 0

Policy metadata with details.

riskSettings*
object
integer
≥ 0

The AVC application count.

integer
≥ 1

Read-only Unique identifier for the AVC category.

categoryInfo
object

AVC category details.

boolean

Deprecates the AVC entity.

string
length ≥ 1

Describes the AVC entity.

devicePostureRiskTiers
array of strings
length ≥ 0

The selected device posture risk tiers.

devicePostureRiskTiers
boolean

Specifies a domain-based AVC entity.

string
length ≥ 1

The filetype category based on MIME type. Either message, application, audio, video, image, text, model, or x-epoc.
Use x-epoc for Symbian Series 3 install packages.

message application audio video image text model x-epoc

groups
array of strings
required
length ≥ 0

List of user groups for the AVC categories.

groups*
integer
required
≥ 1

Unique identifier for the AVC entity.

string
required
length ≥ 1

Name of the AVC entity.

operationSettings
array of objects
required
length ≥ 0

List of AVC operation settings with details.

operationSettings*
object
response
object

AVC response details.

integer
required
≥ 1

Read-only Response ID of the AVC entity.

responseInfo
object

Contains data for the response.

responseOverrides
array of objects
required
length ≥ 0

List of AUP response overrides with details.

responseOverrides*
object
groupIds
array of strings
required
length ≥ 0

List of user groups for the AVC categories.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

List of AVC users for the AVC entity.

userIds*
risk
object

AVC risk details.

Has additional fields
string
length ≥ 1

The file type.

users
array of strings
required
length ≥ 0

List of AVC users for the AVC entity.

users*
integer
≥ 1

Unique identifier for the vendor app.

basicSettings
object

Contains the basic policy settings.

boolean
required

When enabled, provides DNS security.

boolean
required

When enabled, optimizes CDN traffic using the EDNS-Client-Subnet extension.

boolean

Enables the forward proxy.

boolean

Enables the proxy.

boolean

Enables the safe search feature.

boolean

Enables trust of X-Forwarded-For headers.

classifiers
object

Contains classifier details for a policy.

boolean
required

Enables dynamic analysis for a classifier.

boolean
required

Enables the classifier.

string
required
length ≥ 1

Name of the classifier.

integer
required
≥ 0

The size exceeded action.

boolean
required

Enables Zero-Day Phishing (ZDP) protection for a classifier.

string
length ≥ 1

Name of the user who created this policy.

date-time

Read-only ISO 8601 timestamp marking this policy's creation.

customHeaders
array of objects
length ≥ 0

Lists the policy custom header settings.

customHeaders
object
integer
required
≥ 1

Read-only The custom header ID.

domains
array of strings
required
length ≥ 0

Lists the domains assigned the custom header.

domains*
string
required
length ≥ 1

Name of the custom header.

string
required
length ≥ 1

Custom header value.

customRequestHeaders
object

Lists the policy custom request header settings.

args
array of arrays of strings
required
length ≥ 0

Lists custom request header arguments.

args*
array of strings
integer
required
≥ 1

Read-only The custom request header ID.

string
required
length ≥ 1

The target domain for the custom request headers.

string
required
length ≥ 1

A description of the policy that you provide.

dlpExceptions
object

Lists the DLP exceptions for the policy.

groups
array of strings
required
length ≥ 0

List of groups that users belong to.

groups*
users
array of strings
required
length ≥ 0

Specifies user emails assigned to the policy.

users*
dlpSettings
array of objects
length ≥ 0

List of data loss prevention (DLP) actions and details.

dlpSettings
object
integer
required
≥ 0

Action ID for the data loss prevention (DLP) dictionary.

integer
required
≥ 1

Read-only A unique identifier for the DLP dictionary.

string
required
length ≥ 1

Name of the DLP dictionary.

string
required
length ≥ 1

Name of the DLP dictionary source.

patterns
array of integers
required
length ≥ 0

List of data loss prevention (DLP) patterns to match.

patterns*
integer
required
≥ 0

The maximum number of DLP patterns to consider.

fWaasSettings
array of objects
length ≥ 0

Lists firewall as a service settings.

fWaasSettings
object
appIds
array of integers
required
length ≥ 0

Lists app IDs.

appIds*
countryCodeInfo
array of objects
required
length ≥ 0

Lists country code info.

countryCodeInfo*
object
string
required
length ≥ 1

The ISO 3166 two-letter code for the region.

string
required
length ≥ 1

The ISO 3166 three-letter code for the region.

string
required
length ≥ 1

Name of the firewall service.

countryCodes
array of strings
required
length ≥ 0

Lists country codes.

countryCodes*
destinationIp
array of strings
required
length ≥ 0

Lists destination IPs.

destinationIp*
boolean
required

Enables the service.

integer
required
≥ 1

Unique identifier for the firewall as service.

string
required
length ≥ 1

Name of the service.

networkServiceIds
array of integers
required
length ≥ 0

Lists network service IDs.

networkServiceIds*
networkServiceInfo
array of objects
required
length ≥ 0

Lists network service info details.

networkServiceInfo*
object
string
required
length ≥ 1

Name of the firewall as a service.

integer
required
≥ 1

Read-only Unique identifier for the firewall service.

string
required
length ≥ 1

The port used by the firewall service.

string
required

Indicates the protocol used by firewall service, either tcp, udp, or both.

tcp udp both

string
required
length ≥ 1

Name of the Firewall as a Service.

nonWebAppInfo
array of objects
required
length ≥ 0

Lists non-web-app info.

nonWebAppInfo*
object
integer
≥ 0

The AVC application count.

integer
≥ 1

Read-only Unique identifier for the AVC category.

categoryInfo
object

AVC category details.

boolean

Deprecates the AVC entity.

string
length ≥ 1

Describes the AVC entity.

devicePostureRiskTiers
array of strings
length ≥ 0

The selected device posture risk tiers.

devicePostureRiskTiers
boolean

Specifies a domain-based AVC entity.

string
length ≥ 1

The filetype category based on MIME type. Either message, application, audio, video, image, text, model, or x-epoc.
Use x-epoc for Symbian Series 3 install packages.

message application audio video image text model x-epoc

groups
array of strings
required
length ≥ 0

List of user groups for the AVC categories.

groups*
integer
required
≥ 1

Unique identifier for the AVC entity.

string
required
length ≥ 1

Name of the AVC entity.

operationSettings
array of objects
required
length ≥ 0

List of AVC operation settings with details.

operationSettings*
object
response
object

AVC response details.

integer
required
≥ 1

Read-only Response ID of the AVC entity.

responseInfo
object

Contains data for the response.

responseOverrides
array of objects
required
length ≥ 0

List of AUP response overrides with details.

responseOverrides*
object
groupIds
array of strings
required
length ≥ 0

List of user groups for the AVC categories.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

List of AVC users for the AVC entity.

userIds*
risk
object

AVC risk details.

Has additional fields
string
length ≥ 1

The file type.

users
array of strings
required
length ≥ 0

List of AVC users for the AVC entity.

users*
integer
≥ 1

Unique identifier for the vendor app.

ports
array of strings
required
length ≥ 0

Lists ports.

ports*
string
required

Describes the protocol used by service, either tcp, udp, or both.

tcp udp both

integer
required
≥ 0

Priority of the service.

integer
required
≥ 1

Read-only ID of the response.

sourceIp
array of strings
required
length ≥ 0

Lists source IPs.

sourceIp*
string
required

Specifies the service type, either IP, APP, NETWORK_SERVICE, GEO, or DEFAULT.

IP APP NETWORK_SERVICE GEO DEFAULT

integer
≥ 1

Read-only A unique identifier for policy's farm.

fileTypeSettings
array of objects
length ≥ 0

Lists the filetype settings for the policy.

fileTypeSettings
object
string
required
length ≥ 1

Lists policies to apply the file type settings to.

integer
required
≥ 1

Read-only Identifies each file type.

fileTypeInfo
object
required

Contains file type info properties.

groups
array of strings
required
length ≥ 0

List of groups that users belong to.

groups*
string
required
length ≥ 1

Name of the file type.

integer
required
≥ 1

Read-only Lists the response ID for the file type setting.

responseInfo
object
required

Provides details about response.

responseOverrides
array of objects
required
length ≥ 0

Contains the AVC response override details.

responseOverrides*
object
groupIds
array of strings
required
length ≥ 0

List of user groups for the AVC categories.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

List of AVC users for the AVC entity.

userIds*
string
required
length ≥ 1

Lists the file type.

users
array of strings
required
length ≥ 0

Specifies user emails assigned to the policy.

users*
integer
≥ 1

Read-only A unique identifier for each policy. Use this value for a policyId parameter in subsequent operations.

string
length ≥ 1

Read-only A unique identifier for the associated identity provider.

ipaSettings
object

Contains IPA settings.

boolean

Blocks on upload scan timeout.

boolean

Blocks unscannable files.

boolean
required

Enables IPA.

boolean
required

Enables random check for ipaSettings.

boolean
required

Enables Zero-Day Phishing (ZDP) protection.

string
length ≥ 1

Name of the user who most recently modified this policy.

date-time

Read-only ISO 8601 timestamp marking this policy's last modification.

string
required
length ≥ 1

The name of the policy.

originPorts
array of strings
length ≥ 0

Lists origin ports for a policy.

originPorts
integer
≥ 1

Read-only A unique identifier for a validation fail action.

policyGeneralSettings
object

Specifies the policy's general settings.

integer
≥ 0

Specifies the default action on Android devices.

boolean

Migrates acceptable use policy.

boolean

Enables the AVC.

boolean

Blocks broken TLS traffic.

boolean

Bypasses Microsoft Office 365 traffic.

integer
≥ 0

Specifies the default action on Android devices.

boolean

Migrates classify information.

boolean

Disables the SIA client.

boolean

Disables insecure ciphers.

dotConfig
object

Contains DNS over TLS configuration.

boolean

Enables IP intelligence.

boolean

Enables multi-user on the SIA client.

boolean

Enables Firewall as a Service.

integer
≥ 0

Represents HTTP proxy override priority.

integer
≥ 0

Specifies the default action on iOS devices.

integer
≥ 0

Specifies the retry interval value for IDP users.

boolean

Ignores local DNS resolution.

boolean

Enables local breakout for bypass.

boolean

Enables proxy authentication.

boolean

Enables walled-garden exceptions.

string

Name of proxy host machine.

riskyFileHandlingSettings
object

Describes file handling settings.

boolean

Enables dynamic analysis.

hugeRiskyFileResponse
object
required

Specifies the file response for huge risky files.

largeRiskyFileResponse
object
required

Specifies the file response for large risky files.

safeSearchSettings
object

Contains safe search settings.

string
required

Specifies the Youtube access policy, either open, moderate, or strict.

open moderate strict

securitySettings
array of objects
required
length ≥ 0

Contains the policy security settings.

securitySettings*
object
confirmedGroups
array of strings
length ≥ 0

List of confirmed groups.

confirmedGroups
integer
required
≥ 1

A unique identifier for the confirmed response.

confirmedResponseInfo
object

Contains data about the confirmed response.

confirmedUsers
array of strings
length ≥ 0

List of confirmed users.

confirmedUsers
integer
required
≥ 1

A unique identifier for the list.

listInfo
object

Contains data about the list.

responseOverridesConfirmed
array of objects
length ≥ 0

Lists of response overrides for confirmed response.

responseOverridesConfirmed
object
groupIds
array of strings
required
length ≥ 0

List of user groups for the AVC categories.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

List of AVC users for the AVC entity.

userIds*
responseOverridesSuspected
array of objects
length ≥ 0

Lists of response overrides for suspected response.

responseOverridesSuspected
object
groupIds
array of strings
required
length ≥ 0

List of user groups for the AVC categories.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

List of AVC users for the AVC entity.

userIds*
boolean
required

Send alert on confirmed list hit.

boolean
required

Send alert on suspected list hit.

suspectedGroups
array of strings
length ≥ 0

List of suspected groups.

suspectedGroups
integer
≥ 1

A unique identifier for the suspected response.

suspectedResponseInfo
object

Contains data about the suspected response.

suspectedUsers
array of strings
length ≥ 0

List of suspected users.

suspectedUsers
sites
array of integers
length ≥ 0

Contains associated site IDs.

sites
sitesInfo
array of objects
length ≥ 0

Contains data about associated sites.

sitesInfo
object
integer
required
≥ 1

Read-only A unique identifier for the site.

string
required
length ≥ 1

The name of the site.

sublocationInfo
array of objects
length ≥ 0

Lists sublocation info.

sublocationInfo
object
integer
required
≥ 1

Read-only Unique identifier for the resource.

string
required
length ≥ 1

Name of the resource.

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
object
required

Contains header information for traffic.

string
required

The traffic logging mode. Either full, url, path, or host.

full url path host

url
object
required

URL details of the traffic.

Updated over 1 year ago

Did this page help you?
Language
Authentication
Remember to add your authentication credentials to run this code.
URL

Updated over 1 year ago

Did this page help you?