Pixis

The Pixis connector allows seamless integration with the Pixis platform, enabling automated network management and security operations.

Pixis is a comprehensive network security management platform that allows for the monitoring and control of network access based on device MAC addresses. The Pixis Turbine Connector enables users to automate critical network security operations such as authorizing, blocking, and querying MAC addresses, as well as managing custom security policies and retrieving customer-specific data. By integrating with Swimlane Turbine, security teams can enhance their network security posture, streamline access control processes, and gain valuable insights into network activity without manual intervention.

Limitations

None to date.

Supported Versions

This Pixis Connector uses the lastest version.

Additional Docs

Configuration

Prerequisites

To utilize the Pixis connector with Swimlane Turbine, ensure you have the following prerequisites:

API key authentication with the following parameters:

URL: Endpoint for the Pixis API.

Account: Your Pixis account identifier.

Watchword: A secure passphrase used for API authentication.

Capabilities

This Pixis Connector provides the following capabilities:

Authorize MAC

Block MAC

Get Customer Column by IP

Get Customer Column by MAC

Get MAC by IP

MAC Policy Query

Pre Check White List

Update Custom Fields by IP

Update Custom Fields by MAC

Authorize MAC

Initiates a MAC address authorization process in Pixis, requiring specific headers and a data body.

Block MAC

Blocks a specified MAC address using Pixis by providing necessary headers and data body.

Get Customer Column by IP

Retrieve customer column data for a specific site and IP address in Pixis using required path parameters and headers.

Get Customer Column by MAC

Retrieves customer column data for a specified MAC address within a given SiteName using the Pixis connector.

Get MAC by IP

Retrieve the MAC address associated with a given IP from Pixis, requiring specific headers and a data body.

MAC Policy Query

Executes a query for MAC policy details in Pixis using specified headers and data body.

Pre Check White List

Verifies if elements are on the whitelist in Pixis by checking against provided headers and data body.

Update Custom Fields by IP

Updates specified custom fields for a device using its IP address within the Pixis SiteName context. Requires path parameters 'SiteName' and 'IP', along with 'Custom_Column' in JSON body.

Update Custom Fields by MAC

Updates specific custom fields for a device identified by MAC address in the specified site within Pixis.

Configurations

Pixis API Authentication

Authenticates using Account and Watchword for the Pixis API.

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
Account	Account for the Pixis API	string	Required
Watchword	Watchword for the Pixis API	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Authorize MAC

Initiates a MAC address authorization in Pixis with required headers and data body.

Endpoint

URL: /apiV2/AuthorizeMac

Method: POST

Input

Argument Name	Type	Required	Description
headers	object	Required	HTTP headers for the request
headers.Content-Type	string	Required	HTTP headers for the request
headers.Accept	string	Required	HTTP headers for the request
data_body	object	Required	Response data
data_body.IsAuth	string	Required	Response data
data_body.MACs	string	Optional	Response data
data_body.SiteId	string	Optional	Response data
data_body.SiteName	string	Optional	Response data
data_body.StartTime	string	Optional	Response data
data_body.EndTime	string	Optional	Response data

Input Example

{"headers":{"Content-Type":"multipart/form-data","Accept":"text/plain"},"data_body":{"IsAuth":"false","MACs":"C3f67dsfads","SiteId":"enim ","SiteName":"tempor occaecat","StartTime":"2007-02-07T00:08:28.247Z","EndTime":"2020-01-02T16:11:45.000Z"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
Code	string	Output field: Code
Message	string	Response message

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Code":"InputMacFormatError","Message":"dolore incididunt ullamco dolor quis"}}

Block MAC

Blocks a specified MAC address on the Pixis platform using provided headers and data body for network security.

Endpoint

URL: /apiV2/BlockMac

Method: POST

Input

Argument Name	Type	Required	Description
headers	object	Required	HTTP headers for the request
headers.Content-Type	string	Required	HTTP headers for the request
headers.Accept	string	Required	HTTP headers for the request
data_body	object	Required	Response data
data_body.IsBlock	string	Required	Response data
data_body.MACs	string	Optional	Response data
data_body.SiteId	string	Optional	Response data
data_body.SiteName	string	Optional	Response data

Input Example

{"headers":{"Content-Type":"multipart/form-data","Accept":"text/plain"},"data_body":{"IsBlock":"false","MACs":"C3f67dsfads","SiteId":"enim ","SiteName":"tempor occaecat"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
Code	string	Output field: Code
Message	string	Response message

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Code":"InputMacFormatError","Message":"dolore incididunt ullamco dolor quis"}}

Get Customer Column by IP

Retrieve customer column data for a specific site and IP address in Pixis, utilizing the provided path parameters and headers.

Endpoint

URL: /apiV2/IpInfo/{{SiteName}}/{{IP}}/Custom_Column

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.SiteName	string	Required	Parameters for the Get Customer Column by IP action
path_parameters.IP	string	Required	Parameters for the Get Customer Column by IP action
headers	object	Required	HTTP headers for the request
headers.Accept	string	Required	HTTP headers for the request

Input Example

{"path_parameters":{"SiteName":"test_site","IP":"test_ip"},"headers":{"Accept":"text/plain"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
Custom_Column	object	Output field: Custom_Column
Custom_Column.esse_bc_	string	Output field: Custom_Column.esse_bc_
IP	string	Output field: IP
SiteName	string	Name of the resource
SiteId	string	Unique identifier

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Custom_Column":{"esse_bc_":"com"},"IP":"aliqua consectetur","SiteName":"aliqua","SiteId":"consequat"}}

Get Customer Column by MAC

Retrieves customer column data for a specified MAC address within a given SiteName using the Pixis connector. Requires path parameters and headers.

Endpoint

URL: /apiV2/MacInfo/{{SiteName}}/{{MAC}}/Custom_Column

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.SiteName	string	Required	Parameters for the Get Customer Column by MAC action
path_parameters.MAC	string	Required	Parameters for the Get Customer Column by MAC action
headers	object	Required	HTTP headers for the request
headers.Accept	string	Required	HTTP headers for the request

Input Example

{"path_parameters":{"SiteName":"test_site","MAC":"test_mac"},"headers":{"Accept":"text/plain"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
Custom_Column	object	Output field: Custom_Column
Custom_Column.dolor_3	string	Output field: Custom_Column.dolor_3
Custom_Column.dolore9	string	Output field: Custom_Column.dolore9
Custom_Column.eiusmod_1	string	Output field: Custom_Column.eiusmod_1
MAC	string	Output field: MAC
SiteName	string	Name of the resource
SiteId	string	Unique identifier

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Custom_Column":{"dolor_3":"id velit","dolore9":"ea id","eiusmod_1":"dolor esse eu et"},"MAC":"aebB59 ce-FA3f","SiteName":"sit culpa","SiteId":"Duis nisi dolor laborum sunt"}}

Get MAC by IP

Retrieve the MAC address associated with a specified IP from Pixis, necessitating specific headers and a data body for execution.

Endpoint

URL: /apiV2/GetMacByIp

Method: POST

Input

Argument Name	Type	Required	Description
headers	object	Required	HTTP headers for the request
headers.Content-Type	string	Required	HTTP headers for the request
headers.Accept	string	Required	HTTP headers for the request
data_body	object	Required	Response data
data_body.IP	string	Required	Response data
data_body.SiteId	string	Optional	Response data
data_body.SiteName	string	Optional	Response data

Input Example

{"headers":{"Content-Type":"multipart/form-data","Accept":"text/plain"},"data_body":{"IP":"reprehenderit laborum","SiteId":"consectetur velit pariatur","SiteName":"dolor consequat"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
Code	string	Output field: Code
Message	string	Response message

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Code":"InputMacFormatError","Message":"dolore incididunt ullamco dolor quis"}}

MAC Policy Query

Executes a query for MAC policy details in Pixis using specified headers and data body.

Endpoint

URL: /apiV2/MACPolicyQuery

Method: POST

Input

Argument Name	Type	Required	Description
headers	object	Required	HTTP headers for the request
headers.Content-Type	string	Required	HTTP headers for the request
headers.Accept	string	Required	HTTP headers for the request
data_body	object	Required	Response data
data_body.MAC	string	Required	Response data
data_body.SiteId	string	Optional	Response data
data_body.SiteName	string	Optional	Response data

Input Example

{"headers":{"Content-Type":"multipart/form-data","Accept":"text/plain"},"data_body":{"MAC":"C3f67dsfads","SiteId":"enim ","SiteName":"tempor occaecat"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
Code	string	Output field: Code
Message	string	Response message

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Code":"InputMacFormatError","Message":"dolore incididunt ullamco dolor quis"}}

Pre Check White List

Verifies elements against the whitelist in Pixis using provided headers and data body.

Endpoint

URL: /apiV2/PreCheckWhiteList

Method: POST

Input

Argument Name	Type	Required	Description
headers	object	Required	HTTP headers for the request
headers.Content-Type	string	Required	HTTP headers for the request
headers.Accept	string	Required	HTTP headers for the request
data_body	object	Required	Response data
data_body.IsWhiteList	string	Required	Response data
data_body.MACs	string	Required	Response data
data_body.SiteId	string	Optional	Response data
data_body.SiteName	string	Optional	Response data
data_body.StartTime	string	Optional	Response data
data_body.EndTime	string	Optional	Response data

Input Example

{"headers":{"Content-Type":"multipart/form-data","Accept":"text/plain"},"data_body":{"IsWhiteList":"false","MACs":"C3f67dsfads","SiteId":"enim ","SiteName":"tempor occaecat","StartTime":"2007-02-07T00:08:28.247Z","EndTime":"2020-01-02T16:11:45.000Z"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
Code	string	Output field: Code
Message	string	Response message

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Code":"InputMacFormatError","Message":"dolore incididunt ullamco dolor quis"}}

Update Custom Fields by IP

Updates custom fields for a device by IP within the Pixis SiteName context, requiring 'SiteName', 'IP', and 'Custom_Column'.

Endpoint

URL: /apiV2/IpInfo/{{SiteName}}/{{IP}}/Custom_Column

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.SiteName	string	Required	Parameters for the Update Custom Fields by IP action
path_parameters.IP	string	Required	Parameters for the Update Custom Fields by IP action
headers	object	Required	HTTP headers for the request
headers.Content-Type	string	Required	HTTP headers for the request
headers.Accept	string	Required	HTTP headers for the request
Custom_Column	object	Optional	Parameter for Update Custom Fields by IP
Custom_Column.in668	string	Required	Parameter for Update Custom Fields by IP
Custom_Column.eiusmod53d	string	Required	Parameter for Update Custom Fields by IP

Input Example

{"json_body":{"Custom_Column":{"in668":"quis ut commodo consectetur","eiusmod53d":"nulla ea"}},"path_parameters":{"SiteName":"test_site","IP":"test_ip"},"headers":{"Content-Type":"application/json","Accept":"text/plain"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
Code	string	Output field: Code
Message	string	Response message

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Code":"InputMacFormatError","Message":"dolore incididunt ullamco dolor quis"}}

Update Custom Fields by MAC

Updates custom fields for a device by MAC address in a specified site on Pixis, requiring SiteName, MAC, and Custom_Column details.

Endpoint

URL: /apiV2/MacInfo/{{SiteName}}/{{MAC}}/Custom_Column

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.SiteName	string	Required	Parameters for the Update Custom Fields by MAC action
path_parameters.MAC	string	Required	Parameters for the Update Custom Fields by MAC action
headers	object	Required	HTTP headers for the request
headers.Content-Type	string	Required	HTTP headers for the request
headers.Accept	string	Required	HTTP headers for the request
Custom_Column	object	Optional	Parameter for Update Custom Fields by MAC
Custom_Column.in668	string	Required	Parameter for Update Custom Fields by MAC
Custom_Column.eiusmod53d	string	Required	Parameter for Update Custom Fields by MAC

Input Example

{"json_body":{"Custom_Column":{"in668":"quis ut commodo consectetur","eiusmod53d":"nulla ea"}},"path_parameters":{"SiteName":"test_site","MAC":"test_mac"},"headers":{"Content-Type":"application/json","Accept":"text/plain"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
Code	string	Output field: Code
Message	string	Response message

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Code":"InputMacFormatError","Message":"dolore incididunt ullamco dolor quis"}}

Response Headers

Header	Description	Example
Content-Type	The media type of the resource	application/json
Date	The date and time at which the message was originated	Thu, 01 Jan 2024 00:00:00 GMT