Illumio Core Protection
Illumio Core Protection provides segmentation to secure on-premises and cloud data center workloads. Illumio Core secure reduces the impact of breaches. This connector integrates Illumio Core with Turbine.
Prerequisites
This connector can be authenticated in one of two ways:
- Using Email and Password for PCE account.
- Using API Authentication Username and API Key Secret.
Capabilities
This connector provides the following capabilities:
- Get a Workload by ID
- Get Firewall Policies
- Get Ransomware details for a Workload
- Get Security Policy Versions
- Get VEN Instance Details
- Get Workloads Settings
- Get Workloads
Asset Setup
To create API Keys in the PCE web console, follow the following instructions:
- In the drop-down User menu, select My API Keys. A list of configured API keys is displayed. If no API keys are configured, the message "No API Keys" is displayed.
- To add a new API key, click Add.
- In the Create API Key pop-up window, enter a name for the API key in the Name field. Optionally, enter a description in the Description field.
- Click Save to save your API key or click Cancel to close the pop-up window without saving your changes.
- When the API Key Created window appears, click the > button next to "Show credentials" to display the credentials for your API key. The following information is displayed:
- Key ID: The unique ID of the API key.
- Authentication Username: The username that authenticates the API calls.
- Secret: The password for the API key
- Click Download Credentials to download the credentials as a text file. Make sure that you have saved the credential information before clicking Done. After you click Done, the API Keys page displays a summary of your new API key, including the following information:
- Name
- Description
- Key ID
- Authentication Username
- Created On
Notes
Additional Documentation
Configurations
API Key Authentication
Authenticates using API Key.
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | A URL to the target host. | string | Required |
auth_username | API Authentication Username | string | Required |
api_secret | API Key Secret | string | Required |
verify_ssl | Verify SSL certificate | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
Email and Password Authentication
Authenticates using email and password.
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | A URL to the target host. | string | Required |
Email Address used to create your PCE account. | string | Required | |
password | Password for your PCE account. | string | Required |
verify_ssl | Verify SSL certificate | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
pce_fqdn | Fully Qualified Domain Name for PCE. | string | Required |
one_time_password | One Time Password | string | Optional |
Actions
Get a Workload by ID
Get a Workload by ID.
Endpoint
- URL: /api/v2/orgs/{{org_id}}/workloads/{{workload_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.workload_id | string | Required | Parameters for the Get a Workload by ID action |
path_parameters.org_id | string | Required | Parameters for the Get a Workload by ID action |
Input Example
{"path_parameters":{"workload_id":"string","org_id":"string"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
href | string | Output field: href |
deleted | boolean | Output field: deleted |
delete_type | string | Type of the resource |
name | string | Name of the resource |
description | string | Output field: description |
managed | boolean | Output field: managed |
hostname | string | Name of the resource |
service_principal_name | string | Name of the resource |
agent_to_pce_certificate_authentication_id | object | Unique identifier |
distinguished_name | string | Name of the resource |
public_ip | string | Output field: public_ip |
external_data_set | object | Response data |
external_data_reference | object | Response data |
interfaces | object | Output field: interfaces |
interfaces.name | string | Name of the resource |
interfaces.link_state | object | Output field: interfaces.link_state |
interfaces.address | string | Output field: interfaces.address |
interfaces.cidr_block | object | Unique identifier |
interfaces.default_gateway_address | object | Output field: interfaces.default_gateway_address |
interfaces.network | object | Output field: interfaces.network |
interfaces.network.href | string | Output field: interfaces.network.href |
interfaces.network.name | object | Name of the resource |
interfaces.network_detection_mode | object | Output field: interfaces.network_detection_mode |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 23 Oct 2023 18:35:52 GMT","Content-Type":"application/json; charset=UTF-8","Content-Length":"270","Connection":"keep-alive","access-control-max-age":"604800","vary":"Accept-Encoding","content-encoding":"gzip","x-correlation-id":"ebc917c8ac68fc9bfb2c05b7abf10577, 491270c0187293672c0ad339c6678cec","strict-transport-security":"max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains","x-frame-options":"DENY, DENY","x-rate-limit-lim...
Get Firewall Policies
Get Firewall Policies
Endpoint
- URL: /api/v2/orgs/{{org_id}}/sec_policy/{{pversion}}/firewall_settings
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.pversion | string | Required | Parameters for the Get Firewall Policies action |
path_parameters.org_id | string | Required | Parameters for the Get Firewall Policies action |
Input Example
{"path_parameters":{"pversion":"string","org_id":"string"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
static_policy_scopes | array | Output field: static_policy_scopes |
static_policy_scopes.0 | object | Output field: static_policy_scopes.0 |
static_policy_scopes.0.exclusion | boolean | Output field: static_policy_scopes.0.exclusion |
static_policy_scopes.0.label | object | Output field: static_policy_scopes.0.label |
static_policy_scopes.0.label.href | string | Output field: static_policy_scopes.0.label.href |
static_policy_scopes.0.label.key | string | Output field: static_policy_scopes.0.label.key |
static_policy_scopes.0.label.value | string | Value for the parameter |
static_policy_scopes.0.label_group | object | Output field: static_policy_scopes.0.label_group |
static_policy_scopes.0.label_group.href | string | Output field: static_policy_scopes.0.label_group.href |
static_policy_scopes.0.label_group.key | string | Output field: static_policy_scopes.0.label_group.key |
static_policy_scopes.0.label_group.name | string | Name of the resource |
ike_authentication_type | string | Type of the resource |
firewall_coexistence | object | Output field: firewall_coexistence |
allow_captive_portal_outbound | boolean | Output field: allow_captive_portal_outbound |
containers_inherit_host_policy_scopes | array | Output field: containers_inherit_host_policy_scopes |
containers_inherit_host_policy_scopes.0 | object | Output field: containers_inherit_host_policy_scopes.0 |
containers_inherit_host_policy_scopes.0.exclusion | boolean | Output field: containers_inherit_host_policy_scopes.0.exclusion |
containers_inherit_host_policy_scopes.0.label | object | Output field: containers_inherit_host_policy_scopes.0.label |
containers_inherit_host_policy_scopes.0.label.href | string | Output field: containers_inherit_host_policy_scopes.0.label.href |
containers_inherit_host_policy_scopes.0.label.key | string | Output field: containers_inherit_host_policy_scopes.0.label.key |
containers_inherit_host_policy_scopes.0.label.value | string | Value for the parameter |
containers_inherit_host_policy_scopes.0.label_group | object | Output field: containers_inherit_host_policy_scopes.0.label_group |
containers_inherit_host_policy_scopes.0.label_group.href | string | Output field: containers_inherit_host_policy_scopes.0.label_group.href |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 23 Oct 2023 18:35:52 GMT","Content-Type":"application/json; charset=UTF-8","Content-Length":"270","Connection":"keep-alive","access-control-max-age":"604800","vary":"Accept-Encoding","content-encoding":"gzip","x-correlation-id":"ebc917c8ac68fc9bfb2c05b7abf10577, 491270c0187293672c0ad339c6678cec","strict-transport-security":"max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains","x-frame-options":"DENY, DENY","x-rate-limit-lim...
Get Ransomware Details for a Workload
Get Ransomware details for a Workload.
Endpoint
- URL: /api/v2/orgs/{{org_id}}/workloads/{{workload_id}}/risk_details
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.workload_id | string | Required | Parameters for the Get Ransomware Details for a Workload action |
path_parameters.org_id | string | Required | Parameters for the Get Ransomware Details for a Workload action |
Input Example
{"path_parameters":{"workload_id":"string","org_id":"string"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
risk_details | object | Output field: risk_details |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 23 Oct 2023 18:35:52 GMT","Content-Type":"application/json; charset=UTF-8","Content-Length":"270","Connection":"keep-alive","access-control-max-age":"604800","vary":"Accept-Encoding","content-encoding":"gzip","x-correlation-id":"ebc917c8ac68fc9bfb2c05b7abf10577, 491270c0187293672c0ad339c6678cec","strict-transport-security":"max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains","x-frame-options":"DENY, DENY","x-rate-limit-lim...
Get Security Policy Versions
Get Security Policy Versions
Endpoint
- URL: /api/v2/orgs/{{org_id}}/sec_policy
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.org_id | string | Required | Parameters for the Get Security Policy Versions action |
Input Example
{"path_parameters":{"org_id":"string"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
href | string | Output field: href |
version | number | Output field: version |
workloads_affected | object | Output field: workloads_affected |
commit_message | object | Response message |
object_counts | object | Output field: object_counts |
object_counts.rule_sets | number | Output field: object_counts.rule_sets |
object_counts.ip_lists | number | Output field: object_counts.ip_lists |
object_counts.services | number | Output field: object_counts.services |
object_counts.virtual_services | number | Output field: object_counts.virtual_services |
object_counts.label_groups | number | Output field: object_counts.label_groups |
object_counts.virtual_servers | number | Output field: object_counts.virtual_servers |
object_counts.firewall_settings | number | Output field: object_counts.firewall_settings |
object_counts.secure_connect_gateways | number | Output field: object_counts.secure_connect_gateways |
object_counts.enforcement_boundaries | number | Output field: object_counts.enforcement_boundaries |
created_at | string | Output field: created_at |
created_by | object | Output field: created_by |
created_by.href | string | Output field: created_by.href |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 23 Oct 2023 18:35:52 GMT","Content-Type":"application/json; charset=UTF-8","Content-Length":"270","Connection":"keep-alive","access-control-max-age":"604800","vary":"Accept-Encoding","content-encoding":"gzip","x-correlation-id":"ebc917c8ac68fc9bfb2c05b7abf10577, 491270c0187293672c0ad339c6678cec","strict-transport-security":"max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains","x-frame-options":"DENY, DENY","x-rate-limit-lim...
Get VEN Instance Details
Get details on a VEN instance.
Endpoint
- URL: /api/v2/orgs/{{org_id}}/vens/{{ven_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.ven_id | string | Required | Parameters for the Get VEN Instance Details action |
path_parameters.org_id | string | Required | Parameters for the Get VEN Instance Details action |
Input Example
{"path_parameters":{"ven_id":"string","org_id":"string"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
href | string | Output field: href |
name | object | Name of the resource |
description | object | Output field: description |
hostname | string | Name of the resource |
uid | object | Unique identifier |
os_id | object | Unique identifier |
os_detail | object | Output field: os_detail |
os_platform | object | Output field: os_platform |
version | string | Output field: version |
status | string | Status value |
activation_type | string | Type of the resource |
active_pce_fqdn | object | Output field: active_pce_fqdn |
target_pce_fqdn | object | Output field: target_pce_fqdn |
labels | array | Output field: labels |
labels.href | string | Output field: labels.href |
labels.key | string | Output field: labels.key |
labels.value | string | Value for the parameter |
interfaces | array | Output field: interfaces |
interfaces.name | string | Name of the resource |
interfaces.link_state | object | Output field: interfaces.link_state |
interfaces.address | string | Output field: interfaces.address |
interfaces.cidr_block | object | Unique identifier |
interfaces.default_gateway_address | object | Output field: interfaces.default_gateway_address |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 23 Oct 2023 18:35:52 GMT","Content-Type":"application/json; charset=UTF-8","Content-Length":"270","Connection":"keep-alive","access-control-max-age":"604800","vary":"Accept-Encoding","content-encoding":"gzip","x-correlation-id":"ebc917c8ac68fc9bfb2c05b7abf10577, 491270c0187293672c0ad339c6678cec","strict-transport-security":"max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains","x-frame-options":"DENY, DENY","x-rate-limit-lim...
Get Workloads
Get all workloads.
Endpoint
- URL: /api/v2/orgs/{{org_id}}/workloads
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.org_id | string | Required | Parameters for the Get Workloads action |
parameters.agent.active_pce_fqdn | string | Optional | Parameters for the Get Workloads action |
parameters.container_clusters | string | Optional | Parameters for the Get Workloads action |
parameters.description | string | Optional | Parameters for the Get Workloads action |
parameters.enforcement_mode | string | Optional | Parameters for the Get Workloads action |
parameters.external_data_reference | string | Optional | Parameters for the Get Workloads action |
parameters.external_data_set | string | Optional | Parameters for the Get Workloads action |
parameters.hostname | string | Optional | Parameters for the Get Workloads action |
parameters.include_deleted | boolean | Optional | Parameters for the Get Workloads action |
parameters.ip_address | string | Optional | Parameters for the Get Workloads action |
parameters.labels | string | Optional | Parameters for the Get Workloads action |
parameters.last_heartbeat_on[gte] | string | Optional | Parameters for the Get Workloads action |
parameters.last_heartbeat_on[lte] | string | Optional | Parameters for the Get Workloads action |
parameters.log_traffic | boolean | Optional | Parameters for the Get Workloads action |
parameters.managed | boolean | Optional | Parameters for the Get Workloads action |
parameters.max_results | number | Optional | Parameters for the Get Workloads action |
parameters.mode | string | Optional | Parameters for the Get Workloads action |
parameters.name | string | Optional | Parameters for the Get Workloads action |
parameters.online | boolean | Optional | Parameters for the Get Workloads action |
parameters.os_id | string | Optional | Parameters for the Get Workloads action |
parameters.policy_health | string | Optional | Parameters for the Get Workloads action |
parameters.security_policy_sync_state | string | Optional | Parameters for the Get Workloads action |
parameters.security_policy_update_mode | string | Optional | Parameters for the Get Workloads action |
parameters.soft_deleted | boolean | Optional | Parameters for the Get Workloads action |
parameters.ven | string | Optional | Parameters for the Get Workloads action |
Input Example
{"path_parameters":{"org_id":"string"},"parameters":{"agent.active_pce_fqdn":"string","container_clusters":"string","description":"string","enforcement_mode":"string","external_data_reference":"string","external_data_set":"string","hostname":"Example Name","include_deleted":true,"ip_address":"string","labels":"string","last_heartbeat_on[gte]":"string","last_heartbeat_on[lte]":"string","log_traffic":true,"managed":true,"max_results":123,"mode":"string","name":"Example Name","online":true,"os_id":"string","policy_health":"string","security_policy_sync_state":"string","security_policy_update_mode":"string","soft_deleted":true,"ven":"string","ven.ven_type":"string","visibility_level":"string","vulnerability_summary.vulnerability_exposure_score[gte]":123,"vulnerability_summary.vulnerability_exposure_score[lte]":123}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
href | string | Output field: href |
deleted | boolean | Output field: deleted |
delete_type | string | Type of the resource |
name | string | Name of the resource |
description | string | Output field: description |
managed | boolean | Output field: managed |
hostname | string | Name of the resource |
service_principal_name | string | Name of the resource |
agent_to_pce_certificate_authentication_id | object | Unique identifier |
distinguished_name | string | Name of the resource |
public_ip | string | Output field: public_ip |
external_data_set | object | Response data |
external_data_reference | object | Response data |
interfaces | object | Output field: interfaces |
interfaces.name | string | Name of the resource |
interfaces.link_state | object | Output field: interfaces.link_state |
interfaces.address | string | Output field: interfaces.address |
interfaces.cidr_block | object | Unique identifier |
interfaces.default_gateway_address | object | Output field: interfaces.default_gateway_address |
interfaces.network | object | Output field: interfaces.network |
interfaces.network.href | string | Output field: interfaces.network.href |
interfaces.network.name | object | Name of the resource |
interfaces.network_detection_mode | object | Output field: interfaces.network_detection_mode |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 23 Oct 2023 18:35:52 GMT","Content-Type":"application/json; charset=UTF-8","Content-Length":"270","Connection":"keep-alive","access-control-max-age":"604800","vary":"Accept-Encoding","content-encoding":"gzip","x-correlation-id":"ebc917c8ac68fc9bfb2c05b7abf10577, 491270c0187293672c0ad339c6678cec","strict-transport-security":"max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains","x-frame-options":"DENY, DENY","x-rate-limit-lim...
Get Workloads Settings
Get Workloads Settings
Endpoint
- URL: /api/v2/orgs/{{org_id}}/settings/workloads
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.org_id | string | Required | Parameters for the Get Workloads Settings action |
Input Example
{"path_parameters":{"org_id":"string"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
workload_disconnected_timeout_seconds | array | Output field: workload_disconnected_timeout_seconds |
workload_disconnected_timeout_seconds.scope | array | Output field: workload_disconnected_timeout_seconds.scope |
workload_disconnected_timeout_seconds.scope.href | string | Output field: workload_disconnected_timeout_seconds.scope.href |
workload_disconnected_timeout_seconds.value | number | Value for the parameter |
workload_disconnected_timeout_seconds.ven_type | string | Type of the resource |
workload_goodbye_timeout_seconds | array | Output field: workload_goodbye_timeout_seconds |
workload_goodbye_timeout_seconds.scope | array | Output field: workload_goodbye_timeout_seconds.scope |
workload_goodbye_timeout_seconds.scope.href | string | Output field: workload_goodbye_timeout_seconds.scope.href |
workload_goodbye_timeout_seconds.value | number | Value for the parameter |
workload_goodbye_timeout_seconds.ven_type | string | Type of the resource |
workload_disconnected_notification_seconds | array | Output field: workload_disconnected_notification_seconds |
workload_disconnected_notification_seconds.scope | array | Output field: workload_disconnected_notification_seconds.scope |
workload_disconnected_notification_seconds.scope.href | string | Output field: workload_disconnected_notification_seconds.scope.href |
workload_disconnected_notification_seconds.warning | number | Output field: workload_disconnected_notification_seconds.warning |
workload_disconnected_notification_seconds.ven_type | string | Type of the resource |
ven_uninstall_timeout_hours | array | Output field: ven_uninstall_timeout_hours |
ven_uninstall_timeout_hours.scope | array | Output field: ven_uninstall_timeout_hours.scope |
ven_uninstall_timeout_hours.scope.href | string | Output field: ven_uninstall_timeout_hours.scope.href |
ven_uninstall_timeout_hours.value | number | Value for the parameter |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 23 Oct 2023 18:35:52 GMT","Content-Type":"application/json; charset=UTF-8","Content-Length":"270","Connection":"keep-alive","access-control-max-age":"604800","vary":"Accept-Encoding","content-encoding":"gzip","x-correlation-id":"ebc917c8ac68fc9bfb2c05b7abf10577, 491270c0187293672c0ad339c6678cec","strict-transport-security":"max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains","x-frame-options":"DENY, DENY","x-rate-limit-lim...
Response Headers
Header | Description | Example |
|---|---|---|
access-control-allow-headers | HTTP response header: access-control-allow-headers | authorization, x-verify-credentials-authorization, x-auth-service-provider, x-twitter-client-version, Content-Type |
access-control-allow-methods | HTTP response header: access-control-allow-methods | GET,POST,PUT,DELETE,PATCH |
access-control-allow-origin | HTTP response header: access-control-allow-origin | * |
access-control-max-age | HTTP response header: access-control-max-age | 604800 |
Connection | HTTP response header: Connection | keep-alive |
content-encoding | HTTP response header: content-encoding | gzip |
Content-Length | The length of the response body in bytes | 270 |
Content-Type | The media type of the resource | application/json; charset=UTF-8 |
Date | The date and time at which the message was originated | Mon, 23 Oct 2023 18:35:52 GMT |
strict-transport-security | HTTP response header: strict-transport-security | max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains |
vary | HTTP response header: vary | Accept-Encoding |
x-correlation-id | A unique identifier for correlating requests | ebc917c8ac68fc9bfb2c05b7abf10577, 491270c0187293672c0ad339c6678cec |
x-frame-options | HTTP response header: x-frame-options | DENY, DENY |
x-rate-limit-limit | HTTP response header: x-rate-limit-limit | 60 |
x-rate-limit-remain | HTTP response header: x-rate-limit-remain | 59 |
x-rate-limit-reset | HTTP response header: x-rate-limit-reset | 1698086751362 |