name: Akamai WAF display: Akamai WAF category: Network Security provider: Akamai Technologies commonfields: id: Akamai WAF version: -1 sectionorder: - Connect - Collect configuration: - defaultvalue: https://example.net display: Server URL (e.g., https://example.net) name: host required: true type: 0 section: Connect - display: Client token name: clientToken type: 4 hidden: true required: false section: Connect - display: Access token name: accessToken type: 4 hidden: true required: false section: Connect - display: Client secret name: clientSecret type: 4 hidden: true required: false section: Connect - displaypassword: Client token name: credentials_client_token hiddenusername: true type: 9 required: false display: '' section: Connect - displaypassword: Access token name: credentials_access_token hiddenusername: true type: 9 required: false display: '' section: Connect - displaypassword: Client secret name: credentials_client_secret hiddenusername: true type: 9 required: false display: '' section: Connect - display: Trust any certificate (not secure) name: insecure type: 8 required: false section: Connect advanced: true - display: Use system proxy settings name: proxy type: 8 required: false section: Connect advanced: true description: |- Use the Akamai WAF integration to manage common sets of lists used by various Akamai security products and features. This is the modified version where a new command "akamai-update-network-list-elements" was added by the SA. script: commands: - arguments: - auto: PREDEFINED description: The network list type by which to filter the results. name: list_type predefined: - IP - GEO - description: The query by which to search for list names and list items. name: search - auto: PREDEFINED defaultValue: 'true' description: When 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. name: extended predefined: - 'true' - 'false' - auto: PREDEFINED defaultValue: 'false' description: If 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. name: include_elements predefined: - 'true' - 'false' description: Deprecated. Use “akamai-get-client-list” instead. name: akamai-get-network-lists deprecated: true outputs: - contextPath: Akamai.NetworkLists.Lists.Name description: The network list name. type: String - contextPath: Akamai.NetworkLists.Lists.Type description: The network list type. type: String - contextPath: Akamai.NetworkLists.Lists.UniqueID description: The network list unique ID. type: String - contextPath: Akamai.NetworkLists.Lists.ElementCount description: The number of network list elements. type: String - contextPath: Akamai.NetworkLists.Lists.CreateDate description: The network list creation date. type: Date - contextPath: Akamai.NetworkLists.Lists.CreatedBy description: The network list creator. type: String - contextPath: Akamai.NetworkLists.Lists.ExpeditedProductionActivationStatus description: The expedited production activation status. type: String - contextPath: Akamai.NetworkLists.Lists.ExpeditedStagingActivationStatus description: The expedited staging activation status. type: String - contextPath: Akamai.NetworkLists.Lists.ProductionActivationStatus description: The production activation status. type: String - contextPath: Akamai.NetworkLists.Lists.StagingActivationStatus description: The staging activation status. type: String - contextPath: Akamai.NetworkLists.Lists.UpdateDate description: The date that the network list was updated. type: String - contextPath: Akamai.NetworkLists.Lists.UpdatedBy description: The last user that updated the network list. type: String - contextPath: Akamai.NetworkLists.Lists.Elements description: The elements in the network list. type: String - arguments: - description: The network list ID. name: network_list_id required: true description: Deprecated. Use “akamai-get-client-list” instead. name: akamai-get-network-list-by-id deprecated: true outputs: - contextPath: Akamai.NetworkLists.Lists.Name description: The network list name. type: String - contextPath: Akamai.NetworkLists.Lists.Type description: The network list type. type: String - contextPath: Akamai.NetworkLists.Lists.UniqueID description: The network list unique ID. type: String - contextPath: Akamai.NetworkLists.Lists.ElementCount description: The number of network list elements. type: Number - contextPath: Akamai.NetworkLists.Lists.CreateDate description: The network list creation date. type: Date - contextPath: Akamai.NetworkLists.Lists.CreatedBy description: The network list creator. type: String - contextPath: Akamai.NetworkLists.Lists.ExpeditedProductionActivationStatus description: The expedited production activation status. type: String - contextPath: Akamai.NetworkLists.Lists.ExpeditedStagingActivationStatus description: The expedited staging activation status. type: String - contextPath: Akamai.NetworkLists.Lists.ProductionActivationStatus description: The production activation status. type: String - contextPath: Akamai.NetworkLists.Lists.StagingActivationStatus description: The staging activation status. type: String - contextPath: Akamai.NetworkLists.Lists.UpdateDate description: The network list update date. type: String - contextPath: Akamai.NetworkLists.Lists.UpdatedBy description: The last user who updated the network list. type: String - contextPath: Akamai.NetworkLists.Lists.Elements description: The elements in the network list. type: String - arguments: - description: The network list name. name: list_name required: true - auto: PREDEFINED description: The network list type. name: list_type predefined: - IP - GEO required: true - description: The network list elements. isArray: true name: elements - description: The War Room entry ID of the sample file. name: entry_id - description: The network list description. name: description description: Deprecated. Use “akamai-create-client-list” instead. name: akamai-create-network-list deprecated: true outputs: - contextPath: Akamai.NetworkLists.Lists.Name description: The network list name. type: String - contextPath: Akamai.NetworkLists.Lists.UniqueID description: The network list ID. type: String - contextPath: Akamai.NetworkLists.Lists.Type description: The network list type. type: String - contextPath: Akamai.NetworkLists.Lists.ElementCount description: The number of elements in the list. type: Number - contextPath: Akamai.NetworkLists.Lists.Elements description: The elements in the list. type: String - arguments: - description: The ID of the network list to delete. name: network_list_id required: true description: Deprecated. Use “akamai-deprecate-client-list” instead. name: akamai-delete-network-list deprecated: true - arguments: - description: 'A comma-separated list of network list IDs to activate. For example: list (list1,list2).' isArray: true name: network_list_ids required: true - auto: PREDEFINED description: The environment type to activate the network list. name: env predefined: - STAGING - PRODUCTION required: true - description: A comment to be logged. name: comment - description: A comma-separated list of email addresses. isArray: true name: notify description: Deprecated. Use “akamai-activate-client-list” instead. name: akamai-activate-network-list deprecated: true - arguments: - description: The ID of the network where elements will be added. name: network_list_id required: true - description: The War Room entry ID of the sample file. name: entry_id - description: A comma-separated list of elements to be added to the network list. isArray: true name: elements description: Deprecated. Use “akamai-add-client-list-entry” instead. name: akamai-add-elements-to-network-list deprecated: true - arguments: - description: The ID of the network list from which elements are removed. name: network_list_id required: true - description: The element to remove from the network list. name: element required: true description: Deprecated. Use “akamai-remove-client-list-entry” instead. name: akamai-remove-element-from-network-list deprecated: true - arguments: - description: 'A comma-separated list of network list IDs, to check the activation status. For example: support list - list1,list2.' isArray: true name: network_list_ids required: true - auto: PREDEFINED description: The environment type. name: env predefined: - PRODUCTION - STAGING required: true description: Deprecated. There is no replacement for this command. name: akamai-get-network-list-activation-status deprecated: true outputs: - contextPath: Akamai.NetworkLists.ActivationStatus.UniqueID description: The network list ID. type: String - contextPath: Akamai.NetworkLists.ActivationStatus.StagingStatus description: The network list environment staging activation status. type: String - contextPath: Akamai.NetworkLists.ActivationStatus.ProductionStatus description: The network list environment activation production status. type: String - arguments: - description: The ID of the network list to update. name: network_list_id required: true - description: Comma-separated list of elements. Use BLANK to empty a list. isArray: true name: elements required: true description: Deprecated. There is no replacement for this command. name: akamai-update-network-list-elements deprecated: true - arguments: - description: Group Name. name: checking_group_name type: textArea description: Check an existing group within the context of your account. name: akamai-check-group outputs: - contextPath: Akamai.CheckGroup description: Group ID. - contextPath: Akamai.CheckGroup.Found description: Was the group found? - contextPath: Akamai.CheckGroup.groupName description: The parent group name. - contextPath: Akamai.CheckGroup.parentGroupId description: The parent group ID. - contextPath: Akamai.CheckGroup.groupId description: The group ID. - contextPath: Akamai.CheckGroup.checking_group_name description: Group name. - arguments: - description: The group path separated with >. name: group_path required: true description: Create a new group under a parent GID. name: akamai-create-group - arguments: - defaultValue: US description: The country code (two letter format) for the country where your organization is located. name: country required: true type: textArea - description: Company. name: company required: true type: textArea - description: Organizational unit. name: organizational_unit required: true type: textArea - description: The city of the admin contact. name: city required: true - description: Contract ID. name: contract_id required: true type: textArea - defaultValue: third-party description: Certificate type. name: certificate_type type: textArea - description: Common name. name: csr_cn required: true - description: Address of the admin contact. name: admin_contact_address_line_one required: true type: textArea - description: The first name of the admin contact. name: admin_contact_first_name required: true type: textArea - description: The last name of the admin contact. name: admin_contact_last_name required: true type: textArea - description: The email address of the admin contact. name: admin_contact_email required: true type: textArea - description: The phone number of the admin contact. name: admin_contact_phone required: true type: textArea - description: The first name of the tech contact. name: tech_contact_first_name required: true type: textArea - description: The last name of the tech contact. name: tech_contact_last_name required: true type: textArea - description: The email address of the tech contact. name: tech_contact_email required: true type: textArea - description: The phone number of the tech contact. name: tech_contact_phone required: true type: textArea - description: The organization name. name: org_name required: true type: textArea - description: The organization country name. name: org_country required: true type: textArea - description: The organization city. name: org_city required: true type: textArea - description: The organization region. name: org_region required: true type: textArea - description: The organization postal code. name: org_postal_code required: true type: textArea - description: The organization phone number. name: org_phone required: true type: textArea - description: The organization address. name: org_address_line_one required: true type: textArea - defaultValue: 'True' description: Network Configuration - Dns Name Settings - Clone DNS Names. name: clone_dns_names - defaultValue: 'False' description: Third Party - Exclude Sans. name: exclude_sans - defaultValue: 'False' description: Enable this will stop CPS from deploying the certificate to the network. name: change_management - defaultValue: core description: Use core to specify worldwide (includes China and Russia), china+core to specify worldwide and China, and 'russia+core` to specify worldwide and Russia. name: network_configuration_geography type: textArea - defaultValue: third-party description: The registration authority or certificate authority (CA) you want to use to obtain a certificate. name: ra - defaultValue: third-party description: Validation type, Either dv, ev, ov, or third-party. name: validation_type - defaultValue: 'False' description: Enable Dual-Stacked certificate deployment for this enrollment. name: enable_multi_stacked_certificates - defaultValue: 'True' description: Set to true to enable QUIC protocol. name: network_configuration_quic_enabled - defaultValue: enhanced-tls description: Set the type of deployment network you want to use. name: network_configuration_secure_network - defaultValue: 'True' description: SNI settings for your enrollment. Set to true to enable SNI-only for the enrollment. name: network_configuration_sni_only - description: Multiple sans adding into the Common name. isArray: true name: sans description: Create a new enrollment. name: akamai-create-enrollment outputs: - contextPath: Akamai.Enrollment description: Enrollment path. type: string - arguments: - description: Contract ID. name: contract_id required: true description: List enrollments of a specific contract. name: akamai-list-enrollments - arguments: - description: Domain name. name: domain_name required: true type: textArea - description: Group ID. name: group_id required: true description: Create a domain with properties and domain controller (DC). name: akamai-create-domain - arguments: - description: The domain name to which the new property is added. name: domain_name required: true - description: New property name. name: property_name required: true - description: Property type. name: property_type required: true - description: 'Static type - "CNAME" or "A".' name: static_type - description: Static server. name: static_server - description: Server 1. name: server_1 - description: Server 2. name: server_2 - description: Weight 1. name: weight_1 - description: Weight 2. name: weight_2 - name: property_comments description: GTM property comments. type: textArea - description: Data center ID 1. name: dc1_id - description: Data center ID 2. name: dc2_id description: Update a property for a specific domain. name: akamai-update-property - arguments: - description: Enrollment path. name: enrollment_path required: true - defaultValue: third-party-csr description: Currently supported values include change-management-info, lets-encrypt-challenges, post-verification-warnings, pre-verification-warnings, third-party-csr. name: allowed_input_type_param description: Get the CPS code. name: akamai-get-change outputs: - contextPath: Akamai.Change description: Certificate Signing Request (CSR). - arguments: - description: The path of the changed certificate. name: change_path required: true type: textArea - defaultValue: third-party-cert-and-trust-chain description: Allowed input type parameter. name: allowed_input_type_param type: textArea - description: The updated certificate. name: certificate type: textArea - description: The updated trust chain. name: trust_chain type: textArea - auto: PREDEFINED description: Type of encryption. name: key_algorithm predefined: - RSA - ECDSA description: Update the certs and trust chains. name: akamai-update-change - arguments: - description: Contract ID. name: contract_id required: true type: textArea - description: Target common name. name: target_cn required: true description: Get enrollment by common name. name: akamai-get-enrollment-by-cn outputs: - contextPath: Akamai.Enrollment description: Enrollment. - contextPath: Akamai.Enrollment.target_cn description: Target common name. - arguments: [] description: Lists groups of Akamai. name: akamai-list-groups outputs: - contextPath: Akamai.Group description: Akmai Group. - arguments: - defaultValue: '0' description: Group ID. name: group_id required: true description: Get group. name: akamai-get-group - arguments: - name: client_list_id description: An optional URL parameter to get a specific client list. - name: name description: Filters the output to show only lists that match a given name. - name: include_items description: Include items in the response. auto: PREDEFINED predefined: - 'true' - 'false' defaultValue: 'false' - name: include_deprecated description: Include deprecated lists in the response. auto: PREDEFINED predefined: - 'true' - 'false' defaultValue: 'false' - name: search description: Returns results that contain the specified substring in any client list or entry details. - name: type_list description: 'Filters the output to show only lists of the specified types. Repeat the parameter to filter by multiple types. Valid values: IP, GEO, ASN, TLS_FINGERPRINT, FILE_HASH.' isArray: true auto: PREDEFINED predefined: - IP - GEO - ASN - TLS_FINGERPRINT - FILE_HASH - USER - name: include_network_list description: Include network lists in the response. auto: PREDEFINED predefined: - 'true' - 'false' defaultValue: 'false' - name: page description: Page number. defaultValue: '0' - name: page_size description: Page size. defaultValue: '50' - name: limit description: Limit. defaultValue: '50' name: akamai-get-client-list description: Get a client list. outputs: - contextPath: Akamai.ClientList description: The client list. type: unknown - arguments: - name: name required: true description: The name of the new client list. - name: type required: true auto: PREDEFINED predefined: - IP - GEO - ASN - TLS_FINGERPRINT - FILE_HASH - USER description: The type of client list. - name: contract_id required: true description: The contract ID. You can get this value by running the `akamai-get-contract-group` command. - name: group_id required: true description: The group ID. You can get this value by running the `akamai-get-contract-group` command. - name: notes description: A description of the client list. - name: tags isArray: true description: A list of tags to attach to the client list. - name: entry_value description: The value of a single entry in the client list. - name: entry_description description: A description of the entry. - name: entry_expiration_date description: The expiration date for the entry. Use ISO 8601 format (e.g. 2025-09-29 or 2025-09-29T13:15:28). - name: entry_tags isArray: true description: A list of tags attached to the entry. name: akamai-create-client-list description: Creates a new client list. outputs: - contextPath: Akamai.ClientList description: The client list that was created. type: unknown - arguments: - name: client_list_id required: true description: The ID of the client list to be deprecated. name: akamai-deprecate-client-list description: Deprecates a client list. - name: akamai-activate-client-list polling: true description: Activates a client list. arguments: - name: list_id required: true description: The ID of the client list to activate. - name: network_environment required: true auto: PREDEFINED predefined: - STAGING - PRODUCTION description: The network environment where the list will be activated. - name: comments description: A description of the activation. - name: notification_recipients isArray: true description: A list of email addresses to notify. - name: siebel_ticket_id description: A Siebel ticket ID. - name: include_polling description: Whether to poll deactivation status until completion. auto: PREDEFINED predefined: - 'true' - 'false' defaultValue: 'true' - name: interval description: Interval in seconds between polling attempts. defaultValue: 30 type: Number - name: timeout description: Timeout in seconds for polling. defaultValue: 180 type: Number - name: poll_status description: The poll status. deprecated: true outputs: - contextPath: Akamai.Activation description: The activation details. type: unknown - name: akamai-add-client-list-entry description: Adds one or more entries to a client list. arguments: - name: list_id required: true description: The ID of the client list. - name: value required: true isArray: true description: A comma-separated list of values to add to the client list (e.g. 1.2.3.4/32,1.2.3.5/32). - name: description description: A description for the new entries. Applied to all entries. - name: expiration_date description: The expiration date for the new entries. Applied to all entries. Use ISO 8601 format (e.g. 2025-09-29 or 2025-09-29T13:15:28). - name: tags isArray: true description: A list of tags for the new entries. Applied to all entries. - name: akamai-remove-client-list-entry description: Removes an entry from a client list. arguments: - name: list_id required: true description: The ID of the client list. - name: value isArray: true required: true description: A list of values to remove from the client list. - name: akamai-get-contract-group description: Get contract groups. arguments: [] outputs: - contextPath: Akamai.ContractGroup description: The contract groups. type: unknown - name: akamai-update-client-list description: Updates a client list. arguments: - name: list_id required: true description: The ID of the client list to update. - name: name required: true description: The new name of the client list. - name: notes description: The new description of the client list. - name: tags isArray: true description: The new tags for the client list. outputs: - contextPath: Akamai.ClientList description: The updated client list. type: unknown - name: akamai-deactivate-client-list polling: true description: Deactivates a client list. arguments: - name: list_id required: true description: The ID of the client list to deactivate. - name: network_environment required: true auto: PREDEFINED predefined: - STAGING - PRODUCTION description: The network environment where the list is deactivated. - name: comments description: A description for the deactivation. - name: notification_recipients isArray: true description: A list of email addresses to notify. - name: siebel_ticket_id description: A Siebel ticket ID. - name: include_polling description: Whether to poll deactivation status until completion. auto: PREDEFINED predefined: - 'true' - 'false' defaultValue: 'true' - name: interval description: Interval in seconds between polling attempts. defaultValue: 30 type: Number - name: timeout description: Timeout in seconds for polling. defaultValue: 180 type: Number - name: poll_status description: The poll status. deprecated: true outputs: - contextPath: Akamai.Activation description: The deactivation details. type: unknown - name: akamai-update-client-list-entry description: Updates an entry in a client list. arguments: - name: list_id required: true description: The ID of the client list. - name: value required: true description: The value of the entry to update. - name: description description: The new description for the entry. - name: expiration_date description: The new expiration date for the entry. Use ISO 8601 format (e.g. 2025-09-29 or 2025-09-29T13:15:28). - name: tags isArray: true description: The new tags for the entry. - name: is_override type: boolean default: false description: Whether to override missing entries. outputs: - contextPath: Akamai.ClientList description: The updated client list. type: unknown - arguments: [] description: Get Google Tag Manager (GTM) domains. name: akamai-get-domains outputs: - contextPath: Akamai.Domain description: Domains. - arguments: - description: Domain name to get. name: domain_name required: true description: Get a specific GTM domain. name: akamai-get-domain outputs: - contextPath: Akamai.Domain description: Domain. - arguments: - description: Domain Name. name: domain_name required: true - description: Domain controller name. name: dc_name required: true - defaultValue: US description: Country name. name: dc_country description: Create a data center. name: akamai-create-datacenter - arguments: - description: ID for a specific Akamai product. name: product_id required: true type: textArea - description: Property Manager API (PAPI) (Ion Standard) property name. name: property_name required: true type: textArea - description: Contract ID. name: contract_id required: true type: textArea - description: Configuration group ID. name: group_id required: true type: textArea - description: Property Manager API (PAPI) (Ion Standard) property ID. name: property_id required: true type: textArea - description: Property version. name: version required: true type: textArea - defaultValue: yes description: Whether to continue execution if an existing record is found without creating a new record. name: check_existence_before_create required: true description: Clone a new PAPI property. name: akamai-clone-papi-property outputs: - contextPath: Akamai.PapiProperty.PropertyName description: PAPI (Ion Standard) property name. type: unknown - contextPath: Akamai.PapiProperty.PropertyId description: PAPI (Ion Standard) property ID. - contextPath: Akamai.PapiProperty.AssetId description: PAPI (Ion Standard) property asset ID. - arguments: - defaultValue: '1' description: PAPI (Ion Standard) property version. name: property_version required: true type: textArea - description: PAPI (Ion Standard) property ID. name: property_id required: true type: textArea - description: Contract ID. name: contract_id required: true type: textArea - description: Configuration group ID. name: group_id required: true type: textArea - description: Validate hostnames. name: validate_hostnames type: textArea - description: Include the certificate status for the hostname. name: include_cert_status type: textArea - description: URL of the common name. name: cname_from required: true type: textArea - description: Edge hostname ID. name: edge_hostname_id required: true type: textArea - description: Sleep time in seconds between each iteration. name: sleep_time required: true description: Add hostnames to the PAPI property. name: akamai-add-papi-property-hostname outputs: - contextPath: Akamai.PapiProperty.Etag description: ETag for concurrency control. - arguments: - description: ID for a specific Akamai product. name: product_id required: true type: textArea - description: Contract ID. name: contract_id required: true type: textArea - description: Configuration group ID. name: group_id required: true type: textArea - description: Comma-separated list of options to enable. mapDetails enables extra mapping-related information. name: options type: textArea - description: URL of domain name. name: domain_prefix required: true type: textArea - description: URL of the partial domain name appended by Akamai. name: domain_suffix required: true type: textArea - description: IP version. IPv4, IPv6, or IPv4 plus IPv6. name: ip_version_behavior required: true type: textArea - description: SSL secured URL. name: secure type: textArea - description: SSL secured protocol options. name: secure_network type: textArea - description: Certificate enrollment ID for the domain URL. name: cert_enrollment_id type: textArea - defaultValue: yes description: Whether to continue execution if an existing record is found without creating a new record. name: check_existence_before_create required: true description: Add a PAPI edge hostname. name: akamai-new-papi-edgehostname outputs: - contextPath: Akamai.PapiProperty.EdgeHostnames.EdgeHostnameId description: Edge hostname ID. - contextPath: Akamai.PapiProperty.EdgeHostnames.DomainPrefix description: Edge hostname domain prefix URL. - arguments: - description: Contract ID. name: contract_id required: true type: textArea - description: URL of common name. name: cnname type: textArea description: Get cps certificate enrollment ID by common name. name: akamai-get-cps-enrollmentid-by-cnname outputs: - contextPath: Akamai.Cps.Enrollment.EnrollmentId description: Certificate enrollment ID. - contextPath: Akamai.Cps.Enrollment.CN description: Certificate enrollment common name. - arguments: - description: ID for specific Akamai product. name: product_id required: true type: textArea - description: Contract ID. name: contract_id required: true type: textArea - description: Configuration group ID. name: group_id required: true type: textArea - description: Content provider codes name. name: cpcode_name required: true type: textArea - defaultValue: yes description: Whether to continue execution if an existing record is found without creating a new record. name: check_existence_before_create required: true description: Create a new PAPI CP code. name: akamai-new-papi-cpcode outputs: - contextPath: Akamai.PapiCpcode.CpcodeId description: Content provider code ID. - arguments: - description: Contract ID. name: contract_id required: true type: textArea - description: Configuration group ID. name: group_id required: true type: textArea - description: PAPI (Ion Standard) property ID. name: property_id required: true type: textArea - description: PAPI (Ion Standard) property version. name: property_version type: textArea - description: Whether to validate rules. name: validate_rules type: textArea - description: JSON patch operation. Add, Remove, Replace. name: operation type: textArea - description: Dictionary path. name: path type: textArea - description: Content provider code ID. name: cpcode_id type: textArea - description: Content provider code name. name: name type: textArea description: Patch PAPI property default rule with a CP code. name: akamai-patch-papi-property-rule-cpcode outputs: - contextPath: Akamai.PapiProperty.Etag description: ETag for concurrency control. - arguments: - description: Contract ID. name: contract_id required: true type: textArea - description: Configuration group ID. name: group_id required: true type: textArea - description: PAPI (Ion Standard) property ID. name: property_id required: true type: textArea - description: PAPI (Ion Standard) property version. name: property_version required: true type: textArea - description: Whether to validate rules. name: validate_rules required: true type: textArea - description: JSON patch operation. Add, Remove, Replace. name: operation required: true type: textArea - description: Dictionary path. name: path required: true type: textArea - description: value. name: origin required: true type: textArea - description: External URL FQDN. name: external_url required: true - description: Gzip compression. name: gzip_compression - description: Sleep time between each iteration. name: sleep_time required: true description: Patch PAPI property default rule with an origin. name: akamai-patch-papi-property-rule-origin outputs: - contextPath: Akamai.PapiProperty.Etag description: Etag for Concurrency Control. - arguments: - description: Contract ID. name: contract_id required: true type: textArea - description: Configuration group ID. name: group_id required: true type: textArea - description: PAPI (Ion Standard) property ID. name: property_id required: true type: textArea - description: STAGING or PRODUCTION. name: network type: textArea - description: Notification emails. name: notify_emails type: textArea - description: PAPI (Ion Standard) property version. name: property_version type: textArea - description: activation note. name: note description: Activate a PAPI property. name: akamai-activate-papi-property outputs: - contextPath: Akamai.PapiProperty.Staging.ActivationId description: Staging activation ID. - contextPath: Akamai.PapiProperty.Production.ActivationId description: Production activation ID. - arguments: - description: AppSec configuration ID. name: config_id required: true - description: AppSec configuration version. name: config_version required: true - description: Baseline security policy ID. name: create_from_security_policy required: true - description: New security policy name. name: policy_name required: true - description: Security policy ID prefix. name: policy_prefix - defaultValue: yes description: Whether to continue execution if an existing record is found without creating a new record. name: check_existence_before_create required: true description: AppSec clone security policy. name: akamai-clone-security-policy outputs: - contextPath: Akamai.AppSecConfig.Policy.PolicyName description: Security policy name. - contextPath: Akamai.AppSecConfig.Policy.PolicyId description: Security policy ID. - arguments: - description: AppSec configuration ID. name: config_id required: true - description: AppSec configuration version. name: config_version required: true - description: Security policy ID. name: policy_id required: true - description: Website. name: match_type required: true - description: Comma-separated list of hostname URLs. name: hostnames required: true - description: Comma-separated list of bypass networks. name: bypass_network_lists required: true - description: File paths. Default is /*. name: file_paths required: true - description: Default is noMatch. name: default_file required: true description: AppSec create match target. name: akamai-new-match-target outputs: - contextPath: Akamai.AppSecConfig.Policy.PolicyName description: Security policy name. - contextPath: Akamai.AppSecConfig.Policy.PolicyId description: Security policy ID. - contextPath: Akamai.AppSecConfig.Policy.TargetId description: Match target ID. - arguments: - description: AppSec configuration ID. name: config_id required: true - description: AppSec configuration version. name: config_version required: true - description: Default is N/A. name: acknowledged_invalid_hosts required: true type: textArea - description: List of notification emails. name: notification_emails required: true type: textArea - description: Activate. name: action required: true type: textArea - description: STAGING or PRODUCTION. name: network required: true type: textArea - description: Note to describe the activity. name: note required: true type: textArea description: AppSec activate appsec configuration version. name: akamai-activate-appsec-config-version outputs: - contextPath: Akamai.AppSecConfig.Staging.ActivationId description: Security configuration staging activation ID. - contextPath: Akamai.AppSecConfig.Production.ActivationId description: Security configuration production activation ID. - arguments: - description: Security configuration activation ID. name: activation_id required: true - description: Sleep time in seconds between each iteration. name: sleep_time required: true - description: Number of retries of the consistency check to be conducted. name: retries required: true description: AppSec get appsec config activation status. name: akamai-get-appsec-config-activation-status outputs: - contextPath: Akamai.AppSecConfig.Staging description: Staging Security Configration. - contextPath: Akamai.AppSecConfig.Production description: Production Security Configration. - arguments: - description: Name of the security configuration. name: sec_config_name required: true - description: Number of seconds to wait before the next consistency check. name: sleep_time required: true type: textArea - description: Number of retries of the consistency check to be conducted. name: retries required: true type: textArea - description: Do not perform LatestVersion, Staging Version, Production Version consistency check. name: skip_consistency_check required: true description: AppSec get appsec config latest version. name: akamai-get-appsec-config-latest-version outputs: - contextPath: Akamai.AppSecConfig.LatestVersion description: Security configuration latest version number. - arguments: - description: Security Policy Name. name: policy_name required: true type: textArea - description: AppSec configuration ID. name: config_id required: true - description: AppSec configuration version. name: config_version required: true - description: Whether this is the baseline security policy. name: is_baseline_policy required: true description: AppSec get security policy ID by name. name: akamai-get-security-policy-id-by-name outputs: - contextPath: Akamai.AppSecConfig.BasePolicyName description: Baseline security policy name. - contextPath: Akamai.AppSecConfig.BasePolicyId description: Baseline security policy ID. - contextPath: Akamai.AppSecConfig.Policy.PolicyName description: Security policy name. - contextPath: Akamai.AppSecConfig.Policy.PolicyId description: Baseline security policy ID. - contextPath: Akamai.AppSecConfig.Id description: AppSec security configuration ID. - arguments: - description: AppSec configuration ID. name: config_id required: true - description: AppSec configuration version. name: create_from_version required: true - description: Specifies whether the application rules should be migrated to the latest version. name: rule_update auto: PREDEFINED defaultValue: 'True' predefined: - 'True' - 'False' - description: Do not clone to create a new version. Use in the test. name: do_not_clone required: true description: AppSec_clone appsec config version. name: akamai-clone-appsec-config-version outputs: - contextPath: Akamai.AppSecConfig.Name description: AppSec configuration name. - contextPath: Akamai.AppSecConfig.Id description: AppSec Configration ID. - contextPath: Akamai.AppSecConfig.NewVersion description: AppSec Configration New Version. - arguments: - description: Contract ID. name: contract_id required: true - description: Group ID. name: group_id required: true - description: Property ID. name: property_id required: true - description: Property Version. name: property_version - description: Whether to validate the Rules. name: validate_rules required: true - description: The operation to execute. name: operation required: true - description: The path of the rule. name: path required: true - name: value description: The value of the HTTP Method in dictionary format. required: true description: Patch PAPI property rule HTTP methods. name: akamai-patch-papi-property-rule-httpmethods outputs: - contextPath: Akamai.PapiProperty.Etag description: ETag for concurrency control. - arguments: - description: Ion property activation ID. name: activation_id required: true - description: Ion property ID. name: property_id required: true - description: Sleep time between retries. name: sleep_time required: true - description: Number of retires. name: retries required: true description: Get PAPI property activation status until it is active. name: akamai-get-papi-property-activation-status-command - arguments: - description: contract ID. name: contract_id required: true - description: Group id. name: group_id required: true - description: Edge hostname ID. name: edgehostname_id required: true - description: mapDetails. name: options required: true - description: Sleep time between each iteration. name: sleep_time required: true - description: Number of retries. name: retries required: true description: Get PAPI edgehostname creation status command until it is created. name: akamai-get-papi-edgehostname-creation-status-command - name: akamai-acknowledge-warning-command arguments: - description: The path of the changed certificate. name: change_path required: true type: textArea - auto: PREDEFINED defaultValue: post-verification-warnings-ack description: Enum found as the last part of Change.allowedInput[].update hypermedia URL. name: allowed_input_type_param predefined: - change-management-ack - lets-encrypt-challenges-completed - post-verification-warnings-ack - pre-verification-warnings-ack description: Acknowledge the warning message for uploading the certs and trust chains of enrollments. - arguments: - description: A unique identifier for each configuration. name: config_id required: true - description: A unique identifier for each version of a configuration. name: config_version required: true - description: A list hostnames is used to modifying the configuration. isArray: true name: hostname_list required: true - description: The 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. name: mode required: true description: Update the list of selected hostnames for a configuration version. name: akamai-modify-appsec-config-selected-hosts - arguments: - name: enrollment_id description: The enrollment id. required: true description: Get Production Deployment. name: akamai-get-production-deployment - arguments: - name: enrollment_id description: The enrollment id. required: true description: Get change history. name: akamai-get-change-history - arguments: - description: Akamai contract Identity. name: contract_id required: true - description: Akamai configuration group Identity. name: group_id required: true - description: Akamai Ion Property Identity. name: property_id required: true - description: Akamai Ion Property Version Identity. name: property_version required: true - description: Validate the rule or not - true or false. name: validate_rules required: true - description: Json patch operation - add / delete / replace. name: operation required: true - description: Json patch Rule path. name: path required: true - description: siteshiled json format data. name: ssmap required: true description: Patch papi property default rule siteshield. name: akamai-patch-papi-property-rule-siteshield - arguments: - description: The ID of the application seucirty configuration. name: config_id required: true - description: The version number of the application seucirty configuration. name: config_version required: true - description: The notes need to be written into the application seucirty configuration version. name: notes required: true description: Update application secuirty configuration version notes command. name: akamai-update-appsec-config-version-notes - arguments: - description: A unique identifier for each configuration. name: config_id required: true - description: A unique identifier for each version of a configuration. name: config_version required: true - description: The type of the match target. name: match_type required: true - description: bypass network lists. name: bypass_network_lists required: true - description: Describes the rule to match on paths. name: default_file required: true - description: Contains a list of file paths. name: file_paths required: true - description: A list of hostnames that need to be added into match target. name: hostnames required: true - description: Specifies the security policy to filter match targets. name: policy_id required: true description: 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. name: akamai-new-or-renew-match-target - arguments: - description: A unique identifier for each configuration. name: contract_id required: true - description: A unique identifier for each group. name: group_id required: true - description: A unique identifier for each Papi Property. name: property_id required: true - description: A unique identifier for each Papi Property Version. name: property_version required: true - description: whether validate rule or not. name: validate_rules required: true - description: add/replace/remove. name: operation required: true - description: json rule tree path for the default rule. name: path required: true - description: value to be operated against. name: value required: true - description: whether to convert value to json format. yes/no. name: value_to_json predefined: - 'yes' - 'no' auto: PREDEFINED description: Generic JSON patch command for Papi Property Default Rule. name: akamai-patch-papi-property-rule-generic - arguments: - description: A unique identifier for each configuration. name: contract_id required: true - description: A unique identifier for each group. name: group_id required: true - description: A unique identifier for each Papi Property. name: property_id required: true - description: A unique identifier for each Papi Property Version. name: property_version required: true - description: whether validate rule or not. name: validate_rules required: true description: get papi property rule json and dump into string. name: akamai-get-papi-property-rule outputs: - contextPath: Akamai.PapiProperty.DefaultRule description: Papi Property default rule. - arguments: - description: The path that includes enrollmentId and changeId. name: change_path required: true description: acknowledge pre verification warning. name: akamai-acknowledge-pre-verification-warning - arguments: - description: Unique identifier for the contract. name: contract_id required: true - description: Name of the PAPI property. name: property_name - description: Unique identifier for the group. name: group_id description: Get PAPI property info without the default rule. To get the default rule, use the "get-papi-property-rule" command. name: akamai-get-papi-property-by-name - arguments: - description: Unique identifier for the contract. name: contract_id required: true - description: Unique identifier for the group. name: group_id required: true - defaultValue: PapiProperty.ByGroup description: Custom output context path, default is "PapiProperty.ByGroup". name: context_path description: 'Lists properties available for the current contract and group. ' name: akamai-list-papi-property-by-group - arguments: - description: Unique identifier of the contract. name: contract_id required: true - description: Unique identifier for the group. name: group_id required: true - description: Unique identifier of the property. name: property_id required: true description: get papi property info by id without default rule. to get default rule, please use "get-papi-property-rule" command. name: akamai-get-papi-property-by-id - arguments: - description: Unique identifier for the contract. name: contract_id required: true - description: Unique identifier for the property. name: property_id required: true - description: Unique identifier for the group. name: group_id required: true - description: The property version on which to base the new version. name: create_from_version required: true description: 'Create a new property version based on any previous version. All data from the createFromVersion populates the new version, including its rules and hostnames. ' name: akamai-new-papi-property-version - arguments: - description: Unique identifier for the contract. name: contract_id required: true - description: Unique identifier for the group. name: group_id required: true - description: Unique identifier for the property. name: property_id required: true description: This lists all activations for all versions of a property, on both production and staging networks. name: akamai-list-papi-property-activations - arguments: - description: Unique identifier for the contract. name: config_id required: true description: 'Lists the activation history for a configuration. The history is an array in descending order of submitDate. The most recent submitted activation lists first. Products: All.' name: akamai-list-appsec-configuration-activation-history - arguments: - description: Filter the results by cnameFrom. Supports wildcard matches with *. name: hostname required: true - auto: PREDEFINED description: Network of activated hostnames, either STAGING or PRODUCTION. Or leave it BLANK. name: network predefined: - STAGING - PRODUCTION - description: Unique identifier for the contract. contract_id and groupd_id need to be presented at the same time. name: contract_id - description: Unique identifier for the group. contract_id and groupd_id need to be presented at the same time. name: group_id description: 'Lists active property hostnames for all properties available in an account. ' name: akamai-list-papi-property-by-hostname - arguments: [] description: Returns a list of all Site Shield maps that belong to your account. name: akamai-list-siteshield-map outputs: - contextPath: Akamai.SiteShieldMaps description: Akamai SiteShield Maps. type: List - arguments: - description: Unique identifier of the enrollment on which to perform the desired operation. And it can be retrieved via the akamai-list-enrollments command. name: enrollment_id required: true - auto: PREDEFINED description: Environment where the certificate is deployed. name: environment predefined: - production - staging description: 'Returns the certification/enrollment deployment status for specific a environment: production or staging.' name: akamai-get-cps-enrollment-deployment outputs: - contextPath: Akamai.Cps.Enrollments.Deployment description: A collection of settings for the Akami CPS enrollments deployment. type: Dictionary - arguments: - auto: PREDEFINED description: Whether a CIDR block was added, updated, or removed from service. You can use this parameter as a sorting mechanism and return only CIDR blocks with a change status of add, update, or delete. Note that a status of delete means the CIDR block is no longer in service, and you can remove it from your firewall rules. name: last_action predefined: - all - add - delete - update type: textArea - description: The ISO 8601 date the CIDR block starts serving traffic to your origin. Ensure your firewall rules are updated to allow this traffic to pass through before the effective date. Expected format MM-DD-YYYY or YYYY-MM-DD. name: effective_date_gt type: textArea description: List all CIDR blocks for all services you are subscribed to. To see additional CIDR blocks, subscribe yourself to more services and run this operation again. name: akamai-list-cidr-blocks outputs: - contextPath: Akamai.CidrBlocks description: A list of CIDR blocks. type: List - arguments: - description: Enrollment on which to perform the desired operation. It can be retrieved via the akamai-list-enrollments command. name: enrollment_id required: true - description: 'The modification(s) to the enrollment in the dict format. The possible modifications are: ra, validationType, certificateType, networkConfiguration, changeManagement, csr, org, adminContact, techContact, thirdParty, enableMultiStackedCertificates.' isArray: true name: updates required: true - description: Enrollment information in dict format. If provided, the script will not make another API call to get the enrollment information. If not provided, another API call will be issued to retrieve the enrollment information. isArray: true name: enrollment - description: Whether all pending changes are to be cancelled when updating an enrollment. name: allow_cancel_pending_changes auto: PREDEFINED defaultValue: 'true' predefined: - 'true' - 'false' - description: Whether to bypass staging and push meta_data updates directly to the production network. Current change will also be updated with the same changes. name: allow_staging_bypass auto: PREDEFINED defaultValue: 'true' predefined: - 'true' - 'false' - description: "Don't deploy after this date (UTC). Sample: 2021-01-31T00:00:00.000Z." name: deploy_not_after - description: "Don't deploy before this date (UTC). Sample: 2021-01-31T00:00:00.000Z." name: deploy_not_before - description: Whether to force certificate renewal for enrollment. name: force_renewal auto: PREDEFINED defaultValue: 'false' predefined: - 'true' - 'false' - description: Whether CPS will automatically start a change to renew certificates in time before they expire. name: renewal_date_check_override auto: PREDEFINED defaultValue: 'true' predefined: - 'true' - 'false' - description: Applicable for Third Party Dual Stack Enrollment. Whether to update a missing certificate. Option supported from v10. name: allow_missing_certificate_addition auto: PREDEFINED defaultValue: 'false' predefined: - 'true' - 'false' description: 'Updates an enrollment with changes. Response type will vary depending on the type and impact of change. For example, changing SANs list may return HTTP 202 Accepted since the operation requires new certificate and network deployment operations, and thus cannot be completed without a change. On the contrary, for example a Technical Contact name change may return HTTP 200 OK assuming there are no active changes and the operation does not require a new certificate. Reference: https://techdocs.akamai.com/cps/reference/put-enrollment Note: Depending on the type of the modification, additional steps might be required to complete the update. These additional steps could be carrying out a "renew" change by resubmitting the CSR, acknowledging the warnings raised then waiting for the certificate to be deployed into Production. However, these additional steps are not included in this command. You need to perform those steps once the update command is completed.' name: akamai-update-cps-enrollment outputs: - contextPath: Akamai.Enrollment.Changes description: Akamai enrollment changes. type: Dictionary - arguments: - description: Enrollment path found in the pending change location field. name: enrollment_path - description: Enrollment ID on which to perform the desired operation. The ID can be retrieved via the akamai-list-enrollments command. name: enrollment_id - description: Change ID on which to perform the desired operation. It can be retrieved via the akamai-list-enrollments command. name: change_id - description: 'The time after when the change will no longer be in effect. This value is an ISO-8601 timestamp. (UTC) Sample: 2021-01-31T00:00:00.000Z.' name: deploy_not_after - description: 'The time that you want the change to take effect. If you do not set this, the change occurs immediately, although most changes take some time to take effect even when they are immediately effective. This value is an ISO-8601 timestamp. (UTC) Sample: 2021-01-31T00:00:00.000Z.' name: deploy_not_before required: true description: Updates the current deployment schedule. name: akamai-update-cps-enrollment-schedule outputs: - contextPath: Akamai.Enrollment.Changes description: Akamai enrollment changes. type: Dictionary - arguments: - description: 'Enrollment path found in the pending change location field.' name: enrollment_path - description: The enrollment ID on which to perform the desired operation. It can be retrieved via the akamai-list-enrollments command. name: enrollment_id - description: The change for this enrollment on which to perform the desired operation. It can be retrieved via the akamai-list-enrollments command. name: change_id description: Gets the status of a pending change. name: akamai-get-cps-change-status outputs: - contextPath: Akamai.Enrollments.Change.Status description: Akamai enrollments change status. type: Dictionary - arguments: - description: Unique Identifier of a contract on which to operate or view. name: contract_id required: true description: 'Lists enrollments with active certificates. Note that the rate limit for this operation is 10 requests per minute per account.' name: akamai-list-cps-active-certificates outputs: - contextPath: Akamai.Cps.Active.Certificates.Enrollments description: A collection of Active Akami CPS enrollments. type: Dictionary - arguments: - description: The change for this enrollment on which to perform the desired operation. Default is 0. "change_path" is used. name: change_id required: true defaultValue: '0' - defaultValue: '0' description: Enrollment on which to perform the desired operation. Default is 0. "change_path" is used. name: enrollment_id required: true - description: "Change path on which to perform the desired operation. Sample: /cps/v2/enrollments/100000/changes/88888888. Note: change_path is not listed in the reference as a parameter. However it can be extracted directly from \"list_enrollments_command\". This should be the most common usage when generating the RestAPI's URL." name: change_path - description: For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. name: account_switch_key description: Cancels a pending change on CPS. name: akamai-cancel-cps-change - arguments: - description: Enrollment ID on which to perform the desired operation. name: enrollment_id required: true description: Get an enrollment in CPS by enrollment id. name: akamai-get-cps-enrollment-by-id - arguments: [] description: 'Lists available security configurations. Products: All.' name: akamai-list-appsec-config outputs: - contextPath: Akamai.AppSecConfigAll description: A list of dictionaries for all Akamai Security Configurations. type: unknown - arguments: [] description: List all zones that the current user has access to manage. name: akamai-list-dns-zones outputs: - contextPath: Akamai.EdgeDns.Zones description: A collection of Edge DNS zones. type: Dictionary - arguments: - description: The name of the zone. name: zone required: true description: Lists all record sets for this zone. It works only for PRIMARY and SECONDARY zones. name: akamai-list-dns-zone-recordsets outputs: - contextPath: Akamai.EdgeDns.ZoneRecordSets description: A collection of Edge DNS zone's record sets. type: Dictionary - arguments: - description: The name of the stream. name: stream_name required: true - description: The unique identifier of the group that has access to the product and this stream configuration. name: group_id required: true - description: The unique identifier of the contract that has access to the product. name: contract_id - description: The unique identifier of the properties that belong to the same product and to be monitored in the stream. Note that a stream can only log data for active properties. A property can be activated in Property Manager. isArray: true name: properties - description: The unique identifier of the data set fields to be included in stream logs. In case of STRUCTURED format, the order of the identifiers define how the value for these fields appear in the log lines. isArray: true name: dataset_fields - auto: PREDEFINED description: The interval in seconds (30 or 60) after which the system bundles log lines into a file and sends it to a destination. name: interval_in_seconds predefined: - '30' - '60' - description: The format in which you want to receive log files. STRUCTURED or JSON are the currently available formats. When the delimiter is present in the request, STRUCTURED format needs to be defined. name: log_format - description: A delimiter that separates data set fields in the log lines, either SPACE or TAB. Set this only for the STRUCTURED log file format. name: field_delimiter - description: The prefix of the log file to be used when sending to a object-based destination. It's a string of at most 200 characters. If unspecified, it defaults to ak. This member supports Dynamic time variables, but doesn't support the '.' character. name: upload_file_prefix - description: The suffix of the log file that you want to send to a object-based destination. It's a static string of at most 10 characters. If unspecified, it defaults to ds. This member doesn't support Dynamic time variables, and the ., /, %, ? characters. name: upload_file_suffix - description: The certification authority (CA) certificate used to verify the origin server's certificate. If the certificate is not signed by a well-known certification authority, enter the CA certificate in the PEM format for verification. If this value is set, the mTlsEnabled property replaces it in the response as true. name: ca_cert - description: The PEM-formatted digital certificate you want to authenticate requests to your destination with. If you want to use mutual authentication, you need to provide both the client certificate and the client key. If you pass this member, the mTlsEnabled member replaces it in the response as true. name: client_cert - description: The private key in the non-encrypted PKCS8 format that authenticates with the back-end server. If you want to use mutual authentication, you need to provide both the client certificate and the client key. name: client_key - description: The type of the resource passed in the request's custom header. For details, see the additional options discussed in Stream logs to a HTTPS endpoint. name: content_type - description: A human-readable name for the request's custom header, containing only alphanumeric, dash, and underscore characters. For details, see the additional options discussed in Stream logs to a HTTPS endpoint. name: custom_header_name - description: The custom header's contents passed with the request that contains information about the client connection. For details, see the additional options discussed in Stream logs to a HTTPS endpoint. name: custom_header_value - auto: PREDEFINED description: Enables gzip compression for a log file sent to a destination. True by default. name: compress_logs predefined: - 'True' - 'False' - auto: PREDEFINED defaultValue: SPLUNK description: 'The destination configuration in the stream to send logs. Note: "SPLUNK" and "HTTPS" are the only two types tested.' name: destination_type predefined: - HTTPS - SPLUNK - description: The name of the destination. name: display_name - description: The raw event Splunk URL where the logs need to be sent to. Akamaized property hostnames can be used as endpoint URLs. See Stream logs to Splunk. name: endpoint - description: The Event Collector token for your Splunk account. See View usage of Event Collector token in the Splunk documentation. name: event_collector_token - description: The hostname that verifies the server's certificate and matches the Subject Alternative Names (SANs) in the certificate. If not provided, DataStream fetches the hostname from the endpoint URL. name: tls_hostname - description: A list of e-mail addresses where you want to send notifications about activations and deactivations of the stream. You can omit this member and activate or deactivate the stream without notifications. name: notification_emails - auto: PREDEFINED description: Indicates if you've opted to capture midgress traffic within the Akamai platform, such as between two edge servers. name: collect_midgress predefined: - 'True' - 'False' - auto: PREDEFINED description: Activates the stream at the time of the request, false by default. When Edit a stream or Patch a stream that is active, set this value to true. name: activate predefined: - 'True' - 'False' description: 'Creates a stream configuration. Within a stream configuration, you can select properties to monitor in the stream, data set fields to collect in logs, and a destination to send these log files to. Get the streamId value from the response to use in the https://{hostname}/datastream-config-api/v2/log/streams/{streamId} endpoint URL. Apart from the log and delivery frequency configurations, you can decide whether to activate the stream on making the request or later using the activate parameter. Note that only active streams collect and send logs to their destinations. NOTE: "SPLUNK" and "HTTPS" are the only two types tested.' name: akamai-new-datastream outputs: - contextPath: Akamai.DataStream description: Akamai DataStream. - arguments: [] description: Lists the properties and includes for the current account. name: akamai-list-idam-properties outputs: - contextPath: Akamai.Idam.Properties description: Akamai Properties of the current account via Identity Access Management. - arguments: - description: The unique identifier of the group that has access to the product and this stream configuration. name: group_id description: Returns the latest versions of the stream configurations for all groups within the account. name: akamai-list-datastreams outputs: - contextPath: Akamai.DataStreams description: Akamai DataStreams. - arguments: - description: Uniquely identifies the stream. name: stream_id required: true - description: Identifies the version of the stream. If omitted, the operation returns the latest version of the stream. name: version description: Returns information about any version of a stream, including details about the monitored properties, logged data set fields, and log delivery destination. If you omit the version query parameter, this operation returns the last version of the stream. name: akamai-get-datastream outputs: - contextPath: Akamai.DataStreamDetails description: Akamai DataStream Details. - arguments: - description: Uniquely identifies the contract that belongs to a group. name: contract_id description: Returns access groups with contracts on your account. You can later use the groupId and contractId values to create and view streams or list properties by group. Set the contractId query parameter to get groups for a specific contract. name: akamai-list-datastream-groups outputs: - contextPath: Akamai.DataStreamGroups description: Akamai Groups within the contract. - arguments: - description: The unique identifier of the group that has access to the product and this stream configuration. name: group_id required: true description: Get properties that are active on the production and staging network and available within a specific group. Run this operation to get and store the propertyId values for the Create a stream and Edit a stream operations. name: akamai-list-datastream-properties-bygroup outputs: - contextPath: Akamai.DataStream.Group description: List of the Active Properties within the Group. - arguments: - description: Unique identifer of a stream. name: stream_id required: true description: Deletes a deactivated stream. Deleting a stream means that you can't activate this stream again, and that you stop receiving logs for the properties that this stream monitors. Before deleting any stream, you need to deactivate it first. See Deactivate a stream. name: akamai-delete-datastream outputs: - contextPath: Akamai.DataStream description: Akamai DataStream. - arguments: - description: The unique identifier of the stream. name: stream_id required: true - auto: PREDEFINED description: Activates the stream at the time of the request, false by default. When you Edit a stream or Patch a stream that is active, you need to set this member to true. name: activate predefined: - 'true' - 'false' - description: A JSON Pointer that identifies the values you want to replace in the stream configuration. This member's value is / followed by any of the configuration object's top-level member name. See Edit a stream for available members. name: path required: true - description: Specifies the data to replace at the path location, any type of data including objects and arrays. Pass complete objects to avoid overwriting current details with default values for omitted members. name: value required: true - auto: PREDEFINED description: Whether convert the value above into Json or not. name: value_to_json predefined: - yes - no description: Updates selected details of an existing stream. Running this operation using JSON Patch syntax creates a stream version that replaces the current one. Currently you can patch a stream using only the REPLACE operation. When updating configuration objects such as destination or deliveryConfiguration, pass a complete object to avoid overwriting current details with default values for omitted members such as tags, uploadFilePrefix, and uploadFileSuffix. Note that only active streams collect and send logs to their destinations. You need to set the activate parameter to true while patching active streams, and optionally for inactive streams if you want to activate them upon request. See Patching streams for details. name: akamai-patch-datastream outputs: - contextPath: Akamai.DataStream description: Akamai DataStream. - arguments: - description: Uniquely identifies the stream. name: stream_id - auto: PREDEFINED description: 'activate" or "deactivate.' name: option predefined: - activate - deactivate description: Activate/Deactivate the latest version of a DataStream. name: akamai-toggle-datastream outputs: - contextPath: Akamai.DataStream.Activation description: Akamai DataStream Activation. - arguments: [] description: Get accessible client lists. name: akamai-get-client_lists outputs: - contextPath: Akamai.ClientList description: Akamai ClientList. - arguments: - description: Unique identifier of a contract. name: contract_id required: true - description: Unique identifier of a group. name: group_id description: Lists all edge hostnames available under a contract. name: akamai-list-edgehostname outputs: - contextPath: Akamai.Edgehostname description: Akamai Edgehostnames. - arguments: - auto: PREDEFINED description: "Type 'str'. The HTTP method, for example: GET, POST, and so on." name: method predefined: - GET - POST - PUT - PATCH - DELETE - description: Type 'str'. The API endpoint. name: url_suffix - description: Type 'dict'. Headers to send in the request. If None, will use self._headers. name: headers - description: Type 'dict'. URL parameters to specify the query. name: params - description: Type 'dict'. The data to send in a 'POST' request. name: data - description: Type 'dict'. The dictionary to send in a 'POST' request. name: json_data - description: Type 'dict'. The file data to send in a 'POST' request. name: files - description: "Type 'float' or comma separated two floats. The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. can be only float (Connection Timeout) or or Comma separated two floats for Connection Timeout and Read Timeout. (Samput Input: 60, 60)." name: timeout - auto: PREDEFINED description: Type 'str'. Determines which data format to return from the HTTP request. The default is 'json'. Other options are 'text', 'content', 'xml' or 'response'. Use 'response' to return the full response object. name: resp_type predefined: - json - text - content - xml - response - description: "Type 'tuple'. The request codes to accept as OK, for example: 200, 201, 204. If you specify \"None\", will use self._ok_codes. Default is None." name: ok_codes - description: Type 'int'. How many retries should be made in case of a failure. when set to '0'- will fail on the first time. name: retries - description: Type 'iterable'. A set of integer HTTP status codes that we should force a retry on. A retry is initiated if the request method is in ['GET', 'POST', 'PUT'] and the response status code is in 'status_list_to_retry'. name: status_list_to_retry - description: "Type 'float'. A backoff factor to apply between attempts after the second try (most errors are resolved immediately by a second try without a delay). urllib3 will sleep for: {backoff factor} * (2 ** ({number of total retries} - 1)) seconds. If the backoff_factor is 0.1, then :func:`.sleep` will sleep for [0.0s, 0.2s, 0.4s, ...] between retries. It will never be longer than :attr:`Retry.BACKOFF_MAX`. By default, backoff_factor set to 5." name: backoff_factor - auto: PREDEFINED description: Type 'bool'. Whether, if the number of redirects is exhausted, to raise a MaxRetryError, or to return a response with a response code in the 3xx range. name: raise_on_redirect predefined: - 'True' - 'False' - auto: PREDEFINED description: "Type 'bool'. Similar meaning to 'raise_on_redirect': whether we should raise an exception, or return a response, if status falls in 'status_forcelist' range and retries have been exhausted." name: raise_on_status predefined: - 'True' - 'False' - description: Type 'list'.A list of all valid status codes of empty responses (usually only 204, but can vary). name: empty_valid_codes - description: Type 'bool'. Whether or not to calculate execution metrics from the response. name: with_metrics description: Akamai Generic API Call. name: akamai-generic-api-call-command dockerimage: demisto/auth-utils:1.0.0.11671917 script: '' subtype: python3 type: python runonce: false tests: - Akamai_WAF-Test fromversion: 5.0.0