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 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 include notes boolean optional parameter for get devices should split complex objects boolean optional parameter for get devices source component string optional parameter for get devices filter out non existing fields boolean optional parameter for get devices should split by adapter boolean optional parameter for get devices get metadata boolean optional whether to add metadata for the resource (the pagination offset) asset excluded adapters string optional parameter for get devices include selected entities boolean optional parameter for get devices asset filters string optional parameter for get devices cursor id string optional unique identifier include parent entities boolean optional parameter for get devices page object optional parameter for get devices limit number optional parameter for get devices offset number optional parameter for get devices should exclude complex fields boolean optional parameter for get devices max field items number optional parameter for get devices wait for data boolean optional response data field to split by string optional parameter for get devices history string optional historical date iso formatted search string optional a textual value to search parent entity fields array optional parameter for get devices filter string optional aql string, representing data filter excluded adapters string optional parameter for get devices frontend sent time string optional time value is refresh boolean optional parameter for get devices output parameter type description status code number http status code of the response reason string response reason phrase data array response data attributes object output field attributes document meta string output field document meta adapter details array output field adapter details adapter list length number output field adapter list length adapter list length details array output field adapter list length details adapters array output field adapters adapters data array response data adapters data details array response data id string unique identifier internal axon id string unique identifier internal axon id details array unique identifier labels array output field labels unique adapter names array name of the resource unique adapter names details array name of the resource id string unique identifier type string type of the resource meta object output field meta 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 include notes boolean optional parameter for get vulnerabilities should split complex objects boolean optional parameter for get vulnerabilities source component string optional parameter for get vulnerabilities filter out non existing fields boolean optional parameter for get vulnerabilities should split by adapter boolean optional parameter for get vulnerabilities get metadata boolean optional whether to add metadata for the resource (the pagination offset) asset excluded adapters string optional parameter for get vulnerabilities include selected entities boolean optional parameter for get vulnerabilities asset filters string optional parameter for get vulnerabilities cursor id string optional unique identifier include parent entities boolean optional parameter for get vulnerabilities page object optional parameter for get vulnerabilities limit number optional parameter for get vulnerabilities offset number optional parameter for get vulnerabilities should exclude complex fields boolean optional parameter for get vulnerabilities max field items number optional parameter for get vulnerabilities wait for data boolean optional response data field to split by string optional parameter for get vulnerabilities history string optional historical date iso formatted search string optional a textual value to search parent entity fields array optional parameter for get vulnerabilities filter string optional aql string, representing data filter excluded adapters string optional parameter for get vulnerabilities frontend sent time string optional time value is refresh boolean optional parameter for get vulnerabilities output parameter type description status code number http status code of the response reason string response reason phrase data array response data attributes object output field attributes document meta string output field document meta adapter details array output field adapter details adapter list length number output field adapter list length adapter list length details array output field adapter list length details adapters array output field adapters adapters data array response data adapters data details array response data id string unique identifier internal axon id string unique identifier internal axon id details array unique identifier labels array output field labels unique adapter names array name of the resource unique adapter names details array name of the resource id string unique identifier type string type of the resource meta object output field meta 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 notes axonius api documentation https //support axonius com/hc/en us/community/posts/4814600124951 getting started with the rest api