Skip to main content

REST APIs for 22.2

Organization Settings

For Organization Settings parameters, properties, JSON request and response bodies, and example curl commands, see "Organization Settings" in the Illumio Core REST API Reference.

Get Events Settings

Returns events settings information.

For parameters, properties, JSON response body, and example curl command, see "Get Events Settings" in the Illumio Core REST API Reference.

Example JSON Response Body for Get Events Settings

{
    "audit_event_retention_seconds": 180,
    "audit_event_min_severity": "informational",
    "format": "JSON"
}
Update Events Settings

For parameters, properties, JSON request body, and example curl command, see "Update Events Settings" in the Illumio Core REST API Reference.

Example JSON Request Body for Update Events

{
    "audit_event_retention_seconds": 90,
    "audit_event_min_severity": "informational"
}
Syslog Destinations

Use this API to specify a local syslog location and/or one or more remote syslog locations.

Get all Syslog Destinations

Returns all syslog destination information.

For parameters, properties, JSON response body, and example curl command, see "Get Syslog Destinations" in the Illumio Core REST API Reference.

Example JSON Response Body with Local and Remote Syslog Location Information

[
    {
        "href": "/api/v2/orgs/1/settings/syslog/destinations/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "pce_scope": [ "my-company0.com", "my-company1.com", "my-company2.com" ],
        "type": "local_syslog",
        "description": "local dev/log",
        "audit_event_logger": {
            "configuration_event_included": true,
            "system_event_included": true,
            "min_severity": "informational"
        },
        "traffic_event_logger": {
            "traffic_flow_allowed_event_included": true,
            "traffic_flow_potentially_blocked_event_included": true,
            "traffic_flow_blocked_event_included": true
        },
        "node_status_logger": {
            "node_status_included": true
        }
    },
    {
        "href": "/api/v2/orgs/1/settings/syslog/destinations/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "pce_scope": [ "remote-my-company0.com", "remote-my-company1.com" ],
        "type": "remote_syslog",
        "description": "remotesyslog",
        "audit_event_logger": {
            "configuration_event_included": true,
            "system_event_included": false,
            "min_severity": "warning"
        },
        "traffic_event_logger": {
            "traffic_flow_allowed_event_included": true,
            "traffic_flow_potentially_blocked_event_included": true,
            "traffic_flow_blocked_event_included": true
        },
        "node_status_logger": {
            "node_status_included": true
        },
        "remote_syslog": {
            "address"  : "my-company-20.com",
            "port"     : 12345,
            "protocol" : 6,
            "tls_enabled"     : false,
            "tls_verify_cert" : false
        }
    }
]
Get a Specified Syslog Destination

Returns information about one syslog destination.

For parameters, properties, JSON response body, and example curl command, see "Get a Syslog Destination" in the Illumio Core REST API Reference.

Example JSON Response Body with Remote Syslog Location Information

{
    "href": "/api/v2/orgs/1/settings/syslog/destinations/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "pce_scope": [ "remote-my-company0.com", "remote-my-company1.com" ],
    "type": "remote_syslog",
    "description": "remotesyslog",
    "audit_event_logger": {
        "configuration_event_included": true,
        "system_event_included": false,
        "min_severity": "warning"
    },
    "traffic_event_logger": {
        "traffic_flow_allowed_event_included": true,
        "traffic_flow_potentially_blocked_event_included": true,
        "traffic_flow_blocked_event_included": true
    },
    "node_status_logger": {
        "node_status_included": true
    },
    "remote_syslog": {
        "address"  : "my-company-20.com",
        "port"     : 12345,
        "protocol" : 6,
        "tls_enabled"     : false,
        "tls_verify_cert" : false
    }
}
Create a Syslog Destination

Creates a local and remote syslog destination.

For parameters, properties, JSON request body, and example curl command, see "Create a Syslog Destination" in the Illumio Core REST API Reference.

Example JSON Request Body to Create a Remote Syslog Destination

{
    "pce_scope": [ "my-company0.com", "my-company1.com", "my-company2.com" ],
    "type": "remote_syslog",
    "description": "remote syslog",
    "audit_event_logger": {
        "configuration_event_included": true,
        "system_event_included": false,
        "min_severity": "warning"
    },
    "traffic_event_logger": {
       "traffic_flow_allowed_event_included": true,
       "traffic_flow_potentially_blocked_event_included": true,
       "traffic_flow_blocked_event_included": true
    },
    "node_status_logger": {
        "node_status_included": true
    },
    "remote_syslog": {
        "address"  : "my-company-20.com",
        "port"     : 12345,
        "protocol" : 6,
        "tls_enabled"     : false,
        "tls_verify_cert" : false
    }
}
Update a Syslog Destination

Updates a local and a remote syslog destination.

For parameters, properties, JSON request body, and example curl command, see "Update a Syslog Destination" in the Illumio Core REST API Reference.

Example JSON Request Body to Update a Syslog Destination

{
    "href": "/api/v2/orgs/1/settings/syslog/destinations/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "pce_scope": [ "my-company0.com", "my-company1.com", "my-company2.com"  ],
    "type": "remote_syslog",
    "description": "localhost syslog",
    "audit_event_logger": {
        "configuration_event_included": true,
        "system_event_included": true,
        "min_severity": "informational"
    },
    "traffic_event_logger": {
       "traffic_flow_allowed_event_included": true,
       "traffic_flow_potentially_blocked_event_included": true,
       "traffic_flow_blocked_event_included": true
    },
    "node_status_logger": {
        "node_status_included": false
    },
    "remote_syslog": {
        "address"  : "my-company-20.com",
        "port"     : 67890,
        "protocol" : 6,
        "tls_enabled"     : false,
        "tls_verify_cert" : false
    }
}
Delete a Syslog Destination

Deletes a syslog destination.

For parameters, properties, and example curl command, see "Delete a Syslog Destination" in the Illumio Core REST API Reference.