API
Start typing to search…

Get policy metadata

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

Returns the policy metadata details.

Path Params
integer
required

A unique identifier for the configuration.

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.

Responses

Response body
object
akamaiDefinedLists
array of arrays of objects
length ≥ 0

The Akamai-defined lists assigned to the policy.

akamaiDefinedLists
array of objects
object
boolean
required

Lists allowed for DNS policy.

string
required
length ≥ 1

Author of the list.

date-time
required

Read-only ISO 8601 timestamp of the list creation.

string
required
length ≥ 1

A description for the security list.

integer
required
≥ 1

A unique identifier for each security list. Use this value for listId in subsequent operations.

string

The list type. See List types for details on each value.

AKAMAI TOP_LEVEL_DOMAIN WHITELIST FILEHASHLIST FILEHASH_BLOCK DOMAIN_IP_LIST URL_BLOCK URL_BYPASS

string
required
length ≥ 1

The name of the list.

integer
required
≥ 1

A unique identifier for the security category.

securityCategoryInfo
object
required

Contains data about the security category.

applications
array of objects
required
length ≥ 0

Lists AVC applications.

applications*
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

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

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

AUP response overrides with details.

responseOverrides*
object
groupIds
array of strings
required
length ≥ 0

AVC category user groups.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

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

AVC users for the AVC entity.

users*
integer
≥ 1

Unique identifier for the vendor app.

aupCategories
array of objects
length ≥ 0

Lists AUP categories.

aupCategories
object
string
length ≥ 1

The vendor code for the AVC entity.

string
required
length ≥ 0

The unique code for the AUP.

integer
required
≥ 1

Read-only Action ID on the AUP category.

boolean
required

Deprecates the AUP.

integer
required
≥ 1

Read-only A unique identifier for the category.

boolean

Indicates if the AVC entity is deployable.

string
required
length ≥ 1

Name of the response.

integer
≥ 1

Read-only Identifies the risk level for the AUP category.

subCategories
array of objects
length ≥ 0

A nested AUP object type.

subCategories
object
string
length ≥ 1

Unique identifier of the vendor.

categories
array of objects
required
length ≥ 0

Lists AVC categories.

categories*
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

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

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

AUP response overrides with details.

responseOverrides*
object
groupIds
array of strings
required
length ≥ 0

AVC category user groups.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

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

AVC users for the AVC entity.

users*
integer
≥ 1

Unique identifier for the vendor app.

dictionaries
array of objects
length ≥ 0

Lists dictionaries available.

dictionaries
object
boolean
required

Enables aggressive mode.

boolean
required

Indicates an Akamai-defined dictionary.

string
required
length ≥ 1

Read-only Name of the user who created this dictionary.

date-time
required

Read-only ISO 8601 timestamp marking the dictionary's creation.

string
length ≥ 1

Description of the dictionary.

integer
required
≥ 1

Read-only The unique identifier for the data loss protection (DLP) dictionary.

string
length ≥ 1

Read-only Name of the user who most recently modified the dictionary.

date-time

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

string
required
length ≥ 1

Name of the dictionary.

patternDetails
array of objects
required
length ≥ 0

The pattern details.

patternDetails*
object
string
required
length ≥ 1

A description of the DLP pattern.

integer
required
≥ 1

A unique identifier for the data loss protection (DLP) pattern.

string
required
length ≥ 1

Name of the DLP pattern.

patterns
array of integers
required
length ≥ 0

The pattern ID.

patterns*
policies
array of objects
length ≥ 0

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

policies
object
accessConfig
object

Provides access configuration details.

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

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

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

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

AUP response overrides with details.

responseOverrides*
object
groupIds
array of strings
required
length ≥ 0

AVC category user groups.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

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

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

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.

string

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

REQUIRED OPTIONAL NONE

avcSettings
object

Contains the AVC setting properties.

basicSettings
object

Contains the basic policy settings.

classifiers
object

Contains classifier details for a policy.

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.

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

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

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

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

AUP response overrides with details.

responseOverrides*
object
groupIds
array of strings
required
length ≥ 0

AVC category user groups.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

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

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

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

AVC category user groups.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

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.

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.

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*
object
confirmedGroups
array of strings
length ≥ 0

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

Confirmed users.

confirmedUsers
integer
required
≥ 1

A unique identifier for the list.

listInfo
object

List information.

responseOverridesConfirmed
array of objects
length ≥ 0

Response overrides for confirmed response.

responseOverridesConfirmed
object
groupIds
array of strings
required
length ≥ 0

AVC category user groups.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

AVC users for the AVC entity.

userIds*
responseOverridesSuspected
array of objects
length ≥ 0

Response overrides for suspected response.

responseOverridesSuspected
object
groupIds
array of strings
required
length ≥ 0

AVC category user groups.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

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

Suspected groups.

suspectedGroups
integer
≥ 1

A unique identifier for the suspected response.

suspectedResponseInfo
object

Suspected response data.

suspectedUsers
array of strings
length ≥ 0

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.

fWaaSApps
array of objects
length ≥ 0

Lists Firewall as Service Apps assigned to the policy.

fWaaSApps
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

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

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

AUP response overrides with details.

responseOverrides*
object
groupIds
array of strings
required
length ≥ 0

AVC category user groups.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

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

AVC users for the AVC entity.

users*
integer
≥ 1

Unique identifier for the vendor app.

fWaaSNetworkServices
array of objects
length ≥ 0

Lists firewalls-as-a-service assigned to the policy.

fWaaSNetworkServices
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.

fileTypes
array of objects
required
length ≥ 0

Lists AVC file types.

fileTypes*
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

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

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

AUP response overrides with details.

responseOverrides*
object
groupIds
array of strings
required
length ≥ 0

AVC category user groups.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

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

AVC users for the AVC entity.

users*
integer
≥ 1

Unique identifier for the vendor app.

honeypots
array of objects
length ≥ 1

Lists custom responses.

honeypots
object
integer
required
≥ 1

Read-only Unique identifier for the resource.

string
required
length ≥ 1

Name of the resource.

integer
≥ 0

Enables HTTP proxy override.

string
length ≥ 1

Contains firewall-as-a-service metadata.

operations
array of objects
required
length ≥ 0

Lists AVC operations.

operations*
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

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

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

AUP response overrides with details.

responseOverrides*
object
groupIds
array of strings
required
length ≥ 0

AVC category user groups.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

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

AVC users for the AVC entity.

users*
integer
≥ 1

Unique identifier for the vendor app.

boolean

Indicates the presence of proxy credentials for the account.

responses
array of arrays of objects
length ≥ 1

Lists responses.

responses
array of objects
object
boolean
required

Allows AUP responses.

boolean
required

Allows DNS policy responses.

boolean
required

Allows Security Connector responses.

string
required
length ≥ 1

Description of the built-in response.

integer
required

A unique identifier for each response. Use this value for any responseId parameters in subsequent operations.

string
required
length ≥ 1

Name of the built-in response.

risks
array of objects
required
length ≥ 0

Lists AVC risks.

risks*
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

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

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

AUP response overrides with details.

responseOverrides*
object
groupIds
array of strings
required
length ≥ 0

AVC category user groups.

groupIds*
integer
required
≥ 1

Unique identifier for the response.

responseInfo
object
required

AVC response details.

userIds
array of strings
required
length ≥ 0

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

AVC users for the AVC entity.

users*
integer
≥ 1

Unique identifier for the vendor app.

sinkholes
array of objects
length ≥ 1

Sinkhole detail objects.

sinkholes
object
integer
required

Unique identifier for the resource.

string
required
length ≥ 1

Name of the resource.

string
required
length ≥ 1

Specifies resource type.

string
required
length ≥ 1

Specifies the resource version.

Updated 4 months ago

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

Updated 4 months ago

Did this page help you?