Akamai Web Application Firewall (WAF)
App Vendor: Akamai
App Category: Firewall
Connector Version: 1.0.0
API Version: 1.0.0
About App
The Akamai Web Application Firewall (WAF) helps secure your web applications and websites from online threats. Leveraging Akamai’s globally distributed content delivery network (CDN), it delivers reliable, scalable protection while maintaining the performance and availability of your applications.
The Akamai Web Application Firewall (WAF) app is configured with Cyware Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Activate Configuration Version | This action activates the activation configuration for a specific action. |
Activate or Deactivate Property | This action activates or deactivates a property. |
Add Hostnames | This action adds hostnames to a property's hostname bucket on a specified network. |
Cancel Change | This action cancels a pending change. |
Clone Configuration Version | This action clones and creates a new version of the specified security configuration. |
Clone Property | This action clones an existing property under the specified contract and group. |
Create CP Code | This action creates a new CP code and assigns it to a product. |
Create Data Center | This action creates a data center within a specific GTM domain. |
Create Domain | This action creates a Global Traffic Management (GTM) domain. |
Create Edge Hostname | This action creates a new edge hostname. |
Create Enrollment | This action creates a new certificate enrollment. |
Create Group | This action creates a new group within the specified parent group. |
Create Match Target | This action creates a new match target in the specified configuration version. |
Create Property Version | This action creates a new version of a specific property. |
Get Activation Status | This action retrieves the status of a specific activation. |
Get Certificate History | This action retrieves the enrollment certificate history. |
Get Change Status | This action retrieves the details of a pending change. |
Get Domain Details | This action retrieves the details of a specific GTM domain. |
Get Edge Hostname | This action retrieves details of a specific edge hostname. |
Get Enrollment | This action retrieves the details of a specific enrollment. |
Get Enrollment by Common Name | This action retrieves the enrollment ID using the certificate enrollment common name. |
Get Enrollment Deployment | This action retrieves the enrollment deployment details. |
Get Group | This action retrieves the details of the specified group. |
Get GTM Property | This action gets details of a Global Traffic Management (GTM) property. |
Get PAPI Property by Name | This action retrieves a papi property within a group by its name. |
Get Pending Change | This action retrieves the detailed information of a pending change. |
Get Property Activation | This action retrieves details of a specific property activation. |
Get Property Details | This action retrieves the details of a specific property. |
Get Property Rule Tree | This action retrieves rules for a specific property version. |
Get Zone Record Sets | This action retrieves the DNS record sets for the specified zone. |
List Activation History | This action retrieves the activations for a specific configuration. |
List CIDR Blocks | This action retrieves the firewall CIDR blocks based on the provided filters. |
List Configurations | This action retrieves the list of configurations. |
List Domains | This action retrieves the list of GTM domains. |
List Enrollments | This action lists the names of each enrollment. |
List Groups | This action lists all the groups. |
List Hostnames for an Account | This action retrieves the list of active property hostnames for all properties available in an account. |
List Match Targets | This action lists match targets for a specific security configuration version. |
List Properties | This action lists the properties. |
List Property Activations | This action retrieves the activations of a specific property. |
List Security Policies | This action retrieves security policies for a specific configuration version. |
List Site Shield Maps | This action lists all site shield maps. |
List Zones | This action lists all the edge DNS zones. |
Modify Match Target | This action updates a match target for a specific configuration version. |
Modify Selected Hostnames | This action updates the selected hostnames for a given security policy in a configuration. |
Modify Version Notes | This action updates the version notes for a given configuration version. |
Patch Property Rule Tree | This action modifies the rule tree for a specific property version. |
Update Deployment Schedule | This action updates the deployment schedule for a specific enrollment change. |
Update Enrollment | This action updates an enrollment. |
Update Pending Change | This action updates a pending change. |
Update Property | This action updates a Global Traffic Management (GTM) property. |
Generic Action | This is a generic action used to make requests to any Akamai WAF endpoint. |
Configuration Parameters
The following configuration parameters are required for the Akamai Web Application Firewall (WAF) app to communicate with the Akamai Web Application Firewall (WAF) enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the base URL to access Akamai WAF. Example: https://akaa-wwwwwwwwwwww.luna.akamaiapis.net | Text | Required | |
EdgeGrid Client Token | Enter the EdgeGrid client token for authentication. | Password | Required | To generate authentication credentials, see Akamai Web Application Firewall documentation. |
EdgeGrid Client Secret | Enter the EdgeGrid client secret for authentication. | Password | Required | |
EdgeGrid Access Token | Enter the EdgeGrid client token for authentication. | Password | Required | |
Verify | Choose your preference to verify SSL or TLS while making requests. It is recommended to set this option to yes. Passing no may result in incorrectly establishing the connection. | Boolean | Optional | By default, verification is enabled. |
Timeout | Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with Akamai WAF. | Integer | Optional | Allowed range: 15-120 Default value: 15 |
Action: Activate Configuration Version
This action activates the activation configuration for a specific action.
Note
To use this action, you must have READ-WRITE access in the Application Security API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Action | Enter the action to take. | Text | Required | Allowed values: ACTIVATE, DEACTIVATE |
Activation Configs | Enter the security configuration and version information. Example: [{'configId': 1, 'configVersion': 4}] | Any | Required | Allowed keys: configId, configVersion |
Network | Enter the Akamai activation environment. | Text | Required | Allowed values: STAGING, PRODUCTION |
Note | Enter a note for the activation. Example: Sample activation note | Text | Required | |
Notification Emails | Enter the list of email addresses to send notifications on activation. | List | Required | |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Additional Fields | Enter any additional fields to pass to the API. | Key Value | Optional | Allowed keys: acknowledgedInvalidHosts, acknowledgedInvalidHostsByConfig |
Action: Activate or Deactivate Property
This action activates or deactivates a property.
Note
To use this action, you must have READ-WRITE access in the Property Manager API.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Property ID | Enter the unique identifier for the property. Example: prp_12345 | Text | Required | You can retrieve the property ID using the action List Properties. |
Property Version | Enter the version of the property to activate. Example: 1 | Integer | Required | |
Network | Enter the network to activate the property. Example: STAGING | Text | Required | Allowed values: STAGING, PRODUCTION |
Notify Emails | Enter the list of email addresses to notify when the activation status changes. Example: ["johndoe@orgname.com", "janedoe@orgname.com"] | List | Required | |
Use Prefixes | Choose true to include prefixes in the response. Choose false when exchanging PAPI data with other APIs. | Boolean | Optional | Default value: true |
Note | Enter a descriptive log comment. Example: sample activation | Text | Optional | |
Query Params | Enter the query parameters to make the request. | Key Value | Optional | Allowed keys: contractId, groupId, accountSwitchKey |
Additional Fields | Enter the additional fields to make the request. | Key Value | Optional | Allowed keys: acknowledgeAllWarnings, acknowledgeWarnings, activationType, delayValidations, fastPush, ignoreHttpErrors, useFastFallback |
Action: Add Hostnames
This action adds hostnames to a property's hostname bucket on a specified network.
Note
To use this action, you must have READ-WRITE access in the Property Manager API.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Property ID | Enter the unique identifier of the property. Example: prp_12345 | Text | Required | You can retrieve the property ID using the action List Properties. |
Network | Enter the network to activate the hostnames on. | Text | Required | Allowed values: STAGING, PRODUCTION |
Contract ID | Enter the unique identifier of the contract. This parameter is optional if the property belongs to a single contract. Example: ctr_K-0N7RAK71 | Text | Optional | |
Group ID | Enter the unique identifier of the group. This parameter is optional if the property belongs to a single group. Example: grp_54321 | Text | Optional | You can retrieve the group ID using the action List Groups. |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Add | Enter the list of objects representing the hostnames to add. Each object should include certProvisioningType, cnameFrom, cnameType, and edgeHostnameId. Example: [{"certProvisioningType": "default", "cnameFrom": "example.com", "cnameType": "edge_hostname", "edgeHostnameId": "ehn_12345"}] | List | Optional | |
Note | Enter a note to add hostnames. Example: sample hostname activation | Text | Optional | |
Notify Emails | Enter the list of email addresses to notify about activation status. | List | Optional | |
Use Prefixes | Choose true to include prefixes in the response. Choose false when exchanging PAPI data with other APIs. | Boolean | Optional | Default value: true |
Additional Fields | Enter the additional fields to make the request. | Key Value | Optional | Allowed key: remove |
Action: Cancel Change
This action cancels a pending change.
Note
To use this action, you must have READ-WRITE access in the Certificate Provisioning System API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enrollment ID | Enter the ID of the enrollment on which you want to perform this action. Example: 10000 | Text | Required | You can retrieve the enrollment ID using the action List Enrollments. |
Change ID | Enter the ID of the change to cancel. Example: 10000 | Text | Required | You can retrieve the change ID using the action List Enrollments. |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Clone Configuration Version
This action clones and creates a new version of the specified security configuration.
Note
To use this action, you must have READ-WRITE access in the Application Security API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Config ID | Enter the configuration ID. Example: 77653 | Text | Required | You can retrieve the config ID using the action List Configurations. |
Rule Update | Choose true to update the rules to the latest version. | Boolean | Required | |
Create from Version | Enter the version of the configuration to clone from. Example: 1 | Integer | Required | |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Clone Property
This action clones an existing property under the specified contract and group.
Note
To use this action, you must have READ-WRITE access in the Property Manager API.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Contract ID | Enter the unique identifier of the contract. Example: ctr_K-0N7RAK71 | Text | Required | |
Group ID | Enter the unique identifier of the group. Example: grp_67890 | Text | Required | You can retrieve the group ID using the action List Groups. |
Product ID | Enter the product ID of the property to clone. Example: prd_Alta | Text | Required | |
Property Name | Enter a unique and descriptive name for the cloned property. Example: my.new.property1.com | Text | Required | |
Use Prefixes | Choose true to include prefixes in the response. Choose false when exchanging PAPI data with other APIs. | Boolean | Optional | Default value: true |
Rule Format | Enter the rule format to assign to the property. Example: v2018-09-12 | Text | Optional | Default value: None |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Additional Fields | Enter the additional fields to make the request. | Key Value | Optional | Allowed keys: cloneFrom, useHostnameBucket |
Action: Create CP Code
This action creates a new CP code and assigns it to a product.
Note
To use this action, you must have READ-WRITE access in the Property Manager API.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Contract ID | Enter the unique identifier for the contract. Example: ctr_K-0N7RAK71 | Text | Required | |
Group ID | Enter the unique identifier for the group. Example: grp_67890 | Text | Required | You can retrieve the group ID using the action List Groups. |
CP Code Name | Enter the descriptive label for the CP code. Example: SME WAA | Text | Required | NoteYou cannot include commas, underscores, quotes, or special characters (^, #, %) in the name. |
Product ID | Enter the product ID. Example: prd_Web_App_Accel | Text | Required | |
Use Prefixes | Choose true to include prefixes in the response. Choose false when exchanging PAPI data with other APIs. | Boolean | Optional | Default value: true |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Create Data Center
This action creates a data center within a specific GTM domain.
Note
To use this action, you must have READ-WRITE access in the Traffic Management Configurations API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain Name | Enter the name of the domain where the data center will be created. Example: example.akadns.net | Text | Required | |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
City | Enter the city where the data center is located. Example: Doune | Text | Optional | |
Clone of | Enter the ID of the source data center from which this data center is cloned. This data center inherits geographic attributes from its source, including continent, country, state, city, latitude, and longitude. | Integer | Optional | Default value is 0, indicating no cloning. |
Country | Enter the two-letter ISO 3166 country code for the country associated with the data center. Example: GB | Text | Optional | |
Default Load Object | Enter the load reporting interface information. | Any | Optional | Allowed keys: loadObject, loadObjectPort, loadServers |
Additional Fields | Enter the additional fields to make the request. | Key Value | Optional | Allowed keys: latitude, longitude, links, cloudServerTargeting, continent, nickname, stateOrProvince |
Action: Create Domain
This action creates a Global Traffic Management (GTM) domain.
Note
To use this action, you must have READ-WRITE access in the Traffic Management Configurations API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
CIDR Maps | Enter the CIDR map information to be assigned to the domain. | Any | Required | Allowed keys: assignments, defaultDatacenter, links, name |
Data Centers | Enter the information about the set of data centers assigned to this domain. | Any | Required | Allowed keys: city, country, continent, cloneOf, cloudServerTargeting, defaultLoadObject, latitude, links, longitude, nickname, stateOrProvince |
Default Error Penalty | Enter the download penalty score. | Integer | Required | |
Default SSL Client Certificate | Enter the Base64-encoded certificate for TLS-based liveness tests. | Text | Required | |
Default SSL Client Private Key | Enter the Base64-encoded private key for TLS-based liveness tests. | Password | Required | |
Default Timeout Penalty | Enter the timeout penalty score (in seconds) used to determine the impact of a timed-out download. | Integer | Required | Default value: 25 |
Email Notification List | Enter the list of email addresses to notify when a change is made to the domain. | List | Required | |
Geographic Maps | Enter details about the geographic map set assigned to this domain. | Any | Required | Allowed keys: assignments, defaultDatacenter, links, name |
Load Feedback | Choose true to indicate that load feedback is being used to manage load balancing, which controls the traffic load based on the data center's capacity. | Boolean | Required | |
Load Imbalance Percentage | Enter the percentage of the Load Imbalance Factor (LIF) for the domain. | Float | Required | Allowed range: 0 - 1000000 Default value: 10 |
Modification Comments | Enter a descriptive note about the changes to the domain within 4000 characters. | Text | Required | |
Name | Enter the full GTM domain name, ending in .akadns.net within 100 characters. Example: example.akadns.net | Text | Required | |
Properties | Enter the properties for the GTM domain. | Any | Required | Allowed keys: backupCname, backuIp, cname, balanceByDownloadScore, comments, dynamicTTL, failbackDelay, failoverDelay, handoutMode, healthMax, healthMultiplier, healthThreshold, ipv6, lastModified, links, livenessTests, loadImbalancePercentage, mapName, maxUnreachablePenalty, mxRecords, name, scoreAggregationType, staticTTL, stickinessBonusConstant, stickinessBonusPercentage, trafficTargets, type, unreachableThreshold, useComputedTargets |
Type | Enter the type of domain based on your contract. | Text | Required | Allowed values: failover-only, static, weighted, basic, full |
Resources | Enter the resources for the GTM domain. | Any | Optional | Allowed keys: aggregationType, comments, constrainedProperty, decayRate, description, hostHeader, leaderString, leastSquaresDecay, links, loadImbalancePercentage, maxUMultiplicativeIncrement, name, resourceInstances, type, upperBound |
Query Params | Enter the query parameters to make the request. | Key Value | Optional | Allowed keys: contractId, gid, accountSwitchKey |
Additional Fields | Enter the additional fields to make the request. | Key Value | Optional | Allowed keys: link, status |
Action: Create Edge Hostname
This action creates a new edge hostname.
Note
To use this action, you must have READ-WRITE access in the Property Manager API.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Contract ID | Enter the unique identifier for the contract. Example: ctr_12345 | Text | Required | |
Group ID | Enter the unique identifier for the group. Example: grp_67890 | Text | Required | You can retrieve the group ID using the action List Groups. |
Domain Prefix | Enter the origin domain portion of the edge hostname. Example: www.example.com | Text | Required | |
Domain Suffix | Enter the Akamai-specific portion of the edge hostname. Example: edgesuite.net | Text | Required | |
IP Version Behavior | Enter the version of the IP protocol to use. | Text | Optional | Allowed values: IPV4, IPV6_COMPLIANCE Default value: IPV4 |
Product ID | Enter the ID of the product to create the edge hostname. Example: prd_dynamic_site_del | Text | Optional | |
Use Prefixes | Choose true to include prefixes in the response. Choose false when exchanging PAPI data with other APIs. | Boolean | Optional | Default value: true |
Use Cases | Enter a list of use case objects. Example: [{'option': 'background', 'type': 'global', 'usecase': 'download_mode'}] | Any | Optional | Allowed keys: option, type, useCase |
Query Params | Enter the query parameters to make the request. | Key Value | Optional | Allowed keys: options, accountSwitchKey |
Action: Create Enrollment
This action creates a new certificate enrollment.
Note
To use this action, you must have READ-WRITE access in the Certificate Provisioning System API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Certificate Type | Enter the type of the certificate. for example, san | Text | Required | Allowed values: san, single, wildcard, wildcard-san, third-party |
Change Management | Choose true to prevent the Certificate Provisioning System (CPS) from deploying the certificate to the network until you confirm that you are ready for deployment. | Boolean | Required | |
CSR | Enter the Certificate Signing Request (CSR) to create the enrollment. | Any | Required | Allowed keys: c, cn, l, o, ou, preferredTrustChain, sans, st |
Enable Multi Stacked Certificates | Choose true to enable dual-stacked certificate deployment for this enrollment. | Boolean | Required | |
Network Configuration | Enter the network configuration settings for the certificate. | Any | Required | Allowed keys: clientMutualAuthentication, disallowedTlsVersions, dnsNameSettings, fipsMode, geography, mustHaveCiphers, ocspStapling, preferredCiphers, quicEnabled, secureNetwork, sniOnly |
RA | Enter the registration authority or certificate authority (CA) for the certificate enrollment. | Text | Required | Allowed values: symantec, lets-encrypt, third-party |
Validation Type | Enter the type of the validation. | Text | Required | Allowed values: dv, ev, ov, third-party |
Contract ID | Enter the contract ID you want to operate on or view. Example: K-0N7RAK7 | Text | Required | |
Query Params | Enter the query parameters to create enrollment. | Key Value | Optional | Allowed keys: deploy-not-after, deploy-not-before, accountSwitchKey |
Additional Fields | Enter the additional fields to create enrollment. | Key Value | Optional | Allowed keys: adminContact, assigneslots, autoRenewalStartTime, certificateChainType, id, location, maxAllowedSanNames, maxAllowedWildcardSanNames, org, orgId, pendingChanges, productionSlots, signatureAlgorithm, stagingSlots, techContact, thirdParty |
Action: Create Group
This action creates a new group within the specified parent group.
Note
To use this action, you must have ADMIN access in the Identity Management: User Administration API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Group ID | Enter the ID of the parent group where you want to create the new group. Example: 54321 | Text | Required | You can retrieve the group ID using the action List Groups. |
Group Name | Enter the name of the new group. Example: digital company | Text | Required | |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Create Match Target
This action creates a new match target in the specified configuration version.
Note
To use this action, you must have READ-WRITE access in the Application Security API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Config ID | Enter the configuration ID. Example: 77653 | Text | Required | You can retrieve the config ID using the action List Configurations. |
Version Number | Enter the version number of the configuration. Example: 25 | Text | Required | |
Security Policy ID | Enter the security policy ID associated with the match target. Example: fwsf_32432 | Text | Required | You can retrieve the security policy ID using the action List Security Policies. |
Target Type | Enter the type of the match target. Example: website | Text | Required | Allowed values: website, api |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Additional Fields | Enter any additional fields to pass to the API. | Key Value | Optional | Allowed keys: apis, bypassNetworkLists, defaultFile, fileExtensions, filePaths, hostnames, isNegativeFileExtensionMatch, isNegativePathMatch, sequence, targetId, type |
Action: Create Property Version
This action creates a new version of a specific property.
Note
To use this action, you must have READ-WRITE access in the Property Manager API.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Property ID | Enter the ID of the property. Example: prp_12345 | Text | Required | You can retrieve the property ID using the action List Properties. |
Create from Version | Enter the version number to create the new version from. Example: 1 | Integer | Required | |
Contract ID | Enter the contract ID for the property. | Text | Optional | |
Group ID | Enter the group ID for the property. | Text | Optional | You can retrieve the group ID using the action List Groups. |
Create from Version Etag | Enter the etag for the version to create the new version from. Example: 2641910c585cf67b | Text | Optional | |
Use Prefixes | Choose true to include prefixes in the response. Choose false when exchanging PAPI data with other APIs. | Boolean | Optional | Default value: true |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Get Activation Status
This action retrieves the status of a specific activation.
Note
To use this action, you must have READ-WRITE access in the Application Security API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Activation ID | Enter the ID of the activation. Example: 1234 | Text | Required | You can retrieve the activation ID using the action List Activation History. |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Get Certificate History
This action retrieves the enrollment certificate history.
Note
To use this action, you must have READ-WRITE access in the Certificate Provisioning System API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enrollment ID | Enter the ID of the enrollment for which you want to retrieve the history details. Example: 10000 | Text | Required | You can retrieve the enrollment ID using the action List Enrollments. |
Include All | Choose true to include all changes or certificates in the response. | Boolean | Optional | Default value: false |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Get Change Status
This action retrieves the details of a pending change.
Note
To use this action, you must have READ-WRITE access in the Certificate Provisioning System API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enrollment ID | Enter the ID of the enrollment associated with the change. Example: 10000 | Text | Required | You can retrieve the enrollment ID using the action List Enrollments. |
Change ID | Enter the ID of the change associated with the enrollment. Example: 10000 | Text | Required | You can retrieve the change ID using the action List Enrollments. |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Get Domain Details
This action retrieves the details of a specific GTM domain.
Note
To use this action, you must have READ-WRITE access in the Traffic Management Configurations API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain Name | Enter the name of the domain to retrieve details for. Example: example.akadns.net | Text | Required | You can retrieve the domain name using the action List Domains. |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Get Edge Hostname
This action retrieves details of a specific edge hostname.
Note
To use this action, you must have READ-WRITE access in the Property Manager API.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Edge Hostname ID | Enter the unique identifier for the edge hostname. Example: ehn_887436 | Text | Required | |
Contract ID | Enter the unique identifier for the contract. Example: ctr_12345 | Text | Required | |
Group ID | Enter the unique identifier for the group. Example: grp_67890 | Text | Required | You can retrieve the group ID using the action List Groups. |
Options | Enter any additional options for the request. | Text | Optional | Allowed value: mapDetails |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Use Prefixes | Choose true to include prefixes in the response. Choose false when exchanging PAPI data with other APIs. | Boolean | Optional | Default value: true |
Action: Get Enrollment
This action retrieves the details of a specific enrollment.
Note
To use this action, you must have READ-WRITE access in the Certificate Provisioning System API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enrollment ID | Enter the ID of the enrollment to retrieve its details. Example: 10000 | Text | Required | You can retrieve the enrollment ID using the action List Enrollments. |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Get Enrollment by Common Name
This action retrieves the enrollment ID using the certificate enrollment common name.
Note
To use this action, you must have READ-WRITE access in the Certificate Provisioning System API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Contract ID | Enter the ID of the contract on which you want to view enrollment. Example: K-0N7RAK7 | Text | Required | |
Common Name | Enter the common name of the certificate enrollment. | Text | Required | |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Get Enrollment Deployment
This action retrieves the enrollment deployment details.
Note
To use this action, you must have READ-WRITE access in the Certificate Provisioning System API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enrollment ID | Enter the ID of the enrollment for which you want to retrieve deployment details. | Text | Required | You can retrieve the enrollment ID using the action List Enrollments. |
Environment | Enter the environment where the certificate is deployed. | Text | Required | Allowed values: PRODUCTION, STAGING |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Get Group
This action retrieves the details of the specified group.
Note
To use this action, you must have ADMIN access in the Identity Management: User Administration API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Group ID | Enter the ID of the user group. Example: 54321 | Text | Required | You can retrieve the group ID using the action List Groups. |
Actions | Choose true to include information about actions in the response. | Boolean | Optional | Default value: false |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Get GTM Property
This action gets details of a global traffic management (GTM) property.
Note
To use this action, you must have READ-WRITE access in the Traffic Management Configurations API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain Name | Enter the GTM domain name. Example: example.akadns.net | Text | Required | You can retrieve the domain name using the action List Domains. |
Property Name | Enter the unique name of the property. This forms a valid RFC 1123 hostname when joined with the domain name. | Text | Required | |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Get PAPI Property by Name
This action retrieves a PAPI property within a group by its name.
Note
To use this action, you must have READ-WRITE access in the Property Manager API.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Contract ID | Enter the unique identifier for the contract. Example: ctr_12345 | Text | Required | Default value: None |
Group ID | Enter the unique identifier for the group. Example: grp_67890 | Text | Required | You can retrieve the group ID using the action List Groups. Default value: None |
Property Name | Enter the name of the property to retrieve. Example: property_abc | Text | Required | You can retrieve the property name using the action List Properties. Default value: None |
Action: Get Pending Change
This action retrieves the detailed information of a pending change.
Note
To use this action, you must have READ-WRITE access in the Certificate Provisioning System API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enrollment ID | Enter the ID of the enrollment on which to retrieve the information. Example: 10000 | Text | Required | You can retrieve the enrollment ID using the action List Enrollments. |
Change ID | Enter the ID of the change associated with the enrollment. Example: 10000 | Text | Required | You can retrieve the enrollment ID using the action List Enrollments. |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Allowed Input Type | Enter the value for the allowed input type. | Text | Required | Allowed values: change-management-info, lets-encrypt-challenges, post-verification-warnings, pre-verification-warnings, third-party-csr |
Action: Get Property Activation
This action retrieves details of a specific property activation.
Note
To use this action, you must have READ-WRITE access in the Property Manager API.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Property ID | Enter the unique identifier for the property. Example: prp_12345 | Text | Required | You can retrieve the property ID using the action List Properties. |
Activation ID | Enter the unique identifier for the activation. Example: act_67890 | Text | Required | You can retrieve the activation ID using the action List Activation History. |
Contract ID | Enter the unique identifier for the contract. Example: ctr_12345 | Text | Optional | |
Group ID | Enter the unique identifier for the group. Example: grp_67890 | Text | Optional | You can retrieve the group ID using the action List Groups. |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Use Prefixes | Choose true to include prefixes in the response. Choose false when exchanging PAPI data with other APIs. | Boolean | Optional | Default value: true |
Action: Get Property Details
This action retrieves the details of a specific property.
Note
To use this action, you must have READ-WRITE access in the Property Manager API.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Property ID | Enter the ID of the property. Example: prp_12345 | Text | Required | You can retrieve the property ID using the action List Properties. |
Contract ID | Enter the contract ID for the property. Example: ctr_k-0n7rak71 | Text | Optional | |
Group ID | Enter the group ID for the property. Example: grp_54321 | Text | Optional | You can retrieve the group ID using the action List Groups. |
Use Prefixes | Choose true to include prefixes in the response. Choose false when exchanging PAPI data with other APIs. | Boolean | Optional | Default value: true |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Get Property Rule Tree
This action retrieves rules for a specific property version.
Note
To use this action, you must have READ-WRITE access in the Property Manager API.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Property ID | Enter the unique identifier for the property. Example: prp_12345 | Text | Required | You can retrieve the property ID using the action List Properties. |
Property Version | Enter the version number of the property. Example: 1 | Integer | Required | |
Contract ID | Enter the unique identifier for the contract. Example: ctr_12345 | Text | Optional | |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5c0ylb:1-8byux | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Query Params | Enter the query parameters to make the request. | Key Value | Optional | Allowed keys: groupId, validateRules, validateMode, originalInput |
Action: Get Zone Record Sets
This action retrieves the DNS record sets for the specified zone.
Note
To use this action, you must have READ-WRITE access in the DNS—Zone Record Management API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Zone | Enter the name of the zone. Example: example.com | Text | Required | |
Page | Enter the page number to retrieve results from. Example: 20 | Integer | Optional | Default value: 1 |
Page Size | Enter the number of results to retrieve on each page. Example: 25 | Integer | Optional | Default value: 25 |
Show All | Choose true to retrieve the entire list, disabling paging and sorting. | Boolean | Optional | Default value: false |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Query Params | Enter the extra parameters to make the request. | Key Value | Optional | Allowed keys: sortby, types, search |
Action: List Activation History
This action retrieves the activations for a specific configuration.
Note
To use this action, you must have READ-WRITE access in the Application Security API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Config ID | Enter the configuration ID. Example: 77653 | Text | Required | You can retrieve the config ID using the action List Configurations. |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: List CIDR Blocks
This action retrieves the firewall CIDR blocks based on the provided filters.
Note
To use this action, you must have READ-WRITE access in the Firewall Rules Notification API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Last Action | Enter the last action taken on the CIDR block to filter the response. | Text | Optional | Allowed values: all, add, update, delete Default value: all |
Effective After Date | Enter the ISO 8601 date to filter the list for CIDR blocks with an effective date after this value. Example: 2021-02-21 | Text | Optional |
Action: List Configurations
This action retrieves the list of configurations.
Note
To use this action, you must have READ-WRITE access in the Application Security API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: List Domains
This action retrieves the list of GTM domains.
Note
To use this action, you must have READ-WRITE access in the Traffic Management Configurations API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: List Enrollments
This action lists the names of each enrollment.
Note
To use this action, you must have READ-WRITE access in the Certificate Provisioning System API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Contract ID | Enter the ID of the contract on which to operate or view enrollments. Example: K-0N7RAK7 | Text | Required | |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: List Groups
This action lists all the groups.
Note
To use this action, you must have ADMIN access in the Identity Management: User Administration API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Actions | Choose true to include information about actions in the response. | Boolean | Optional | Default value: false |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: List Hostnames for an Account
This action retrieves the list of active property hostnames for all properties available in an account.
Note
To use this action, you must have READ-WRITE access in the Property Manager API.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Contract ID | Enter the contract ID for the request. | Text | Optional | |
Group ID | Enter the group ID for the request. | Text | Optional | You can retrieve the group ID using the action List Groups. |
Use Prefixes | Choose true to include prefixes in the response. Choose false when exchanging PAPI data with other APIs. | Boolean | Optional | Default value: true |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Query Params | Enter the query parameters to make the request. | Key Value | Optional | Allowed keys: offset, limit, sort, hostname, cnameTo, network |
Action: List Match Targets
This action lists match targets for a specific security configuration version.
Note
To use this action, you must have READ-WRITE access in the Application Security API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Config ID | Enter the configuration ID. Example: 77653 | Text | Required | You can retrieve the config ID using the action List Configurations. |
Version Number | Enter the version number of the configuration. Example: 25 | Text | Required | |
Policy ID | Enter the policy ID to filter match targets. Example: abc_123456 | Text | Optional | You can retrieve the policy ID using the action List Security Policies. |
Include Child Object Name | Choose true to retrieve the child object name in the response. | Boolean | Optional | Default value: true |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: List Properties
This action lists the properties.
Note
To use this action, you must have READ-WRITE access in the Property Manager API.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Contract ID | Enter the unique identifier for the contract. Example: ctr_12345 | Text | Required | Default value: None |
Group ID | Enter the unique identifier for the group. Example: grp_67890 | Text | Required | You can retrieve the group ID using the action List Groups. Default value: None |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Use Prefixes | Choose true to include prefixes in the response. Choose false when exchanging PAPI data with other APIs. | Boolean | Optional | Default value: true |
Query Params | Enter the query parameters to make the request. | Key Value | Optional | Allowed keys: modifiedSince, modifiedNetwork |
Action: List Property Activations
This action retrieves the activations of a specific property.
Note
To use this action, you must have READ-WRITE access in the Property Manager API.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Property ID | Enter the ID of the property. | Text | Required | You can retrieve the property ID using the action List Properties. |
Contract ID | Enter the contract ID for the property. | Text | Optional | |
Group ID | Enter the group ID for the property. | Text | Optional | You can retrieve the group ID using the action List Groups. |
Use Prefixes | Choose true to include prefixes in the response. choose false when exchanging PAPI data with other APIs. | Boolean | Optional | Default value: True |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: List Security Policies
This action retrieves security policies for a specific configuration version.
Note
To use this action, you must have READ-WRITE access in the Application Security API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Config ID | Enter the configuration ID. Example: 77653 | Text | Required | You can retrieve the config ID using the action List Configurations. |
Version Number | Enter the version number of the configuration. Example: 25 | Text | Required | |
Not Matched | Choose true to list security policies without a match target in the configuration version. Choose false to list all security policies. | Boolean | Optional | Default value: False |
Detail | Choose true to retrieve detailed information on the version in the response. If you choose false, this action returns the summary. | Boolean | Optional | Default value: False |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: List Site Shield Maps
This action lists all site shield maps.
Note
To use this action, you must have READ-WRITE access in the Site Shield API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: List Zones
This action lists all the edge DNS zones.
Note
To use this action, you must have READ-WRITE access in the DNS—Zone Record Management API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Contract IDs | Enter one or more contract IDs to filter the response. Example: K-0N7RAK7 | Text | Optional | |
Search | Enter the query to filter the response. Example: org | Text | Optional | |
Page | Enter the page number to retrieve results from. Example: 20 | Integer | Optional | Default value: 1 |
Page Size | Enter the number of results to retrieve on each page. Example: 25 | Integer | Optional | Default value: 25 |
Show All | Choose true to retrieve the entire list, disabling paging and sorting. | Boolean | Optional | Default value: false |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Query Params | Enter the query parameters to make the request. | Key Value | Optional | Allowed keys: sortBy, subzoneGrants, types |
Action: Modify Match Target
This action updates a match target for a specific configuration version.
Note
To use this action, you must have READ-WRITE access in the Application Security API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Config ID | Enter the configuration ID. Example: 77653 | Text | Required | You can retrieve the config ID using the action List Configurations. |
Version Number | Enter the version number of the configuration. Example: 25 | Text | Required | |
Target ID | Enter the ID of the match target. Example: 112231 | Text | Required | You can retrieve the target ID using the action List Match Targets. |
Security Policy ID | Enter the security policy associated with the match target. Example: fwsf_32432 | Key Value | Required | You can retrieve the security policy ID using the action List Security Policies. |
Target Type | Enter the type of the match target. Example: website | Text | Required | Allowed values: website, api |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Additional Fields | Enter any additional fields to pass to the API. | Key Value | Optional | Allowed keys: apis, bypassNetworkLists, configversion, defaultFile, fileExtensions, filePaths, hostnames, isNegativeFileExtensionMatch, isNegativePathMatch, sequence |
Action: Modify Selected Hostnames
This action updates the selected hostnames for a given security policy in a configuration.
Note
To use this action, you must have READ-WRITE access in the Application Security API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Config ID | Enter the configuration ID. Example: 77653 | Text | Required | You can retrieve the config ID using the action List Configurations. |
Version Number | Enter the version number of the configuration. Example: 25 | Text | Required | |
Policy ID | Enter the ID of the security policy. Example: bobf_19288 | Text | Required | You can retrieve the policy ID using the action List Security Policies. |
Mode | Enter the type of the update. Example: append | Text | Required | Allowed values: append, remove, replace |
Hostname List | Enter the list of hostnames to be updated. Example: ["*.example.net", "api.example.com"]. | List | Required | |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Modify Version Notes
This action updates the version notes for a given configuration version.
Note
To use this action, you must have READ-WRITE access in the Application Security API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Config ID | Enter the configuration ID. Example: 77653 | Text | Required | You can retrieve the config ID using the action List Configurations. |
Version Number | Enter the version number of the configuration. Example: 25 | Text | Required | |
Notes | Enter the version notes to be added. Example: This is a version note | Text | Required | |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Patch Property Rule Tree
This action modifies the rule tree for a specific property version.
Note
To use this action, you must have READ-WRITE access in the Property Manager API.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Property ID | Enter the ID of the property to be patched. Example: prp_12345 | Text | Required | You can retrieve the property ID using the action List Properties. |
Property Version | Enter the incremental version number of the property. Example: 3 | Integer | Required | |
Updates | Enter the list of updates to apply to the property rules. Each update must include the operation ('op'), target path ('path'), and updated value ('value'). Example: [{ "op": "replace", "path": "/rules/options/is_secure", "value": true }] | Any | Required | |
Use Prefixes | Choose true to include prefixes in the response. Choose false when exchanging PAPI data with other APIs. | Boolean | Optional | Default value: true |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Query Params | Enter the query parameters to make the request. | Key Value | Optional | Allowed keys: contractId, groupId, validateRules, validateMode, dryRun, originalInput, upgradeRules |
Action: Update Deployment Schedule
This action updates the deployment schedule for a specific enrollment change.
Note
To use this action, you must have READ-WRITE access in the Certificate Provisioning System API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enrollment ID | Enter the ID of the enrollment for which you want to update the deployment schedule. Example: 10000 | Text | Required | You can retrieve the enrollment ID using the action List Enrollments. |
Change ID | Enter the id of the change associated with the enrollment. Example: 10000 | Text | Required | You can retrieve the enrollment ID using the action List Enrollments. |
Not Before | Enter the earliest time (in ISO 8601 format) to schedule the deployment. If not specified, the change will take effect immediately. Example: 2017-05-19T16:00:00Z | Text | Optional | |
Not After | Enter the latest time (in ISO 8601 format) after which the deployment cannot be scheduled. Example: 2017-05-19T16:00:00 | Text | Optional | |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Update Enrollment
This action updates an enrollment.
Note
To use this action, you must have READ-WRITE access in the Certificate Provisioning System API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enrollment ID | Enter the ID of the enrollment to update. Example: 10000 | Text | Required | You can retrieve the enrollment ID using the action List Enrollments. |
Certificate Type | Enter the type of the certificate. Example: san | Text | Required | Allowed values: san, single, wildcard, wildcard-san, third-party |
Change Management | Choose true to prevent the certificate provisioning system (CPS) from deploying the certificate to the network until you confirm that you are ready for deployment. | Boolean | Required | |
CSR | Enter the certificate signing request (CSR) to update the enrollment. | Any | Required | Allowed keys: c, cn, l, o, ou, preferredTrustChain, sans, st |
Enable Multi Stacked Certificates | Choose true to enable dual-stacked certificate deployment for this enrollment. | Boolean | Required | |
Network Configuration | Enter the network configuration settings for the certificate. | Any | Required | Allowed keys: clientMutualAuthentication, disallowedTlsVersions, dnsNameSettings, fipsMode, geography, mustHaveCiphers, ocspStapling, preferredCiphers, quicEnabled, secureNetwork, sniOnly |
RA | Enter the registration authority or certificate authority (CA) for the certificate enrollment. | Text | Required | Allowed values: symantec, lets-encrypt, third-party |
Validation Type | Enter the type of the validation. | Text | Required | Allowed values: dv, ev, ov, third-party |
Query Params | Enter the extra parameters to update enrollment. | Key Value | Optional | Allowed keys: deploy-not-after, deploy-not-before, accountSwitchKey |
Additional Fields | Enter the additional fields to update enrollment. | Key Value | Optional | Allowed keys: adminContact, assigneslots, autoRenewalStartTime, certificateChainType, id, location, maxAllowedSanNames, maxAllowedWildcardSanNames, org, orgId, pendingChanges, productionSlots, signatureAlgorithm, stagingSlots, techContact, thirdParty |
Action: Update Pending Change
This action updates a pending change.
Note
To use this action, you must have READ-WRITE access in the Certificate Provisioning System API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enrollment ID | Enter the ID of the enrollment on which you want to update the change. Example: 10000 | Integer | Required | You can retrieve the enrollment ID using the action List Enrollments. |
Change ID | Enter the ID of the change associated with the enrollment. Example: 10000 | Integer | Required | You can retrieve the change ID using the action List Enrollments. |
Allowed Input Type | Enter the value for the allowed input type. | Text | Required | Allowed values: change-management-ack, lets-encrypt-challenges-completed, post-verification-warnings-ack, pre-verification-warnings-ack, third-party-cert-and-trust-chain |
Acknowledgment | Enter the state for which this acknowledgment is submitted. | Text | Required | Allowed values: acknowledge, deny |
Hash | Enter the hash value of the state you want to acknowledge. Example: 24fb6fb91d290370c13a39e76afc1b26 | Text | Required | |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Update Property
This action updates a global traffic management (GTM) property.
Note
To use this action, you must have READ-WRITE access in the Traffic Management Configurations API service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain Name | Enter the GTM domain name. Example: example.akadns.net | Text | Required | You can retrieve the domain name using the action List Domains. |
Property Name | Enter the unique name of the property. This forms a valid RFC 1123 hostname when joined with the domain name. | Text | Required | |
Updates | Enter a dictionary with the fields to update. Example: {"dynamicttl": 300, "backupcname": "backup.example.com"}. | Key Value | Required | |
Account Switch Key | Enter the account switch key to perform this action from a different account. Example: 1-5C0YLB:1-8BYUX | Text | Optional | For more information, see Akamai Web Application Firewall documentation. |
Action: Generic Action
This is a generic action used to make requests to any Akamai WAF endpoint.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Method | Enter the HTTP method to make the request. | Text | Required | Allowed values: GET, PUT, POST, DELETE |
Endpoint | Enter the endpoint to make the request to. Example: appsec/v1/configs | Text | Required | |
Query Params | Enter the query parameters to pass to the API. | Key Value | Optional | |
Payload | Enter the payload to pass to the API. | Any | Optional | |
Additional Fields | Enter the additional fields to pass to the API. | Key Value | Optional | Allowed keys: headers, payload_json, download, files, filename, retry_wait, retry_count, custom_output, response_type |