SkyHigh Security Secure Web Gateway
34 min
the skyhigh security secure web gateway connector enables automated interactions with the skyhigh security platform, facilitating advanced threat protection and policy enforcement skyhigh security secure web gateway is a comprehensive web security solution that provides advanced threat protection, data security, and compliance capabilities this connector enables swimlane turbine users to automate web security management tasks such as adding or removing entries from lists, committing changes, and retrieving list information by integrating with skyhigh security secure web gateway, users can streamline their security operations, enforce policies, and respond to threats more efficiently within the swimlane ecosystem prerequisites to effectively utilize the skyhigh security secure web gateway connector within swimlane turbine, ensure you have the following prerequisites http basic authentication with the following parameters url the endpoint url for the skyhigh security secure web gateway api username your skyhigh security secure web gateway username password your skyhigh security secure web gateway password capabilities the skyhigh security secure web gateway connector has the following capabilities add entry list commit delete entry list get list by id get lists logging off retrieving a list entry retrieving a list of list entries configurations skyhigh security http basic authentication authenticates using username and password configuration parameters parameter description type required url a url to the target host string required username username string required password password string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions add entry to list adds a specified entry to a list in skyhigh security secure web gateway using the list id and position endpoint url /list/{{list id}}/entry/{{position}}/insert method post input argument name type required description list id string required unique identifier position number required parameter for add entry to list entry string required the entry to add description string optional the description for the entry output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" { "content length" "140", "content type" "application/json", "date" "mon, 10 jul 2023 20 37 23 gmt" }, "reason" "ok", "json body" {} } ] commit apply pending configuration changes to the skyhigh security secure web gateway endpoint url /commit method post output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" { "content length" "140", "content type" "application/json", "date" "mon, 10 jul 2023 20 37 23 gmt" }, "reason" "ok", "json body" {} } ] delete entry list removes a specified entry from a list in skyhigh security secure web gateway using the list id and position endpoint url /list/{{list id}}/entry/{{position}} method delete input argument name type required description list id string required list identifier position number required position of an entry in a list output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" { "content length" "140", "content type" "application/json", "date" "mon, 10 jul 2023 20 37 23 gmt" }, "reason" "ok", "json body" {} } ] get list by id retrieves detailed information for a specified list using its unique identifier (list id) in skyhigh security secure web gateway endpoint url /list/{{list id}} method get input argument name type required description list id string required list identifier output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" { "content length" "140", "content type" "application/json", "date" "mon, 10 jul 2023 20 37 23 gmt" }, "reason" "ok", "json body" {} } ] get lists obtain a comprehensive collection of lists from skyhigh security secure web gateway for further analysis or action endpoint url /list method get input argument name type required description type string optional list type name string optional name of a list page number optional number of a page in a feed with a list of lists pagesize number optional size of a page in a feed output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" { "content length" "140", "content type" "application/json", "date" "mon, 10 jul 2023 20 37 23 gmt" }, "reason" "ok", "json body" {} } ] retrieving a list entry retrieve a specific entry from a list in skyhigh security secure web gateway using the list id and position endpoint url /list/{{list id}}/entry/{{position}} method get input argument name type required description list id string required list identifier position number required position of an entry in a list the position is specified as i –1 for example, for the third entry, specify 2 output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" { "content length" "140", "content type" "application/json", "date" "sun, 17 may 2023 20 37 23 gmt" }, "reason" "ok", "json body" {} } ] retrieving a list of list entries retrieve all entries from a specified list in skyhigh security secure web gateway using the list id endpoint url /list/{{list id}}/entry method get input argument name type required description list id string required list identifier page number optional number of a page in a feed with list entries pagesize number optional size of a page in a feed output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" { "content length" "140", "content type" "application/json", "date" "sun, 17 may 2023 20 37 23 gmt" }, "reason" "ok", "json body" {} } ] response headers header description example content length the length of the response body in bytes 140 content type the media type of the resource application/json date the date and time at which the message was originated sun, 17 may 2023 20 37 23 gmt notes you cannot modify system lists the task will fail with an 'unparsable xml' exception if an account is logged in, you can't use it for anything until it logs out, or the timeout period expires that means multiple tasks can't be run parallel without multiple users the task will fail if you add entries that already exists on a list the task will fail if you delete an entry that doesn't exists on a list to delete an entry from the list, the position field should be specified as i−1 for example, to delete the third entry, you should specify 2 for the add entry list and delete entry list actions, changes will be automatically committed skyhigh security secure web gateway api documentation https //success skyhighsecurity com/skyhigh secure web gateway (on prem)/rest interface/working with lists