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 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 required name of the resource type string required type of the resource enabled boolean optional parameter for create new application networkrangeapplicationdata object required response data iprangesorcidrs array optional unique identifier dnssearches array optional parameter for create new application excludeddnssearches array optional parameter for create new application enableicmp boolean optional parameter for create new application portsandprotocols array required parameter for create new application serverinitiatedports array optional parameter for create new application enforceresolveddnstoip boolean optional parameter for create new application tags array optional parameter for create new application id string optional unique identifier connectorzoneid string required unique identifier 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 iprangesorcidrs array unique identifier dnssearches array output field dnssearches excludeddnssearches array output field excludeddnssearches enableicmp boolean output field enableicmp portsandprotocols array output field portsandprotocols serverinitiatedports array output field serverinitiatedports file name string name of the resource file string output field file enforceresolveddnstoip boolean output field enforceresolveddnstoip tags array output field tags id string unique identifier name string name of the resource connectorzoneid string unique identifier example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "id" "12345678 1234 1234 1234 123456789abc", "name" "example name", "type" "string", "enabled" true, "networkrangeapplicationdata" {}, "tags" \[], "connectorzoneid" "string" } } ] delete application delete an existing application using id endpoint url /api/v1/applications/{{id}} method delete input argument name type required description id string required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase 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 web category id string required unique identifier 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 file name string name of the resource file string output field file excludeddomainsorurls array url endpoint for the request file name string name of the resource file string output field file connectorzoneid string unique identifier type string type of the resource 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 id string required unique identifier 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 iprangesorcidrs array unique identifier dnssearches array output field dnssearches excludeddnssearches array output field excludeddnssearches enableicmp boolean output field enableicmp portsandprotocols array output field portsandprotocols serverinitiatedports array output field serverinitiatedports file name string name of the resource file string output field file enforceresolveddnstoip boolean output field enforceresolveddnstoip tags array output field tags id string unique identifier name string name of the resource connectorzoneid string unique identifier example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "id" "12345678 1234 1234 1234 123456789abc", "name" "example name", "type" "string", "enabled" true, "networkrangeapplicationdata" {}, "tags" \[], "connectorzoneid" "string" } } ] list categories get a list of existing web categories endpoint url /api/v1/webcategories method get input argument name type required description pagesize number optional specify the maximum number of tags to retrieve pagenumber number optional page number 1 will retrieve the first tags 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 id string unique identifier name string name of the resource description string output field description includeddomainsorurls array url endpoint for the request file name string name of the resource file string output field file excludeddomainsorurls array url endpoint for the request file name string name of the resource file string output field file connectorzoneid string unique identifier type string type of the resource 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 pagesize number optional parameter for list existing applications pagenumber number optional parameter for list existing applications 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 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 iprangesorcidrs array unique identifier dnssearches array output field dnssearches excludeddnssearches array output field excludeddnssearches enableicmp boolean output field enableicmp portsandprotocols array output field portsandprotocols serverinitiatedports array output field serverinitiatedports file name string name of the resource file string output field file enforceresolveddnstoip boolean output field enforceresolveddnstoip example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "pagenumber" 123, "pagesize" 123, "firstpage" "string", "lastpage" "string", "totalpages" 123, "totalrecords" 123, "nextpage" "string", "previouspage" "string", "data" \[] } } ] 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 web category id string required unique identifier 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 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 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" \[], "excludeddomainsorurls" \[], "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 id string required unique identifier 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 iprangesorcidrs array optional unique identifier dnssearches array optional parameter for update existing application excludeddnssearches array optional parameter for update existing application enableicmp boolean optional parameter for update existing application portsandprotocols array optional parameter for update existing application tags array optional parameter for update existing application id string optional unique identifier connectorzoneid string optional unique identifier 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 iprangesorcidrs array unique identifier dnssearches array output field dnssearches excludeddnssearches array output field excludeddnssearches enableicmp boolean output field enableicmp portsandprotocols array output field portsandprotocols serverinitiatedports array output field serverinitiatedports file name string name of the resource file string output field file enforceresolveddnstoip boolean output field enforceresolveddnstoip tags array output field tags id string unique identifier name string name of the resource connectorzoneid string unique identifier example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "id" "12345678 1234 1234 1234 123456789abc", "name" "example name", "type" "string", "enabled" true, "networkrangeapplicationdata" {}, "tags" \[], "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 thur, 1 feb 2024 15 37 23 gmt notes to access api documentation for the connector check here https //docs axissecurity com/docs/atmos cloud api web categories