--- title: Axis Atmos slug: connectors/axis-atmos docTags: createdAt: 2026-06-09T16:30:18.779Z --- 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 - [Check Here](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":"","lastPage":"","totalPages":1,"totalRecords":50,"nextPage":"","previousPage":"","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 |