Armis
App Vendor: Armis
App Category: Endpoint Security
Connector Version: 1.0.0
API Version: 1.0.0
About App
Armis is an enterprise-class security platform for unmanaged and IoT devices.
Armis app is configured with Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Fetch Applications for Device | The action retrieves a list of applications for a device. |
Get Device Details | This action retrieves the details of a device. |
Search Applications | This action retrieves a list of applications in the Armis environment. |
Search Devices | This action retrieves a list of devices in the Armis environment. |
Configuration Parameters
The following configuration parameters are required for the Armis app to communicate with the Armis enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter a base domain or URL to connect to the Armis application. Example: "armis-api.<organization_name>.org" | Text | Required | |
API Key | Enter the API key to authenticate with the Armis application. | Password | Required | |
SSL Verification | Choose to perform certificate verification for SSL connections. Example: true | Boolean | Optional | Default value: true Allowed values:
|
Action: Fetch Applications for Device
The action retrieves a list of applications for a device.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device ID | Enter a device ID provided by Armis. Example: "165722" | Text | Required | |
Length | Enter the maximum number of results to return. Example: 50 | Integer | Optional | Default value: 100 |
Offset | Enter a value of offset for pagination. Example: 0 | Integer | Optional | Default value: 0 |
Example Request
[
{
"device_id": "165722",
"length": 50,
"offset":0
}
]Action: Get Device Details
This action retrieves the details of a device.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device ID | Enter a device ID provided by Armis. Example: "165722" | Text | Required | |
Length | Enter the maximum number of results to return. Example: 50 | Integer | Optional | Default value: 100 |
Offset | Enter a value of offset for pagination. Example: 0 | Integer | Optional | Default value: 0 |
Example Request
[
{
"device_id": "165722",
"length": 50,
"offset":0
}
]Action: Search Applications
This action retrieves a list of applications in the Armis environment.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Query | Enter an AQL query to retrieve a list of applications. Example: "Fzahrdvrd0x" | Text | Optional | |
Length | Enter the maximum number of results to return. Example: 50 | Integer | Optional | Default value: 100 |
Offset | Enter an offset value for pagination. Example: 0 | Integer | Optional | Default value: 0 |
Fields | Enter the list of fields that you need to retrieve. | Replace | Optional | |
Timeframe Start | Enter a start timeframe from which you need to retrieve results. Example: "2021-03-09T01:28:44.032944+00:00", | Text | Optional | |
Timeframe End | Enter an end timeframe until which you need to retrieve results. Example: "2021-05-09T01:28:44.032944+00:00", | Text | Optional |
Example Request
[
{
"query": "Fzahrdvrd0x",
"length": 50,
"offset":0,
"timeframe_start": "2021-03-09T01:28:44.032944+00:00",
"timeframe_end": "2022-05-09T01:28:44.032944+00:00"
}
]Action: Search Devices
This action retrieves a list of applications in the Armis environment.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Query | Enter an AQL query to retrieve a list of applications. Example: "Fzahrdvrd0x" | Text | Optional | |
Length | Enter the maximum number of results to return. Example: 50 | Integer | Optional | Default value:100 |
Offset | Enter an offset value for pagination. Example: 0 | Integer | Optional | Default value:0 |
Fields | Enter the list of fields that you need to retrieve. | Replace | Optional | |
Timeframe Start | Enter a start timeframe from which you need to retrieve results. Example: "2021-03-09T01:28:44.032944+00:00" | Text | Optional | |
Timeframe End | Enter an end timeframe until which you need to retrieve results. Example: "2021-05-09T01:28:44.032944+00:00" | Text | Optional |
Example Request
[
{
"query": "Fzahrdvrd0x",
"length": 50,
"offset":0,
"timeframe_start": "2021-03-09T01:28:44.032944+00:00",
"timeframe_end": "2022-05-09T01:28:44.032944+00:00"
}
]