Axis Atmos

this connector integrates axis atmos's rest api with swimlane turbine prerequisites the asset requires an url and a token to interact with the axis atmos rest api capabilities this connector provides the following capabilities create new application delete application get web categories get existing application details list web categories list existing applications update web categories update existing application notes to access api documentation for the connector https //docs axissecurity com/docs/atmos cloud api web categories configurations axis atmos http bearer authentication authenticates using bearer token such as a jwt, etc configuration parameters parameter description type required url a url to the target host string required token the api key, token, etc string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions create new application the management api allows administrators to create a new application endpoint url /api/v1/applications method post input argument name type required description name string optional name of the resource type string optional type of the resource enabled boolean optional parameter for create new application networkrangeapplicationdata object optional response data networkrangeapplicationdata iprangesorcidrs array optional response data networkrangeapplicationdata dnssearches array optional response data networkrangeapplicationdata excludeddnssearches array optional response data networkrangeapplicationdata enableicmp boolean optional response data networkrangeapplicationdata portsandprotocols array required response data networkrangeapplicationdata serverinitiatedports array optional response data networkrangeapplicationdata enforceresolveddnstoip boolean optional response data tags array optional parameter for create new application tags id string optional unique identifier connectorzoneid string optional unique identifier input example {"name" "example name","type" "string","enabled"\ true,"networkrangeapplicationdata" {"iprangesorcidrs" \["string"],"dnssearches" \["string"],"excludeddnssearches" \["string"],"enableicmp"\ true,"portsandprotocols" \["string"],"serverinitiatedports" \["string"],"enforceresolveddnstoip"\ true},"tags" \[{"id" "12345678 1234 1234 1234 123456789abc"}],"connectorzoneid" "string"} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier name string name of the resource type string type of the resource enabled boolean output field enabled networkrangeapplicationdata object response data networkrangeapplicationdata iprangesorcidrs array response data networkrangeapplicationdata dnssearches array response data networkrangeapplicationdata excludeddnssearches array response data networkrangeapplicationdata enableicmp boolean response data networkrangeapplicationdata portsandprotocols array response data networkrangeapplicationdata serverinitiatedports array response data networkrangeapplicationdata serverinitiatedports file name string response data networkrangeapplicationdata serverinitiatedports file string response data networkrangeapplicationdata enforceresolveddnstoip boolean response data tags array output field tags tags id string unique identifier tags name string name of the resource connectorzoneid string unique identifier output example {"id" "string","name" "network range 1","type" "networkrange","enabled"\ true,"networkrangeapplicationdata" {"iprangesorcidrs" \["10 0 0 0/24","10 0 0 1/24","10 0 0 2"],"dnssearches" \[" acme1 com"," acme2 com"],"excludeddnssearches" \["admin acme com"],"enableicmp"\ true,"portsandprotocols" \["1 10","11 20\ tcp","21 30\ udp"],"serverinitiatedports" \[],"enforceresolveddnstoip"\ false},"tags" \[{"id" "string","name" "string"}],"connectorzoneid" "string"} delete application delete an existing application using id endpoint url /api/v1/applications/{{id}} method delete input argument name type required description path parameters id string required parameters for the delete application action input example {"path parameters" {"id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 204,"response headers" {},"reason" "ok","json body" {}} get category details to get an existing web category, the web category's id should be added to the request url endpoint url /api/v1/webcategories/{{web category id}} method get input argument name type required description path parameters web category id string required parameters for the get category details action input example {"path parameters" {"web category id" "101abc"}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier name string name of the resource description string output field description includeddomainsorurls array url endpoint for the request includeddomainsorurls file name string url endpoint for the request includeddomainsorurls file string url endpoint for the request excludeddomainsorurls array url endpoint for the request excludeddomainsorurls file name string url endpoint for the request excludeddomainsorurls file string url endpoint for the request connectorzoneid string unique identifier type string type of the resource output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "thur, 1 feb 2024 15 37 23 gmt"},"reason" "ok","json body" {"id" "string","name" "unconfirmed spam sources","description" "possible sources of spam ","includeddomainsorurls" \[],"excludeddomainsorurls" \[],"connectorzoneid" "string","type" "predefined"}} get existing application details to get the details of an existing tag, the application id should be added to the request url endpoint url /api/v1/applications/{{id}} method get input argument name type required description path parameters id string required parameters for the get existing application details action input example {"path parameters" {"id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier name string name of the resource type string type of the resource enabled boolean output field enabled networkrangeapplicationdata object response data networkrangeapplicationdata iprangesorcidrs array response data networkrangeapplicationdata dnssearches array response data networkrangeapplicationdata excludeddnssearches array response data networkrangeapplicationdata enableicmp boolean response data networkrangeapplicationdata portsandprotocols array response data networkrangeapplicationdata serverinitiatedports array response data networkrangeapplicationdata serverinitiatedports file name string response data networkrangeapplicationdata serverinitiatedports file string response data networkrangeapplicationdata enforceresolveddnstoip boolean response data tags array output field tags tags id string unique identifier tags name string name of the resource connectorzoneid string unique identifier output example {"id" "string","name" "network range 1","type" "networkrange","enabled"\ true,"networkrangeapplicationdata" {"iprangesorcidrs" \["10 0 0 0/24","10 0 0 1/24","10 0 0 2"],"dnssearches" \[" acme1 com"," acme2 com"],"excludeddnssearches" \["admin acme com"],"enableicmp"\ true,"portsandprotocols" \["1 10","11 20\ tcp","21 30\ udp"],"serverinitiatedports" \[],"enforceresolveddnstoip"\ false},"tags" \[{"id" "string","name" "string"}],"connectorzoneid" "string"} list categories get a list of existing web categories endpoint url /api/v1/webcategories method get input argument name type required description parameters pagesize number optional specify the maximum number of tags to retrieve parameters pagenumber number optional page number 1 will retrieve the first tags input example {"parameters" {"pagesize" 100,"pagenumber" 1}} output parameter type description status code number http status code of the response reason string response reason phrase pagenumber number output field pagenumber pagesize number output field pagesize firstpage string output field firstpage lastpage string output field lastpage totalpages number output field totalpages totalrecords number output field totalrecords nextpage string output field nextpage previouspage string output field previouspage data array response data data id string response data data name string response data data description string response data data includeddomainsorurls array response data data includeddomainsorurls file name string response data data includeddomainsorurls file string response data data excludeddomainsorurls array response data data excludeddomainsorurls file name string response data data excludeddomainsorurls file string response data data connectorzoneid string response data data type string response data output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "thur, 1 feb 2024 15 37 23 gmt"},"reason" "ok","json body" {"pagenumber" 1,"pagesize" 100,"firstpage" "\<url to retrieve first page>","lastpage" "\<url to retrieve last page>","totalpages" 1,"totalrecords" 50,"nextpage" "\<url to retrieve next page>","previouspage" "\<url to retrieve previous page>","data" \[{}]}} list existing applications list existing applications endpoint url /api/v1/applications method get input argument name type required description parameters pagesize number optional parameters for the list existing applications action parameters pagenumber number optional parameters for the list existing applications action input example {"parameters" {"pagesize" 100,"pagenumber" 1}} output parameter type description status code number http status code of the response reason string response reason phrase pagenumber number output field pagenumber pagesize number output field pagesize firstpage string output field firstpage lastpage string output field lastpage totalpages number output field totalpages totalrecords number output field totalrecords nextpage string output field nextpage previouspage string output field previouspage data array response data data id string response data data name string response data data type string response data data enabled boolean response data data networkrangeapplicationdata object response data data networkrangeapplicationdata iprangesorcidrs array response data data networkrangeapplicationdata dnssearches array response data data networkrangeapplicationdata excludeddnssearches array response data data networkrangeapplicationdata enableicmp boolean response data data networkrangeapplicationdata portsandprotocols array response data data networkrangeapplicationdata serverinitiatedports array response data data networkrangeapplicationdata serverinitiatedports file name string response data data networkrangeapplicationdata serverinitiatedports file string response data data networkrangeapplicationdata enforceresolveddnstoip boolean response data output example {"pagenumber" 123,"pagesize" 123,"firstpage" "string","lastpage" "string","totalpages" 123,"totalrecords" 123,"nextpage" "string","previouspage" "string","data" \[{"id" "12345678 1234 1234 1234 123456789abc","name" "example name","type" "string","enabled"\ true,"networkrangeapplicationdata" {},"tags" \[],"connectorzoneid" "string"}]} update category to update an existing web category, the web category's id should be added to the request url endpoint url /api/v1/webcategories/{{web category id}} method put input argument name type required description path parameters web category id string required parameters for the update category action name string optional name of the resource description string optional parameter for update category includeddomainsorurls array optional url endpoint for the request excludeddomainsorurls array optional url endpoint for the request connectorzoneid string optional unique identifier type string optional type of the resource input example {"json body" {"name" "acme resources","description" "acme resources ","includeddomainsorurls" \["acme com"," ustream tv"],"excludeddomainsorurls" \["acme com/sport/ "],"connectorzoneid" "string","type" "custom"},"path parameters" {"web category id" "101abc"}} output parameter type description status code number http status code of the response reason string response reason phrase name string name of the resource description string output field description includeddomainsorurls array url endpoint for the request excludeddomainsorurls array url endpoint for the request connectorzoneid string unique identifier type string type of the resource output example {"status code" 204,"response headers" {"content length" "140","content type" "application/json","date" "thur, 1 feb 2024 15 37 23 gmt"},"reason" "ok","json body" {"name" "acme resources","description" "acme resources ","includeddomainsorurls" \["acme com"," ustream tv"],"excludeddomainsorurls" \["acme com/sport/ "],"connectorzoneid" "string","type" "custom"}} update existing application updates an existing application endpoint url /api/v1/applications/{{id}} method put input argument name type required description path parameters id string required parameters for the update existing application action name string optional name of the resource type string optional type of the resource enabled boolean optional parameter for update existing application networkrangeapplicationdata object optional response data networkrangeapplicationdata iprangesorcidrs array optional response data networkrangeapplicationdata dnssearches array optional response data networkrangeapplicationdata excludeddnssearches array optional response data networkrangeapplicationdata enableicmp boolean optional response data networkrangeapplicationdata portsandprotocols array optional response data tags array optional parameter for update existing application tags id string optional unique identifier connectorzoneid string optional unique identifier input example {"path parameters" {"id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier name string name of the resource type string type of the resource enabled boolean output field enabled networkrangeapplicationdata object response data networkrangeapplicationdata iprangesorcidrs array response data networkrangeapplicationdata dnssearches array response data networkrangeapplicationdata excludeddnssearches array response data networkrangeapplicationdata enableicmp boolean response data networkrangeapplicationdata portsandprotocols array response data networkrangeapplicationdata serverinitiatedports array response data networkrangeapplicationdata serverinitiatedports file name string response data networkrangeapplicationdata serverinitiatedports file string response data networkrangeapplicationdata enforceresolveddnstoip boolean response data tags array output field tags tags id string unique identifier tags name string name of the resource connectorzoneid string unique identifier output example {"id" "12345678 1234 1234 1234 123456789abc","name" "example name","type" "string","enabled"\ true,"networkrangeapplicationdata" {"iprangesorcidrs" \["string"],"dnssearches" \["string"],"excludeddnssearches" \["string"],"enableicmp"\ true,"portsandprotocols" \["string"],"serverinitiatedports" \[{}],"enforceresolveddnstoip"\ true},"tags" \[{"id" "12345678 1234 1234 1234 123456789abc","name" "example name"}],"connectorzoneid" "string"} 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 thu, 01 jan 2024 00 00 00 gmt