Akamai Network List 2.0.0
App Vendor: Akamai
App Category: Network Security
Connector Version: 2.0.2
API Version: 1.0.0
About App
The Akamai Network List app allows security teams to integrate with the Akamai Network List enterprise application. This app enables analysts to manage common sets of 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 |
|---|---|
Activate Network List | This action activates a network list. |
Add an Element | This action adds an element to a network list. |
Create a Network List | This action creates a network list. |
Delete a Network List | This action deletes a network list. |
Delete an Element | This action deletes an element from 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 |
|---|---|---|---|---|
Base URL | Enter the base URL to access the Akamai Network List app. Example: "https://akaa-w.luna.akamaiapis.net" | Text | Required | |
EdgeGrid Client Token | Enter the EdgeGrid client token to connect to the Akamai Network List app. Example: "csxxefd" | Password | Required | |
EdgeGrid Client Secret | Enter the EdgeGrid client secret to authenticate to the Akamai Network List app. Example: "abcdEdghwsdksxx5CPUxlEfQeTDkfh4QA=I " | Password | Required | |
Edgegrid Access Token | Enter the EdgeGrid access token to access Akamai Network List APIs. Example: "akaa-xxxxxxxxxxxxxxx" | Password | Required |
Action: Activate Network List
This action activates a network list.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Env ID | Enter the Akamai network on which a network list must be activated. Example: "STAGING" | Text | Required | Allowed values:
|
Network List ID | Enter the unique network list ID. Example: "12345_blackliststag" | Text | Required | |
Comments | Enter a comment for activating a network list. Example: "activate users on staging" | Text | Optional | |
Notification Recipients | Enter the list of email addresses of control center users who receive an email when activation of a network list is complete. Example: $LIST[securityteam@examplecom, testuser@sampledomain.com] | List | Optional | |
Siebel Ticket ID | Enter the Siebel ticket ID. | Text | Optional |
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 unique network list ID. Example: "12345_blackliststag" | Text | Required | You can retrieve the Network List ID using the action Get a Network List. |
Element | Enter an element (IP address or domain) to add to the network list. 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 a name for the network list. Example: "new network list" | Text | Required | |
Description | Enter the description of the list. Example: "sample description about the list" | Text | Optional | |
Network List Type | Enter the network list type. Example: "IP" | Text | Required | Allowed values:
|
List Items | Enter the list of IPs or domains. Example: $LIST[sampledomain1.com, sampledomain2.com]. | List | 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. Example: "12345_blackliststag" | 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. Example: "12345_blackliststag" | Text | Required | |
Element | Enter an element (IP address or domain) that you need to delete from a network list. Example: "1.1.1.1" | 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. Example: "12345_blackliststag" | Text | Required | |
Extended | Choose to extend the retrieved network list. Example: false | Boolean | Optional | Default value: false Allowed values:
When set to true, additional details of network list such as creation, updation, and deployment status is provided. |
Include Elements | Choose to include all elements in the retrieved response. Example: false | Boolean | Optional | Default value: true Allowed values:
If set to true, then the response includes all elements. |
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. Example: "12345_blackliststag" | 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. Example: "12345_blacklist" | Text | Required | |
Extended | Choose to extend the network list. Example: false | Boolean | Optional | Default value: false Allowed values:
If set to true, then the additional details of the network list such as creation, updation, and deployment status are provided. |
Include Elements | Choose to include all elements in the retrieved response. Example: false | Boolean | Optional | Default value: true Allowed values:
If set to true, then the response includes all elements. |
Name | Enter the updated name for the network list. Example: "network list" | Text | Required | |
List Type | Enter the list type as IP or domain. Example: "IP" | Text | Required | Allowed values:
|
Description | Enter the description. Example: "updating network list" | Text | Required | |
Syncpoint | Enter the syncPoint value. It identifies the version of the network list that increments each time on modification. Example: 5 | Integer | Required | You can retrieve a value of syncPoint from the response of the Get a Network List action. |
List Items | Enter the list of items (IP addresses or domains) to add to the network list. Example: $LIST["1.1.1.1", "2.2.2.2"]. | List | Required |