Pixis
50 min
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