Akamai Network List 1.0.0
App Vendor: Akamai
Connector Category: Network Security
Connector Version: 1.0.0
API Version: 1.0.0
About App
The Akamai Network List gives you the ability to automate the creation, deployment, and management of lists used in various Akamai security products such as Kona Site Defender, Web App Protector, and Bot Manager. In Orchestrate, this app allows the analysts to manage and obtain common sets of Network lists used by various Akamai security products and features.
The Akamai Network List app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Add an element | This action adds an element to a network list. |
Create a network list | This action creates a network list. |
Delete an element | This action deletes an element from a network list. |
Delete a network list | This action deletes a network list. |
Get a network list | This action retrieves a network list. |
Subscribe network lists | This action subscribes to network lists. |
Update the network list | This action updates the network list. |
Configuration Parameters
The following configuration parameters are required for the Akamai Network List app to communicate with the Akamai Network List enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Hostname | Enter the hostname. | Text | Required | |
Edgegrid Client Token | Enter the Edgegrid client token. | Text | Required | |
Edgegrid Client Secret | Enter the Edgegrid client secret. | Text | Required | |
Edgegrid Access Token | Enter the Edgegrid access token. | Text | Required |
Action: Add an Element
This action adds an element to a network list.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network list ID | Enter the network list ID. | Text | Required | |
Element | Enter the element. Example: "1.1.1.1" | Text | Required |
Action: Create a Network List
This action creates a network list.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
List name | Enter the list name. Example: "new list". | Text | Required | |
Description | Enter the description. Example: "notes about the list". | Text | Required | |
List type | Enter the list type. Example: "ip". | Text | Required | |
List items | Enter the list of IPs or domains. Example: ["cyware1.com", "cyware2.com"]. | Text | Required |
Action: Delete an Element
This action deletes an element from a network list.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network list ID | Enter the network list ID. | Text | Required | |
Element | Enter the element as IP or domain. Example: "1.1.1.1". | Text | Required |
Action: Delete a Network List
This action deletes a network list.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network list ID | Enter the network list ID. | Text | Required |
Action: Get a Network List
This action retrieves a network list.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network list ID | Enter the network list ID. | Text | Required | |
Extended | Optional preference to either extend or cease the list. | Boolean | Required | Allowed values:
When set to "true", the additional data about creating and updating the list is provided, along with the network list’s deployment status. |
Include elements | Optional preference to either include or exclude elements. | Boolean | Required | Allowed values:
When set to "true", the additional data about creating and updating the list is provided, along with the network list’s deployment status. |
Action: Subscribe Network Lists
This action subscribes to network lists.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Recipients | Enter the recipients. Example: "it-team@example.com". | Text | Required | |
Unique id | Enter the unique ID of the network list. | Text | Required |
Action: Update the Network List
This action updates the network list.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network list ID | Enter the network list ID. | Text | Required | |
Extended | Optional preference to either extend or cease the list. | Boolean | Required | Allowed values:
When set to "true", the additional data about creating and updating the list is provided, along with the network list’s deployment status. |
Include elements | Optional preference to either include or exclude elements. | Boolean | Required | Allowed values:
When set to "true", the additional data about creating and updating the list is provided, along with the network list’s deployment status. |
Name | Enter the updated name for the network list. Example: "my list". | Text | Required | |
List type | Enter the list type as IP or Domain. Example: "cyware.com". | Text | Required | |
Description | Enter the description. Example: "updating the list". | Text | Required | |
Syncpoint | Enter the syncpoint value. Example: "5". | Text | Required | |
List items | Enter the list of items as IP or Domain. Example: ["1.1.1.1", "2.2.2.2"]. | Any | Required |