Cyware Orchestrate

Create Policy 

This action creates a new policy.

Create Site 

This action creates a new site.

Delete List 

This action deletes a list.

Delete Policy 

This action deletes a policy.

Delete Site 

This action deletes a specific site.

Generic Action 

This is a generic action used to make requests to any Akamai Secure Internet Access Enterprise Configuration endpoint.

Get All ETP Configurations 

This action retrieves all the enterprise threat protector configurations.

Get List Details 

This action retrieves the details of a specific list.

Get Policy 

This action retrieves the details of a policy.

Get Security List 

This action retrieves the security list from Akamai Secure Internet Access Enterprise Configuration.

List Policies 

This action lists all the policies.

List Sites 

This action lists all the sites.

Patch List Items 

This action filters the items in a list by using search parameters.

Search in List 

This action filters the items in a list by using search parameters.

Update List 

This action updates a list.

Update List Items 

This action updates the list items.

Update Site 

This action updates a site.

Hostname 

Enter the hostname. 

Example: 

test.akamaiapis.net

Text

Required

EdgeGrid Client Token 

Enter the EdgeGrid client token.

Password

Required

To generate authentication credentials, see Akamai Secure Internet Access Enterprise Configuration API Documentation.

EdgeGrid Client Secret 

Enter the EdgeGrid client secret.

Password

Required

EdgeGrid Access Token 

Enter the EdgeGrid access token.

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, this is disabled.

Timeout 

Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with Akamai Secure Internet Access Enterprise Configuration.

Integer

Optional

Allowed range:

15-120

Default value:

15

Config ID 

Enter the configuration ID. 

Example: 

100

Text

Required

You can retrieve this using the action Get All ETP Configurations.

AUP Setting 

Enter the acceptable use policy (AUP) setting. 

Example: 

['test']

List

Required

DNS Security 

Enter true to enable DNS security.

Boolean

Required

Allowed values:

EDNS Security 

Enter true to optimize CDN traffic using the EDNS-Client-Subnet extension.

Boolean

Required

Allowed values:

Name 

Enter the name of the policy. 

Example: 

EMEA policy

Text

Required

Description 

Enter the description of the policy. 

Example: 

EMEA sites

Text

Required

Notify Confirmed 

Enter true to send an alert on a confirmed threat.

Boolean

Required

Allowed values:

Notify Suspected 

Enter true to send an alert on a suspected threat.

Boolean

Required

Allowed values:

Sites 

Enter the sites. 

Example: 

["test"]

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 Secure Internet Access Enterprise Configuration API Documentation.

Additional Data 

Enter any additional data you want to include while creating a policy.

Key Value

Optional

Config ID 

Enter the configuration ID. 

Example: 

100

Integer

Required

You can retrieve this using the action Get All ETP Configurations.

Name 

Enter the name of the site. 

Example: 

Samplename

Text

Required

Exit Points 

Enter the site exit points. 

Example: 

[{"addrtype": "ipv4", "ipaddr": "1.1.1.1"}]

List

Optional

Allowed keys:

Dynamic Exit Points 

Enter the dynamic exit points. 

Example: 

[{"addrtype": "ipv4", "ipaddr": "1.1.1.1"}]

List

Optional

Allowed keys:

IPsec Credentials 

Enter the IPsec credentials. 

Example: 

{"password": "test", "username": "test"}

Key Value

Optional

Allowed keys:

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 Secure Internet Access Enterprise Configuration API Documentation.

Description 

Enter the description of the site. 

Example: 

This is a test site

Text

Optional

Policy Info 

Enter the policy information applicable for incoming DNS requests. 

Example: 

{"id": 100, "name": "test"}

Key Value

Optional

Allowed keys:

Additional Data 

Enter any additional data you want to include while creating a site.

Key Value

Optional

Config ID 

Enter the configuration ID. 

Example: 

456

Integer

Required

You can retrieve this using the action Get All ETP Configurations.

List ID 

Enter the list ID. 

Example: 

3785

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 Secure Internet Access Enterprise Configuration API Documentation.

Config ID 

Enter the configuration ID. 

Example: 

456

Integer

Required

You can retrieve this using the action Get All ETP Configurations.

Policy ID 

Enter the policy ID. 

Example:

5001

Integer

Required

You can retrieve this using the action List Policies.

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 Secure Internet Access Enterprise Configuration API Documentation.

Config ID 

Enter the configuration ID. 

Example: 

456

Integer

Required

You can retrieve this using the action Get All ETP Configurations.

Site ID 

Enter the site ID. 

Example:

101

Integer

Required

You can retrieve this using the action List Sites.

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 Secure Internet Access Enterprise Configuration API Documentation.

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 Secure Internet Access Enterprise Configuration API Documentation. 

Config ID 

Enter the configuration ID. 

Example: 

100

Integer

Required

You can retrieve this using the action Get All ETP Configurations.

List ID 

Enter the list ID. 

Example:

100

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 Secure Internet Access Enterprise Configuration API Documentation.

Include Deleted 

Enter true to include the deleted list in the response.

Boolean

Optional

Config ID 

Enter the configuration ID. 

Example: 

100

Integer

Required

You can retrieve this using the action Get All ETP Configurations.

Policy ID 

Enter the policy ID. 

Example:

100

Integer

Required

You can retrieve this using the action List Policies.

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 Secure Internet Access Enterprise Configuration API Documentation.

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 Secure Internet Access Enterprise Configuration API Documentation.

Include Non-Configurable 

Enter true to include non-configurable resources in the response. 

Boolean

Optional

Allowed values:

Default value:

false

Config ID 

Enter the configuration ID. 

Example: 

100

Text

Required

You can retrieve this using the action Get All ETP 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 Secure Internet Access Enterprise Configuration API Documentation.

Config ID 

Enter the configuration ID. 

Example: 

100

Integer

Required

You can retrieve this using the action Get All ETP 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 Secure Internet Access Enterprise Configuration API Documentation.

Config ID 

Enter the configuration ID. 

Example: 

100

Integer

Required

You can retrieve this using the action Get All ETP Configurations.

List ID 

Enter the list ID.

Example: 

3785

Integer

Required

Delete List 

Enter an array of IP addresses, domains, URLs, and file hashes to delete in the patch operation. 

Example: 

$LIST[192.0.2.47, 192.0.2.125]

List

Required

Add List 

Enter the list item details to add while patching list items. 

Example: 

$JSON[{"confidencelevelid": 2,"type": "list_type_ip","value": "192.0.2.208"}]

Any

Required

Allowed keys:

confidenceLevelId, type, value

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 Secure Internet Access Enterprise Configuration API Documentation.

Additional Data 

Enter any additional data you want to pass while patching list items. 

Example: 

{'remainingcount':23}

Key Value

Optional

Config ID 

Enter the configuration ID. 

Example: 

100

Integer

Required

You can retrieve this using the action Get All ETP Configurations.

List ID 

Enter the list ID. 

Example: 

3785

Integer

Required

Search 

Enter the value to search for a string in the response.

Example: 

192.0.2.163

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 Secure Internet Access Enterprise Configuration API Documentation.

Confidence 

Enter the threat confidence level of the list item. 

Integer

Optional

Allowed values: 

Default value:

0

Additional Data 

Enter the additional filters that you want to apply while searching in the list. 

Example: 

{'type': 'list_type_ip'}

Key Value

Optional

Allowed keys:

Config ID 

Enter the configuration ID. 

Example: 

100

Integer

Required

You can retrieve this using the action Get All ETP Configurations.

List ID 

Enter the list ID. 

Example: 

3785

Integer

Required

Name 

Enter the name of the list. 

Example: 

Samplename

Text

Required

Description 

Enter the description of the list. 

Example: 

Sample description

Text

Required

Include Deleted 

Enter true to include deleted resources in the response. 

Boolean

Optional

Default value:

false

Access Config 

Enter the access configuration details. 

Example: 

{"configurable": true, "readable": true, 'delegatedadmins': ['test']}

Key Value

Optional

Allowed keys:

Policy Security Settings 

Enter the policy security settings. 

Example: 

[{"policyid": 100, "policyname": "test"}]

List

Optional

Allowed keys:

Known Counts 

Enter the data of known counts. 

Example: 

{"domains": 1, "ips": 1}

Key Value

Optional

Allowed keys:

Security Category Info 

Enter the security category information. 

Example: 

{"id": 1, "name": "test"}

Key Value

Optional

Allowed keys:

Suspected Counts 

Enter the count of suspected entries in the list.

Example: 

{"domains": 1, "ips": 1}

Key Value

Optional

Allowed keys:

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 Secure Internet Access Enterprise Configuration API Documentation.

If Match 

Enter Etag value. 

Example: 

a9dfe78cf93090516bde891d009eaf57

Text

Required

For more information, see Akamai Secure Internet Access Enterprise Configuration API Documentation.

Additional Data 

Enter any additional data you want to pass while updating a list.

Key Value

Optional

Config ID 

Enter the configuration ID. 

Example: 

100

Integer

Required

You can retrieve this using the action Get All ETP Configurations.

List ID 

Enter the list ID. 

Example: 

3785

Integer

Required

Confidence level ID 

Enter the confidence level ID.

Integer

Required

Allowed values:

Item Type 

Enter the list item type.

Example: 

domain

Text

Required

 Allowed values:

Value 

Enter the IP address or the domain of the list item.

Example: 

sampledomain.com

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 Secure Internet Access Enterprise Configuration API Documentation.

Additional Data 

Enter additional data that you want to update.

Example: 

{'remainingcount':23}

Key Value

Optional

Config ID 

Enter the configuration ID. 

Example: 

456

Integer

Required

You can retrieve this using the action Get All ETP Configurations.

Site ID 

Enter the site ID. 

Example:

101

Integer

Required

You can retrieve this using the action List Sites.

Name 

Enter the name of the site. 

Example: 

Samplename

Text

Required

Policy ID 

Enter the policy ID. 

Example:

1030

Integer

Required

You can retrieve this using the action List Policies.

Exit Points 

Enter the site exit points. 

Example: 

[{"addrtype": "ipv4", "ipaddr": "1.1.1.1"}]

List

Required

Allowed keys:

Dynamic Exit Points 

Enter the dynamic exit points. 

Example: 

[{"addrtype": "ipv4", "ipaddr": "5.5.5.5"}]

List

Optional

Allowed keys:

IPsec Credentials 

Enter the IPsec credentials. 

Example: 

{"password": "test", "username": "test"}

Key Value

Optional

Access Config 

Enter the access configuration details. 

Example: 

{"configurable": true, "readable": true, "delegatedadmins": ["test"]}

Key Value

Optional

Allowed keys:

Description 

Enter the description of the site. 

Example: 

this is a test site

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 Secure Internet Access Enterprise Configuration API Documentation.

If Match 

Enter Etag value. 

Example: 

a9dfe78cf93090516bde891d009eaf57

Text

Required

For more information, see Akamai Secure Internet Access Enterprise Configuration API Documentation.

Additional Data 

Enter any additional data you want to update.

Key Value

Optional

Endpoint 

Enter the endpoint to make the request. 

Example: 

/configs/{configid}/lists/{listid}/items

Text

Required

Method 

Enter the HTTP method to make the request.  

Example: 

GET

Text

Required

Allowed values:

Payload 

Enter the payload to pass to the API. 

Example: 

{"confidencelevelid": 1, "itemtype": "domain", "value": "test.com"}

Key Value

Optional

Query Params 

Enter the query parameters to pass to the API. 

Example: 

{"accountswitchkey": “1-5C0YLB:1-8BYUX”}

Key Value

Optional

Extra Fields 

Enter any additional data you want to pass while patching list items.

Key Value

Optional