Skip to main content

Akamai WAF

This Integration is part of the Akamai WAF Pack.#

Manage a common set of lists for use in various Akamai security products such as Kona Site Defender, Web App Protector, and Bot Manager. This integration was integrated and tested with Network Lists API v2.0

Playbooks#

  • Akamai WAF Network list activate generic polling.

Use Cases#

  • Get network list details - activations status, elements etc
  • Create or remove network lists.
  • Network list editing - add or remove elements.
  • Network list activation.

Detailed Description#

The Akamai WAF integration allows you to manage a common set of lists for use in various Akamai security products such as Kona Site Defender, Web App Protector, and Bot Manager. Network lists are shared sets of IP addresses, CIDR blocks, or broad geographic areas. Along with managing your own lists, you can also access read-only lists that Akamai dynamically updates for you.

API keys generating steps#

  1. Open Control panel and login with admin account.
  2. Open identity and access management menu.
  3. Create new api client for me
  4. Assign API key to the relevant users group, and assign on next page Read/Write access for Network Lists.
  5. Save configuration and go to API detail you created.
  6. Press new credentials and download or copy it.
  7. Now use the credentials for configure Akamai WAF in Cortex XSOAR

Configure Akamai WAF on Cortex XSOAR#

  1. Navigate to Settings > Integrations > Servers & Services.

  2. Search for Akamai WAF.

  3. Click Add instance to create and configure a new integration instance.

    ParameterRequired
    Server URL (e.g., https://example.net)True
    Client tokenTrue
    Access tokenTrue
    Client secretTrue
    Trust any certificate (not secure)False
    Use system proxy settingsFalse
  4. Click Test to validate the URLs, token, and connection.

Commands#

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

akamai-get-network-lists#


Returns a list of all network lists available for an authenticated user who belongs to a group.

Base Command#

akamai-get-network-lists

Input#

Argument NameDescriptionRequired
list_typeThe network list type by which to filter the results. Possible values are: IP, GEO.Optional
searchThe query by which to search for list names and list items.Optional
extendedWhen enabled, provides additional response data identifying who created and updated the list and when, and the network list’s deployment status in both STAGING and PRODUCTION environments. This data takes longer to provide. Possible values are: true, false. Default is true.Optional
include_elementsIf enabled, the response list includes all items. For large network lists, this may slow responses and yield large response objects. The default false value when listing more than one network list omits the network list’s elements and only provides higher-level metadata. Possible values are: true, false. Default is false.Optional

Context Output#

PathTypeDescription
Akamai.NetworkLists.Lists.NameStringThe network list name.
Akamai.NetworkLists.Lists.TypeStringThe network list type.
Akamai.NetworkLists.Lists.UniqueIDStringThe network list unique ID.
Akamai.NetworkLists.Lists.ElementCountStringThe number of network list elements.
Akamai.NetworkLists.Lists.CreateDateDateThe network list creation date.
Akamai.NetworkLists.Lists.CreatedByStringThe network list creator.
Akamai.NetworkLists.Lists.ExpeditedProductionActivationStatusStringThe expedited production activation status.
Akamai.NetworkLists.Lists.ExpeditedStagingActivationStatusStringThe expedited staging activation status.
Akamai.NetworkLists.Lists.ProductionActivationStatusStringThe production activation status.
Akamai.NetworkLists.Lists.StagingActivationStatusStringThe staging activation status.
Akamai.NetworkLists.Lists.UpdateDateStringThe date that the network list was updated.
Akamai.NetworkLists.Lists.UpdatedByStringThe last user that updated the network list.
Akamai.NetworkLists.Lists.ElementsStringThe elements in the network list.
Command Example#

!akamai-get-network-lists

!akamai-get-network-lists type=IP search="192.168.0.1"

!akamai-get-network-lists type=GEO search=IL

Context Example#
{
"Akamai":{
"NetworkLists":{
"Lists": [
{
"CreatedBy": "user",
"ElementCount": 2,
"Elements": [
"8.8.8.8",
"8.8.8.8"
],
"ExpeditedProductionActivationStatus": "INACTIVE",
"ExpeditedStagingActivationStatus": "INACTIVE",
"Name": "Test",
"ProductionActivationStatus": "PENDING_ACTIVATION",
"StagingActivationStatus": "INACTIVE",
"Type": "IP",
"UniqueID": "uniq_id",
"UpdateDate": "2020-01-13T18:57:05.99Z",
"UpdatedBy": "user"
},
{
"CreatedBy": "akamai",
"ElementCount": 18,
"Elements": [
"iq",
"mm",
"ir",
"ye",
"so",
"sd"
],
"ExpeditedProductionActivationStatus": "INACTIVE",
"ExpeditedStagingActivationStatus": "INACTIVE",
"Name": "Test",
"ProductionActivationStatus": "PENDING_ACTIVATION",
"StagingActivationStatus": "INACTIVE",
"Type": "IP",
"UniqueID": "uniq_id",
"UpdateDate": "2020-01-13T18:57:05.99Z",
"UpdatedBy": "user"
}
]
}
}
}
Human Readable Output#

Akamai WAF - network lists#

Element countNameThe production Activation StatusThe staging Activation StatusTypeUnique IDUpdated by
2TestPENDING_ACTIVATIONINACTIVEIPuniqe_iduser
1testINACTIVEINACTIVEIPuniqe_iduser

akamai-get-network-list-by-id#


Gets a network list by the network list ID.

Base Command#

akamai-get-network-list-by-id

Input#

Argument NameDescriptionRequired
network_list_idThe network list ID.Required

Context Output#

PathTypeDescription
Akamai.NetworkLists.Lists.NameStringThe network list name.
Akamai.NetworkLists.Lists.TypeStringThe network list type.
Akamai.NetworkLists.Lists.UniqueIDStringThe network list unique ID.
Akamai.NetworkLists.Lists.ElementCountNumberThe number of network list elements.
Akamai.NetworkLists.Lists.CreateDateDateThe network list creation date.
Akamai.NetworkLists.Lists.CreatedByStringThe network list creator.
Akamai.NetworkLists.Lists.ExpeditedProductionActivationStatusStringThe expedited production activation status.
Akamai.NetworkLists.Lists.ExpeditedStagingActivationStatusStringThe expedited staging activation status.
Akamai.NetworkLists.Lists.ProductionActivationStatusStringThe production activation status.
Akamai.NetworkLists.Lists.StagingActivationStatusStringThe staging activation status.
Akamai.NetworkLists.Lists.UpdateDateStringThe network list update date.
Akamai.NetworkLists.Lists.UpdatedByStringThe last user who updated the network list.
Akamai.NetworkLists.Lists.ElementsStringThe elements in the network list.
Command Example#

!akamai-get-network-list-by-id network_list_id=69988_TEST

Context Example#
{
"Akamai": {
"NetworkLists": {
"Lists": [
{
"CreatedBy": "user",
"ElementCount": 2,
"Elements": [
"8.8.8.8",
"8.8.8.8"
],
"ExpeditedProductionActivationStatus": "INACTIVE",
"ExpeditedStagingActivationStatus": "INACTIVE",
"Name": "Test",
"ProductionActivationStatus": "PENDING_ACTIVATION",
"StagingActivationStatus": "INACTIVE",
"Type": "IP",
"UniqueID": "unique_id",
"UpdateDate": "2020-01-13T18:57:05.99Z",
"UpdatedBy": "user"
}
]
}
}
Human Readable Output#

Akamai WAF - network list 69988_TEST#

Element countNameThe production Activation StatusThe staging Activation StatusTypeUnique IDUpdated by
2TestPENDING_ACTIVATIONINACTIVEIPuique_iduser

akamai-create-network-list#


Creates a new network list. Supports TXT file upload for elements.

Base Command#

akamai-create-network-list

Input#

Argument NameDescriptionRequired
list_nameThe network list name.Required
list_typeThe network list type. Possible values are: IP, GEO.Required
elementsThe network list elements.Optional
entry_idThe War Room entry ID of the sample file.Optional
descriptionThe network list description.Optional

Context Output#

PathTypeDescription
Akamai.NetworkLists.Lists.NameStringThe network list name.
Akamai.NetworkLists.Lists.UniqueIDStringThe network list ID.
Akamai.NetworkLists.Lists.TypeStringThe network list type.
Akamai.NetworkLists.Lists.ElementCountNumberThe number of elements in the list.
Akamai.NetworkLists.Lists.ElementsStringThe elements in the list.
Command Example#

!akamai-create-network-list list_name=test list_type=IP description=test elements=8.8.8.8

Context Example#
{
"Akamai": {
"NetworkLists": [
{
"Elements": [
"8.8.8.8"
],
"Name": "test",
"Type": "IP",
"UniqueID": "70548_TEST"
}
]
}
}
Human Readable Output#

Akamai WAF - network list test created successfully#

NameTypeUnique ID
testIP70548_TEST

akamai-delete-network-list#


Deletes the specified network list.

Base Command#

akamai-delete-network-list

Input#

Argument NameDescriptionRequired
network_list_idThe ID of the network list to delete.Required

Context Output#

There is no context output for this command.

Command Example#

!akamai-delete-network-list network_list_id=69856_NEW

Context Example#
{}
Human Readable Output#

Akamai WAF - network list 69856_NEW deleted.


akamai-activate-network-list#


Activates a network list on the specified environment.

Base Command#

akamai-activate-network-list

Input#

Argument NameDescriptionRequired
network_list_idsA comma-separated list of network list IDs to activate. For example: list (list1,list2).Required
envThe environment type to activate the network list. Possible values are: STAGING, PRODUCTION.Required
commentA comment to be logged.Optional
notifyA comma-separated list of email addresses.Optional
Context Output#

There are no context output for this command.

Command Example#

!akamai-activate-network-list network_list_id=69988_TEST,69989_TEST env=PRODUCTION comment=test

Context Example#
{}
Human Readable Output#

Akamai WAF - network list 69988_TEST activated on PRODUCTION successfully Akamai WAF - network list 69989_TEST already active on PRODUCTION


akamai-add-elements-to-network-list#


Adds elements to the specified network list.

Base Command#

akamai-add-elements-to-network-list

Input#

Argument NameDescriptionRequired
network_list_idThe ID of the network in which to add elements.Required
entry_idThe War Room entry ID of the sample file.Optional
elementsA comma-separated list of elements to add to the network list.Optional

Context Output#

There is no context output for this command.

Command Example#

!akamai-add-elements-to-network-list network_list_id=69988_TEST elements="8.8.8.8, 9.9.9.9"

Context Example#
{}
Human Readable Output#

Akamai WAF - elements added to network list 69988_TEST successfully#

elements
8.8.8.8, 9.9.9.9

akamai-remove-element-from-network-list#


Removes elements from the specified network list.

Base Command#

akamai-remove-element-from-network-list

Input#

Argument NameDescriptionRequired
network_list_idThe ID of the network list from which to remove elements.Required
elementThe element to remove from the network list.Required

Context Output#

There is no context output for this command.

Command Example#

!akamai-remove-element-from-network-list network_list_id=69988_TEST element=8.8.8.8

Context Example#
{}
Human Readable Output#

Akamai WAF - element 8.8.8.8 removed from network list 69988_TEST successfully


akamai-get-network-list-activation-status#


Gets the activation status of the specified network list.

Base Command#

akamai-get-network-list-activation-status

Input#

Argument NameDescriptionRequired
network_list_idsA comma-separated list of network list IDs for which to get the activation status. For example: (support list - list1,list2).Required
envThe environment type. Possible values are: PRODUCTION, STAGING.Required

Context Output#

PathTypeDescription
Akamai.NetworkLists.ActivationStatus.UniqueIDStringThe network list ID.
Akamai.NetworkLists.ActivationStatus.StagingStatusStringThe network list environment staging activation status.
Akamai.NetworkLists.ActivationStatus.ProductionStatusStringThe network list environment activation production status.
Command Example#

!akamai-get-network-list-activation-status network_list_id=69988_TEST env=PRODUCTION

!akamai-get-network-list-activation-status network_list_id=69988_TEST, 69989_TEST env=PRODUCTION

Context Example#
{
"Akamai": {
"NetworkLists": {
"ActivationStatus": {
"Status": "PENDING_ACTIVATION",
"UniqueID": "69988_TEST"
}
}
}
}
Human Readable Output#

Akamai WAF - network list 69988_TEST is PENDING_ACTIVATION in PRODUCTION Akamai WAF - network list 69989_TEST canot be found

akamai-update-network-list-elements#


Updates list elements of a network list.

Base Command#

akamai-update-network-list-elements

Input#

Argument NameDescriptionRequired
network_list_idThe ID of the network list to update.Required
elementsComma-separated list of elements. Use BLANK to empty a list.Required

Context Output#

There is no context output for this command.

akamai-check-group#


Check an existing group within the context of your account.

Base Command#

akamai-check-group

Input#

Argument NameDescriptionRequired
checking_group_nameGroup Name.Optional

Context Output#

PathTypeDescription
Akamai.CheckGroupunknownGroup ID.
Akamai.CheckGroup.FoundunknownWas the group found?
Akamai.CheckGroup.groupNameunknownThe parent group name.
Akamai.CheckGroup.parentGroupIdunknownThe parent group ID.
Akamai.CheckGroup.groupIdunknownThe group ID.
Akamai.CheckGroup.checking_group_nameunknownGroup name.

akamai-create-group#


Create a new group under a parent GID.

Base Command#

akamai-create-group

Input#

Argument NameDescriptionRequired
group_pathThe group path separated with >.Required

Context Output#

There is no context output for this command.

akamai-create-enrollment#


Create a new enrollment.

Base Command#

akamai-create-enrollment

Input#

Argument NameDescriptionRequired
countryCountry. Default is US.Required
companyCompany.Required
organizational_unitOrganizational unit.Required
cityThe city of the admin contact.Required
contract_idContract ID.Required
certificate_typeCertificate type. Default is third-party.Optional
csr_cnCommon name.Required
admin_contact_address_line_oneAddress of the admin contact.Required
admin_contact_first_nameThe first name of the admin contact.Required
admin_contact_last_nameThe last name of the admin contact.Required
admin_contact_emailThe email address of the admin contact.Required
admin_contact_phoneThe phone number of the admin contact.Required
tech_contact_first_nameThe first name of the tech contact.Required
tech_contact_last_nameThe last name of the tech contact.Required
tech_contact_emailThe email address of the tech contact.Required
tech_contact_phoneThe phone number of the tech contact.Required
org_nameThe organization name.Required
org_countryThe organization country.Required
org_cityThe organization city.Required
org_regionThe organization region.Required
org_postal_codeThe organization postal code.Required
org_phoneThe organization phone number.Required
org_address_line_oneThe organization address.Required
clone_dns_namesNetwork Configuration - Dns Name Settings - Clone DNS Names. Default is True.Optional
exclude_sansThird Party - Exclude Sans. Default is False.Optional
change_management. Default is False.Optional
network_configuration_geography. Default is core.Optional
ra. Default is third-party.Optional
validation_type. Default is third-party.Optional
enable_multi_stacked_certificates. Default is False.Optional
network_configuration_quic_enabled. Default is True.Optional
network_configuration_secure_network. Default is enhanced-tls.Optional
network_configuration_sni_only. Default is True.Optional

Context Output#

PathTypeDescription
Akamai.EnrollmentstringEnrollment path.

akamai-list-enrollments#


List enrollments of a specific contract.

Base Command#

akamai-list-enrollments

Input#

Argument NameDescriptionRequired
contract_idContract ID.Required

Context Output#

There is no context output for this command.

akamai-create-domain#


Create a domain with properties and domain controller (DC).

Base Command#

akamai-create-domain

Input#

Argument NameDescriptionRequired
domain_nameDomain name.Required
group_idGroup ID.Required

Context Output#

There is no context output for this command.

akamai-update-property#


Update a property for a specific domain.

Base Command#

akamai-update-property

Input#

Argument NameDescriptionRequired
domain_nameThe domain name to which the new property is added.Required
property_nameNew property name.Required
property_typeProperty type.Required
static_typeStatic type - "CNAME" or "A".Optional
static_serverStatic server.Optional
server_1Server 1.Optional
server_2Server 2.Optional
weight_1Weight 1.Optional
weight_2Weight 2.Optional
property_comments.Optional
dc1_idData center ID 1.Optional
dc2_idData center ID 2.Optional

Context Output#

There is no context output for this command.

akamai-get-change#


Get the CPS code.

Base Command#

akamai-get-change

Input#

Argument NameDescriptionRequired
enrollment_pathEnrollment path.Required
allowed_input_type_param. Default is third-party-csr.Optional

Context Output#

PathTypeDescription
Akamai.ChangeunknownCertificate Signing Request (CSR).

akamai-update-change#


Update the certs and trust chains.

Base Command#

akamai-update-change

Input#

Argument NameDescriptionRequired
change_pathThe path of the changed certificate.Required
allowed_input_type_paramAllowed input type parameter. Default is third-party-cert-and-trust-chain.Optional
certificateThe updated certificate.Optional
trust_chainThe updated trust chain.Optional

Context Output#

There is no context output for this command.

akamai-get-enrollment-by-cn#


Get enrollment by common name.

Base Command#

akamai-get-enrollment-by-cn

Input#

Argument NameDescriptionRequired
contract_idContract ID.Required
target_cnTarget common name.Required

Context Output#

PathTypeDescription
Akamai.EnrollmentunknownEnrollment.
Akamai.Enrollment.target_cnunknownTarget common name.

akamai-list-groups#


Lists groups of Akamai.

Base Command#

akamai-list-groups

Input#

Argument NameDescriptionRequired

Context Output#

PathTypeDescription
Akamai.GroupunknownAkmai Group

akamai-get-group#


Get group.

Base Command#

akamai-get-group

Input#

Argument NameDescriptionRequired
group_idGroup ID. Default is 0.Required

Context Output#

There is no context output for this command.

akamai-get-domains#


Get Google Tag Manager (GTM) domains.

Base Command#

akamai-get-domains

Input#

Argument NameDescriptionRequired

Context Output#

PathTypeDescription
Akamai.DomainunknownDomains.

akamai-get-domain#


Get a specific GTM domain.

Base Command#

akamai-get-domain

Input#

Argument NameDescriptionRequired
domain_nameDomain name to get.Required

Context Output#

PathTypeDescription
Akamai.DomainunknownDomain.

akamai-create-datacenter#


Create a data center.

Base Command#

akamai-create-datacenter

Input#

Argument NameDescriptionRequired
domain_nameDomain Name.Required
dc_nameDomain controller name.Required
dc_countryCountry name. Default is US.Optional

Context Output#

There is no context output for this command.

akamai-clone-papi-property#


Clone a new PAPI property.

Base Command#

akamai-clone-papi-property

Input#

Argument NameDescriptionRequired
product_idID for a specific Akamai product.Required
property_nameProperty Manager API (PAPI) (Ion Standard) property name.Required
contract_idContract ID.Required
group_idConfiguration group ID.Required
property_idProperty Manager API (PAPI) (Ion Standard) property ID.Required
versionProperty version.Required
check_existence_before_createWhether to continue execution if an existing record is found without creating a new record. Default is yes.Required

Context Output#

PathTypeDescription
Akamai.PapiProperty.PropertyNameunknownPAPI (Ion Standard) property name.
Akamai.PapiProperty.PropertyIdunknownPAPI (Ion Standard) property ID.
Akamai.PapiProperty.AssetIdunknownPAPI (Ion Standard) property asset ID.

akamai-add-papi-property-hostname#


Add hostnames to the PAPI property.

Base Command#

akamai-add-papi-property-hostname

Input#

Argument NameDescriptionRequired
property_versionPAPI (Ion Standard) property version. Default is 1.Required
property_idPAPI (Ion Standard) property ID.Required
contract_idContract ID.Required
group_idConfiguration group ID.Required
validate_hostnamesValidate hostnames.Optional
include_cert_statusInclude the certificate status for the hostname.Optional
cname_fromURL of the common name.Required
edge_hostname_idEdge hostname ID.Required
sleep_timeSleep time in seconds between each iteration.Required

Context Output#

PathTypeDescription
Akamai.PapiProperty.EtagunknownETag for concurrency control.

akamai-new-papi-edgehostname#


Add a PAPI edge hostname.

Base Command#

akamai-new-papi-edgehostname

Input#

Argument NameDescriptionRequired
product_idID for a specific Akamai product.Required
contract_idContract ID.Required
group_idConfiguration group ID.Required
optionsComma-separated list of options to enable. mapDetails enables extra mapping-related information.Optional
domain_prefixURL of domain name.Required
domain_suffixURL of the partial domain name appended by Akamai.Required
ip_version_behaviorIP version. IPv4, IPv6, or IPv4 plus IPv6.Required
secureSSL secured URL.Optional
secure_networkSSL secured protocol options.Optional
cert_enrollment_idCertificate enrollment ID for the domain URL.Optional
check_existence_before_createWhether to continue execution if an existing record is found without creating a new record. Default is yes.Required

Context Output#

PathTypeDescription
Akamai.PapiProperty.EdgeHostnames.EdgeHostnameIdunknownEdge hostname ID.
Akamai.PapiProperty.EdgeHostnames.DomainPrefixunknownEdge hostname domain prefix URL.

akamai-get-cps-enrollmentid-by-cnname#


Get cps certificate enrollment ID by common name.

Base Command#

akamai-get-cps-enrollmentid-by-cnname

Input#

Argument NameDescriptionRequired
contract_idContract ID.Required
cnnameURL of common name.Optional

Context Output#

PathTypeDescription
Akamai.Cps.Enrollment.EnrollmentIdunknownCertificate enrollment ID.
Akamai.Cps.Enrollment.CNunknownCertificate enrollment common name.

akamai-new-papi-cpcode#


Create a new PAPI CP code.

Base Command#

akamai-new-papi-cpcode

Input#

Argument NameDescriptionRequired
product_idID for specific Akamai product.Required
contract_idContract ID.Required
group_idConfiguration group ID.Required
cpcode_nameContent provider codes name.Required
check_existence_before_createWhether to continue execution if an existing record is found without creating a new record. Default is yes.Required

Context Output#

PathTypeDescription
Akamai.PapiCpcode.CpcodeIdunknownContent provider code ID.

akamai-patch-papi-property-rule-cpcode#


Patch PAPI property default rule with a CP code.

Base Command#

akamai-patch-papi-property-rule-cpcode

Input#

Argument NameDescriptionRequired
contract_idContract ID.Required
group_idConfiguration group ID.Required
property_idPAPI (Ion Standard) property ID.Required
property_versionPAPI (Ion Standard) property version.Optional
validate_rulesWhether to validate rules.Optional
operationJSON patch operation. Add, Remove, Replace.Optional
pathDictionary path.Optional
cpcode_idContent provider code ID.Optional
nameContent provider code name.Optional

Context Output#

PathTypeDescription
Akamai.PapiProperty.EtagunknownETag for concurrency control.

akamai-patch-papi-property-rule-origin#


Patch PAPI property default rule with an origin.

Base Command#

akamai-patch-papi-property-rule-origin

Input#

Argument NameDescriptionRequired
contract_idContract ID.Required
group_idConfiguration group ID.Required
property_idPAPI (Ion Standard) property ID.Required
property_versionPAPI (Ion Standard) property version.Required
validate_rulesWhether to validate rules.Required
operationJSON patch operation. Add, Remove, Replace.Required
pathDictionary path.Required
originvalue.Required
external_urlExternal URL FQDN.Required
gzip_compressionGzip compression.Optional
sleep_timeSleep time between each iteration.Required

Context Output#

PathTypeDescription
Akamai.PapiProperty.EtagunknownEtag for Concurrency Control.

akamai-activate-papi-property#


Activate a PAPI property.

Base Command#

akamai-activate-papi-property

Input#

Argument NameDescriptionRequired
contract_idContract ID.Required
group_idConfiguration group ID.Required
property_idPAPI (Ion Standard) property ID.Required
networkSTAGING or PRODUCTION.Optional
notify_emailsNotification emails.Optional
property_versionPAPI (Ion Standard) property version.Optional
noteactivation note.Optional

Context Output#

PathTypeDescription
Akamai.PapiProperty.Staging.ActivationIdunknownStaging activation ID.
Akamai.PapiProperty.Production.ActivationIdunknownProduction activation ID.

akamai-clone-security-policy#


AppSec clone security policy.

Base Command#

akamai-clone-security-policy

Input#

Argument NameDescriptionRequired
config_idAppSec configuration ID.Required
config_versionAppSec configuration version.Required
create_from_security_policyBaseline security policy ID.Required
policy_nameNew security policy name.Required
policy_prefixSecurity policy ID prefix.Optional
check_existence_before_createWhether to continue execution if an existing record is found without creating a new record. Default is yes.Required

Context Output#

PathTypeDescription
Akamai.AppSecConfig.Policy.PolicyNameunknownSecurity policy name.
Akamai.AppSecConfig.Policy.PolicyIdunknownSecurity policy ID.

akamai-new-match-target#


AppSec create match target.

Base Command#

akamai-new-match-target

Input#

Argument NameDescriptionRequired
config_idAppSec configuration ID.Required
config_versionAppSec configuration version.Required
policy_idSecurity policy ID.Required
match_typeWebsite.Required
hostnamesComma-separated list of hostname URLs.Required
bypass_network_listsComma-separated list of bypass networks.Required
file_pathsFile paths. Default is /*.Required
default_fileDefault is noMatch.Required

Context Output#

PathTypeDescription
Akamai.AppSecConfig.Policy.PolicyNameunknownSecurity policy name.
Akamai.AppSecConfig.Policy.PolicyIdunknownSecurity policy ID.
Akamai.AppSecConfig.Policy.TargetIdunknownMatch target ID.

akamai-activate-appsec-config-version#


AppSec activate appsec configuration version.

Base Command#

akamai-activate-appsec-config-version

Input#

Argument NameDescriptionRequired
config_idAppSec configuration ID.Required
config_versionAppSec configuration version.Required
acknowledged_invalid_hostsDefault is N/A.Required
notification_emailsList of notification emails.Required
actionActivate.Required
networkSTAGING or PRODUCTION.Required
noteNote to describe the activity.Required

Context Output#

PathTypeDescription
Akamai.AppSecConfig.Staging.ActivationIdunknownSecurity configuration staging activation ID.
Akamai.AppSecConfig.Production.ActivationIdunknownSecurity configuration production activation ID.

akamai-get-appsec-config-activation-status#


AppSec get appsec config activation status.

Base Command#

akamai-get-appsec-config-activation-status

Input#

Argument NameDescriptionRequired
activation_idSecurity configuration activation ID.Required
sleep_timeSleep time in seconds between each iteration.Required
retriesNumber of retries of the consistency check to be conducted.Required

Context Output#

PathTypeDescription
Akamai.AppSecConfig.StagingunknownStaging Security Configration.
Akamai.AppSecConfig.ProductionunknownProduction Security Configration.

akamai-get-appsec-config-latest-version#


AppSec get appsec config latest version.

Base Command#

akamai-get-appsec-config-latest-version

Input#

Argument NameDescriptionRequired
sec_config_nameName of the security configuration.Required
sleep_timeNumber of seconds to wait before the next consistency check.Required
retriesNumber of retries of the consistency check to be conducted.Required
skip_consistency_checkDo not perform LatestVersion, Staging Version, Production Version consistency check.Required

Context Output#

PathTypeDescription
Akamai.AppSecConfig.LatestVersionunknownSecurity configuration latest version number.

akamai-get-security-policy-id-by-name#


AppSec get security policy ID by name.

Base Command#

akamai-get-security-policy-id-by-name

Input#

Argument NameDescriptionRequired
policy_nameSecurity Policy Name.Required
config_idAppSec configuration ID.Required
config_versionAppSec configuration version.Required
is_baseline_policyWhether this is the baseline security policy.Required

Context Output#

PathTypeDescription
Akamai.AppSecConfig.BasePolicyNameunknownBaseline security policy name.
Akamai.AppSecConfig.BasePolicyIdunknownBaseline security policy ID.
Akamai.AppSecConfig.Policy.PolicyNameunknownSecurity policy name.
Akamai.AppSecConfig.Policy.PolicyIdunknownBaseline security policy ID.
Akamai.AppSecConfig.IdunknownAppSec security configuration ID.

akamai-clone-appsec-config-version#


AppSec_clone appsec config version

Base Command#

akamai-clone-appsec-config-version

Input#

Argument NameDescriptionRequired
config_idAppSec configuration ID.Required
create_from_versionAppSec configuration version.Required
do_not_cloneDo not clone to create a new version. Use in the test.Required

Context Output#

PathTypeDescription
Akamai.AppSecConfig.NameunknownAppSec configuration name.
Akamai.AppSecConfig.IdunknownAppSec Configration ID
Akamai.AppSecConfig.NewVersionunknownAppSec Configration New Version

akamai-patch-papi-property-rule-httpmethods#


Patch PAPI property rule HTTP methods.

Base Command#

akamai-patch-papi-property-rule-httpmethods

Input#

Argument NameDescriptionRequired
contract_idContract ID.Required
group_idGroup ID.Required
property_idProperty ID.Required
property_versionProperty Version.Optional
validate_rulesWhether to validate the Rules.Required
operationThe operation to execute.Required
pathThe path of the rule.Required
valueThe value.Required

Context Output#

PathTypeDescription
Akamai.PapiProperty.EtagunknownETag for concurrency control.

akamai-get-papi-property-activation-status-command#


Get PAPI property activation status until it is active.

Base Command#

akamai-get-papi-property-activation-status-command

Input#

Argument NameDescriptionRequired
activation_idIon property activation ID.Required
property_idIon property ID.Required
sleep_timeSleep time between retries.Required
retriesNumber of retires.Required

Context Output#

There is no context output for this command.

akamai-get-papi-edgehostname-creation-status-command#


Get PAPI edgehostname creation status command until it is created.

Base Command#

akamai-get-papi-edgehostname-creation-status-command

Input#

Argument NameDescriptionRequired
contract_idcontract ID.Required
group_idGroup id.Required
edgehostname_idEdge hostname ID.Required
optionsmapDetails.Required
sleep_timeSleep time between each iteration.Required
retriesNumber of retries.Required

Context Output#

There is no context output for this command.

akamai-acknowledge-warning-command#


Acknowledge the warning message for uploading the certs and trust chains of enrollments.

Base Command#

akamai-acknowledge-warning-command

Input#

Argument NameDescriptionRequired
change_pathThe path of the changed certificate.Required

Context Output#

There is no context output for this command.

akamai-modify-appsec-config-selected-hosts#


Update the list of selected hostnames for a configuration version.

Base Command#

akamai-modify-appsec-config-selected-hosts

Input#

Argument NameDescriptionRequired
config_idA unique identifier for each configuration.Required
config_versionA unique identifier for each version of a configuration.Required
hostname_listA list hostnames is used to modifying the configuration.Required
modeThe type of update you want to make to the evaluation hostname list. Use "append" to add additional hostnames, Use "remove" to delete the hostnames from the list, Use "replace" to replace the existing list with the hostnames you pass in your request. Use "append" to add additional hostnames. Use "remove" to delete the hostnames from the list. Use "replace" to replace the existing list with the hostnames you pass in your request.Required

Context Output#

There is no context output for this command.

akamai-get-production-deployment#


Get Production Deployment

Base Command#

akamai-get-production-deployment

Input#

Argument NameDescriptionRequired
enrollment_id.Required

Context Output#

There is no context output for this command.

akamai-get-change-history#


Get change history

Base Command#

akamai-get-change-history

Input#

Argument NameDescriptionRequired
enrollment_id.Required

Context Output#

There is no context output for this command.

akamai-patch-papi-property-rule-siteshield#


Patch papi property default rule siteshield

Base Command#

akamai-patch-papi-property-rule-siteshield

Input#

Argument NameDescriptionRequired
contract_idAkamai contract Identity.Required
group_idAkamai configuration group Identity.Required
property_idAkamai Ion Property Identity.Required
property_versionAkamai Ion Property Version Identity.Required
validate_rulesValidate the rule or not - true or false.Required
operationJson patch operation - add / delete / replace.Required
pathJson patch Rule path.Required
ssmapsiteshiled json format data.Required

Context Output#

There is no context output for this command.

akamai-update-appsec-config-version-notes#


Update application secuirty configuration version notes command

Base Command#

akamai-update-appsec-config-version-notes

Input#

Argument NameDescriptionRequired
config_idThe ID of the application seucirty configuration.Required
config_versionThe version number of the application seucirty configuration.Required
notesThe notes need to be written into the application seucirty configuration version.Required

Context Output#

There is no context output for this command.

akamai-new-or-renew-match-target#


New match target if no existing found otherwise update the existing match target hostnames. If there are multiple match targets found, the first one in the list will be updated

Base Command#

akamai-new-or-renew-match-target

Input#

Argument NameDescriptionRequired
config_idA unique identifier for each configuration.Required
config_versionA unique identifier for each version of a configuration.Required
match_typeThe type of the match target.Required
bypass_network_listsbypass network lists.Required
default_fileDescribes the rule to match on paths.Required
file_pathsContains a list of file paths.Required
hostnamesA list of hostnames that need to be added into match target.Required
policy_idSpecifies the security policy to filter match targets.Required

Context Output#

There is no context output for this command.

akamai-patch-papi-property-rule-generic#


Generic JSON patch command for Papi Property Default Rule

Base Command#

akamai-patch-papi-property-rule-generic

Input#

Argument NameDescriptionRequired
contract_idA unique identifier for each configuration.Required
group_idA unique identifier for each group.Required
property_idA unique identifier for each Papi Property.Required
property_versionA unique identifier for each Papi Property Version.Required
validate_ruleswhether validate rule or not.Required
operationadd/replace/remove.Required
pathjson rule tree path for the default rule.Required
valuevalue to be operated against.Required

Context Output#

There is no context output for this command.

akamai-get-papi-property-rule#


get papi property rule json and dump into string

Base Command#

akamai-get-papi-property-rule

Input#

Argument NameDescriptionRequired
contract_idA unique identifier for each configuration.Required
group_idA unique identifier for each group.Required
property_idA unique identifier for each Papi Property.Required
property_versionA unique identifier for each Papi Property Version.Required
validate_ruleswhether validate rule or not.Required
operationadd/replace/remove.Required
pathjson rule tree path for the default rule.Required
valuevalue to be operated against.Required
value_to_jsonwhether to convert value to json format. yes/no.Required

Context Output#

PathTypeDescription
Akamai.PapiProperty.DefaultRuleunknownPapi Property default rule