Axonius

this connector integrates axonius api with swimlane turbine prerequisites the axonius connector requires an url , api key , and an api secret to interact with the api capabilities this connector provides the following capabilities get devices get vulnerabilities notes https //support axonius com/hc/en us/community/posts/4814600124951 getting started with the rest api configurations api key authentication authenticates using an api key configuration parameters parameter description type required url a url to the target host string required api key api key string required api secret api secret string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions get devices fetches the devices according to the defined query endpoint url /api/devices method get input argument name type required description parameters include notes boolean optional parameters for the get devices action parameters should split complex objects boolean optional parameters for the get devices action parameters source component string optional parameters for the get devices action parameters filter out non existing fields boolean optional parameters for the get devices action parameters should split by adapter boolean optional parameters for the get devices action parameters get metadata boolean optional whether to add metadata for the resource (the pagination offset) parameters asset excluded adapters string optional parameters for the get devices action parameters include selected entities boolean optional parameters for the get devices action parameters asset filters string optional parameters for the get devices action parameters cursor id string optional parameters for the get devices action parameters include parent entities boolean optional parameters for the get devices action parameters page object optional parameters for the get devices action parameters page limit number optional parameters for the get devices action parameters page offset number optional parameters for the get devices action parameters should exclude complex fields boolean optional parameters for the get devices action parameters max field items number optional parameters for the get devices action parameters wait for data boolean optional parameters for the get devices action parameters field to split by string optional parameters for the get devices action parameters history string optional historical date iso formatted parameters search string optional a textual value to search parameters parent entity fields array optional parameters for the get devices action parameters filter string optional aql string, representing data filter parameters excluded adapters string optional parameters for the get devices action parameters frontend sent time string optional parameters for the get devices action parameters is refresh boolean optional parameters for the get devices action input example {"parameters" {"include notes"\ false,"should split complex objects"\ true,"source component" "null","filter out non existing fields"\ true,"should split by adapter"\ false,"get metadata"\ true,"asset excluded adapters" "asset excluded adapters","include selected entities"\ true,"asset filters" "asset filters","cursor id" "null","include parent entities"\ false,"page" {"limit" 140,"offset" 0},"should exclude complex fields"\ false,"max field items" 0,"wait for data"\ false,"field to split by" "null","history" "2021 04 06t08 22 37z","search" "search","parent entity fields" \["null"],"filter" "null","excluded adapters" "excluded adapters","frontend sent time" "2021 05 06t08 22 37z","is refresh"\ false,"file name" "data","include details"\ false,"use heavy fields collection"\ true,"jit device count calc filter" "jit device count calc filter","query id" "null","delimiter" "delimiter","sort" \[1, 1],"expressions" "expressions","saved query id" "null","max rows" 1,"use cache entry"\ true,"null for non exist"\ false,"use cursor"\ false,"id" "id","return plain data"\ false,"download id" "null","complex fields preview limit" 1,"always cached query"\ false,"fields" {"additionalprop1" \["string"],"additionalprop2" \["string"],"additionalprop3" \["string"]},"selected entities" \["list"],"field filters" "field filters"}} output parameter type description status code number http status code of the response reason string response reason phrase data array response data data attributes object response data data attributes document meta string response data data attributes adapter details array response data data attributes adapter list length number response data data attributes adapter list length details array response data data attributes adapters array response data data attributes adapters data array response data data attributes adapters data details array response data data attributes id string response data data attributes internal axon id string response data data attributes internal axon id details array response data data attributes labels array response data data attributes unique adapter names array response data data attributes unique adapter names details array response data data id string response data data type string response data meta object output field meta output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "tue, 19 dec 2023 20 37 23 gmt"},"reason" "ok","json body" {"data" \[{}],"meta" {}}} get vulnerabilities fetches the vulnerabilities according to the defined query endpoint url /api/vulnerabilities method get input argument name type required description parameters include notes boolean optional parameters for the get vulnerabilities action parameters should split complex objects boolean optional parameters for the get vulnerabilities action parameters source component string optional parameters for the get vulnerabilities action parameters filter out non existing fields boolean optional parameters for the get vulnerabilities action parameters should split by adapter boolean optional parameters for the get vulnerabilities action parameters get metadata boolean optional whether to add metadata for the resource (the pagination offset) parameters asset excluded adapters string optional parameters for the get vulnerabilities action parameters include selected entities boolean optional parameters for the get vulnerabilities action parameters asset filters string optional parameters for the get vulnerabilities action parameters cursor id string optional parameters for the get vulnerabilities action parameters include parent entities boolean optional parameters for the get vulnerabilities action parameters page object optional parameters for the get vulnerabilities action parameters page limit number optional parameters for the get vulnerabilities action parameters page offset number optional parameters for the get vulnerabilities action parameters should exclude complex fields boolean optional parameters for the get vulnerabilities action parameters max field items number optional parameters for the get vulnerabilities action parameters wait for data boolean optional parameters for the get vulnerabilities action parameters field to split by string optional parameters for the get vulnerabilities action parameters history string optional historical date iso formatted parameters search string optional a textual value to search parameters parent entity fields array optional parameters for the get vulnerabilities action parameters filter string optional aql string, representing data filter parameters excluded adapters string optional parameters for the get vulnerabilities action parameters frontend sent time string optional parameters for the get vulnerabilities action parameters is refresh boolean optional parameters for the get vulnerabilities action input example {"parameters" {"include notes"\ false,"should split complex objects"\ true,"source component" "null","filter out non existing fields"\ true,"should split by adapter"\ false,"get metadata"\ true,"asset excluded adapters" "asset excluded adapters","include selected entities"\ true,"asset filters" "asset filters","cursor id" "null","include parent entities"\ false,"page" {"limit" 140,"offset" 0},"should exclude complex fields"\ false,"max field items" 0,"wait for data"\ false,"field to split by" "null","history" "2021 04 06t08 22 37z","search" "search","parent entity fields" \["null"],"filter" "null","excluded adapters" "excluded adapters","frontend sent time" "2021 05 06t08 22 37z","is refresh"\ false,"file name" "data","include details"\ false,"use heavy fields collection"\ true,"jit device count calc filter" "jit device count calc filter","query id" "null","delimiter" "delimiter","sort" \[1, 1],"expressions" "expressions","saved query id" "null","max rows" 1,"use cache entry"\ true,"null for non exist"\ false,"use cursor"\ false,"id" "id","return plain data"\ false,"download id" "null","complex fields preview limit" 1,"always cached query"\ false,"fields" {"additionalprop1" \["string"],"additionalprop2" \["string"],"additionalprop3" \["string"]},"selected entities" \["list"],"field filters" "field filters"}} output parameter type description status code number http status code of the response reason string response reason phrase data array response data data attributes object response data data attributes document meta string response data data attributes adapter details array response data data attributes adapter list length number response data data attributes adapter list length details array response data data attributes adapters array response data data attributes adapters data array response data data attributes adapters data details array response data data attributes id string response data data attributes internal axon id string response data data attributes internal axon id details array response data data attributes labels array response data data attributes unique adapter names array response data data attributes unique adapter names details array response data data id string response data data type string response data meta object output field meta output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "fri, 22 dec 2023 20 37 23 gmt"},"reason" "ok","json body" {"data" \[{}],"meta" {}}} 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 fri, 22 dec 2023 20 37 23 gmt