- Documentation
- Sandbox
Enable or disable auto accept
| Name | Requirement | Type | Description |
|---|---|---|---|
| bootstrap_key | string | Bootstrap key ID |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| auto_accept | boolean | true | Auto accept value: true ot false |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Delete CVE item. Only allowed if affected host count for this CVE = 0
| Name | Requirement | Type | Description |
|---|---|---|---|
| cve_id | string | CVE Id |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| message | string | false | Commit message |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get CVE item info by Id
| Name | Requirement | Type | Description |
|---|---|---|---|
| cve_id | string | CVE Id |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Patch CVE - set as disabled/enabled
| Name | Requirement | Type | Description |
|---|---|---|---|
| cve_id | string | CVE ID |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| disabled | boolean | true | Disabled value: true ot false | |
| message | string | false | Commit message |
| Status Code | Description |
|---|---|
| 204 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get hosts with max count of CVE - we include all CVE type. If device_id is set - return count of CVE for that host
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| device_id | string | false | Device id | |
| limit | integer | false | Maximum number of records, default 5, max 100 |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get list of CVE items detected in the system
Supported search fields:
Supported sort fields:
| Name | Requirement | Type | Description |
|---|---|---|---|
| search | json | Search conditions. Supported fields: ^see description on top | |
| sort_field | string | Field to sort, cve_id by default | |
| sort_direction | string | Sort direction, asc by default | |
| items_per_page | integer | Maximum number of records in result, default 30, max 1000 | |
| offset | integer | Offset |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get list of affected devices by the change. Usual use case - when we change group rule - we need to know all devices which would receive this setting.
| Name | Requirement | Type | Description |
|---|---|---|---|
| device_id | string | device id (usually this is group id | |
| config | json | Config change as json | |
| formtype | string | form which we change |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Add new change to the configuration
| Name | Requirement | Type | Description |
|---|---|---|---|
| device_id | string | Device or group id | |
| config | json | Config change as json | |
| formtype | string | form which we change |
| Status Code | Description |
|---|---|
| 204 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get change
| Name | Requirement | Type | Description |
|---|---|---|---|
| change_id | string | change id |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get list of changes
| Name | Requirement | Type | Description |
|---|---|---|---|
| search | json | Search conditions. Supported fields: user_id, group_id, status, form_type | |
| created_start | date | Start date UTC, format: YYYY-MM-DD hh:ii:ss. Default -1 month from now | |
| created_end | date | End date UTC, format: YYYY-MM-DD hh:ii:ss. Default: now | |
| sort | string | Field to sort, created by default | |
| sort_direction | string | Sort direction, desc by default | |
| limit | integer | Maximum number of records, default 3000, max 10 000 | |
| offset | integer | Offset |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Add new change to the configuration
| Name | Requirement | Type | Description |
|---|---|---|---|
| action | string | Action to execute. Only commit is supported for now) |
| Status Code | Description |
|---|---|
| 200 |
|
| 204 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get commit
| Name | Requirement | Type | Description |
|---|---|---|---|
| commit_id | string | Commit ID |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get list of commits
Supported search fields:
commit_id - id of the commit (exact match)
message - commit message (substring), also search for CVE_ID (exact match)
user_id - id of the user who created commit (exact match)
committer - name or surname of the user (substring match)
changes - array of changes (exact match)
tags_include - array of tags which MUST be preset (exact match)
tags_exclude - array of tags which MUST NOT be preset (exact match)
start_date - Start date UTC, format: YYYY-MM-DD hh:ii:ss
Supported sort fields:
user_id
created
| Name | Requirement | Type | Description |
|---|---|---|---|
| search | json | Search conditions. Supported fields: ^see full list on top. Example: {"message": "update xyz"} | |
| sort_field | string | Field to sort, created by default | |
| sort_direction | string | Sort direction, desc by default | |
| items_per_page | integer | Maximum number of records in result, default 30, max 1000 | |
| offset | integer | Offset | |
| report_type | string | Detailed or short result. Default: short. Detailed includes config_history |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Create company
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| pcompany_id | string | true | Parent company ID | |
| name | string | true | Name of company | |
| extref | string | false | External reference | |
| billing_period | integer | false | Billing period. 1 - Monthly, 3 - Quarterly, 12 - Yearly |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Delete company
| Name | Requirement | Type | Description |
|---|---|---|---|
| company_id | string | Company ID |
| Status Code | Description |
|---|---|
| 204 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get company information
| Name | Requirement | Type | Description |
|---|---|---|---|
| company_id | string | Company ID |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Update company
| Name | Requirement | Type | Description |
|---|---|---|---|
| company_id | string | Company ID |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| name | string | false | Name of company |
| Status Code | Description |
|---|---|
| 204 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Update company
| Name | Requirement | Type | Description |
|---|---|---|---|
| company_id | string | Company ID |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| name | string | true | Name of company |
| Status Code | Description |
|---|---|
| 204 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get config for the node
| Name | Requirement | Type | Description |
|---|---|---|---|
| device_id | string | Node id |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get config preview for the device
| Name | Requirement | Type | Description |
|---|---|---|---|
| device_id | string | Device or group id |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get device attribute information information
| Name | Requirement | Type | Description |
|---|---|---|---|
| device_id | string | device pub key |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Update device custom info
| Name | Requirement | Type | Description |
|---|---|---|---|
| device_id | string | Device ID |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| device_name | string | false | Device name | |
| description | string | false | Description | |
| country | string | false | Country | |
| city | string | false | City | |
| zip | string | false | Zip code | |
| address | string | false | Address | |
| latitude | float | false | Latitude | |
| longitude | float | false | Longitude |
| Status Code | Description |
|---|---|
| 204 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 500 |
|
Delete directory or file specified by path if item is a directory - we check if it is empty. You can not delete Non-empty directories
| Name | Requirement | Type | Description |
|---|---|---|---|
| path | string | Full path to directory or file |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Download a file specified by full path
| Name | Requirement | Type | Description |
|---|---|---|---|
| path | string | File path |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Rename file
| Name | Requirement | Type | Description |
|---|---|---|---|
| name | string | Name | |
| path | string | Original path |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Upload a file. Expected content type - multipart/form-data path variable is also required. Path MUST contain leading and ending slashes, for example, if file is uploaded to the bbb folder => /aa/bb/
| Name | Requirement | Type | Description |
|---|---|---|---|
| file | binary file | File |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Create directory
| Name | Requirement | Type | Description |
|---|---|---|---|
| name | string | Directory name | |
| path | string | Directory path |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get list of uploaded files
Supported search fields:
Supported sort fields:
Note:
| Name | Requirement | Type | Description |
|---|---|---|---|
| path | string | Directory to show or search. If empty - root will be used. If search is not empty and path is empty - we search in all folders | |
| search | json | Search conditions. Supported fields: ^see description on top | |
| sort_field | string | Field to sort, name by default | |
| sort_direction | string | Sort direction, asc by default | |
| items_per_page | integer | Maximum number of records in result, default 50, max 1000 | |
| offset | integer | Offset |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get group reports summary
| Name | Requirement | Type | Description |
|---|---|---|---|
| group_id | string | Group id |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get group tree
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| skip_unassigned | boolean | false | skip or not unassigned hosts in the tree output |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Update group
| Name | Requirement | Type | Description |
|---|---|---|---|
| tree | json | Tree json structure |
| Status Code | Description |
|---|---|
| 204 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get group devices
| Name | Requirement | Type | Description |
|---|---|---|---|
| group_id | string | Group id |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Delete device
| Name | Requirement | Type | Description |
|---|---|---|---|
| device_id | string | Device id |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| message | string | false | Commit message |
| Status Code | Description |
|---|---|
| 204 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 500 |
|
Get device inventory information
| Name | Requirement | Type | Description |
|---|---|---|---|
| device_id | string | device id |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get list of devices
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| report_type | string | false | short ir detailed report. allowed: short, detailed. Default: detailed | |
| limit | integer | false | Maximum number of records. Default 1000. Maximum: 10 000 | |
| offset | integer | false | Offset |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 500 |
|
Get device inventory report
| Name | Requirement | Type | Description |
|---|---|---|---|
| device_id | string | device id |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get summary report by inventory property type. It will return combined info for each host by the property ( for example: ports or users. * NOTE: This method will be changed soon
| Name | Requirement | Type | Description |
|---|---|---|---|
| device_id | string | device id | |
| type | string | Type name. Ports and users are supported by now |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 500 |
|
Get last measurements for the cpu/mem/filesystem for all devices
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 500 |
|
Get metrics by type (cpu/mem/filesystem/load average) for the device or group
Supported search fields:
Supported type fields:
NOTE: We output metrics results per device. This mean that classical offset and items_per_device works differently
| Name | Requirement | Type | Description |
|---|---|---|---|
| device_id | string | Device or group ID | |
| type | string | Measurement type, supported: cpu_user, cpu_system ... ^see description on top |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| search | json | false | Search conditions. Supported fields: ^see description on top | |
| group_by_time | integer | false | Group by time interval. ALL points for the start/end interval would be grouped into the time buckets. Supported minutes and hours. Format: Xm (20m), Xh (4h) | |
| items_per_device | integer | false | Maximum number of records in single device result, default 1000, max 10000. | |
| offset | integer | false | Offset in single device result. Default 0 |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 422 |
|
| 500 |
|
Get top load for cpu/mem/filesystem for the device or group by period
Supported search fields:
end_date - End date UTC, format: YYYY-MM-DD hh:ii:ss (2019-03-18 10:35:48). Default now
NOTE: if only one device_id provided in array, we check if it is a group id, and in this case - we search withing a group.
| Name | Requirement | Type | Description |
|---|---|---|---|
| device_id | string | Device or group ID |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| search | json | false | Search conditions. Supported fields: ^see description on top | |
| limit | integer | false | Limit result number. Default: 5. Max allowed 1000 |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 422 |
|
| 500 |
|
Get top load for cpu/mem/filesystem for the devices inside the group.
Supported search fields:
end_date - End date UTC, format: YYYY-MM-DD hh:ii:ss (2019-03-18 10:35:48). Default now
NOTE: if only one device_id provided in array, we check if it is a group id, and in this case - we search withing a group.
| Name | Requirement | Type | Description |
|---|---|---|---|
| group_id | string | group ID | |
| device_id |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| search | json | false | Search conditions. Supported fields: ^see description on top | |
| limit | integer | false | Limit how many top devices would be selected. Default: 5. Max allowed 1000 | |
| group_by_time | integer | false | Group by time interval. ALL points for the start/end interval would be grouped into the time buckets. Supported minutes and hours. Format: Xm (20m), Xh (4h) | |
| items_per_device | integer | false | Maximum number of records in single device result, default 1000, max 10000. | |
| offset | integer | false | Offset in single device result. Default 0 |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 422 |
|
| 500 |
|
Get pending hosts
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| pendingonly | boolean | false | If true - show only pending | |
| limit | integer | false | Maximum number of records. Default: 1000. Maximum 10 000 | |
| offset | integer | false | Offset |
| Status Code | Description |
|---|---|
| 204 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 500 |
|
Approve host
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| device_id | string | true | device pub key |
| Status Code | Description |
|---|---|
| 204 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 500 |
|
Reject host
| Name | Requirement | Type | Description |
|---|---|---|---|
| device_id |
| Status Code | Description |
|---|---|
| 204 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 500 |
|
Manual remove approved host from bootstrap. Warning: This is only for the advanced users
| Name | Requirement | Type | Description |
|---|---|---|---|
| device_id |
| Status Code | Description |
|---|---|
| 204 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 500 |
|
Get pending hosts
| Name | Requirement | Type | Description |
|---|---|---|---|
| ip_address |
| Status Code | Description |
|---|---|
| 204 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 500 |
|
Get reports
Supported search fields:
Supported sort fields:
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| search | json | false | Search conditions. Supported fields: ^see description on top | |
| sort_field | string | false | Field to sort, ts by default | |
| sort_direction | string | false | Sort direction, desc by default | |
| items_per_page | integer | false | Maximum number of records in result, default 30, max 1000 | |
| offset | integer | false | Offset, default 0 |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 500 |
|
Mark report(s) as read
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| reports_array | json | true | Array of report id to mark as read. Example: ["588c7c64abf866624fb248eb"] |
| Status Code | Description |
|---|---|
| 204 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 500 |
|
Get reports summary (hom many info, warn, err, crit reports per period) per device or group. Limit - 1 year
| Name | Requirement | Type | Description |
|---|---|---|---|
| device_id | string | Device or group ID |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| start | date | false | Start date UTC, format: YYYY-MM-DD hh:ii:ss. Default -24h from now | |
| end | date | false | End date UTC, format: YYYY-MM-DD hh:ii:ss. Default: now |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 500 |
|
Create user Note: - Company will be set equal to the user who sends request - After creating a user, email can only be changed by super admin.
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| fname | string | true | First name | |
| lname | string | true | Last name | |
| string | true | |||
| password | string | true | Password | |
| enabled | boolean | false | Set if user is enabled (defult false) | |
| roles | json | false | Array of user roles. Supported: ROLE_ADMIN. Default: empty. Example input: [ "ROLE_ADMIN"] |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Send email with the reset token when forgot password form is submitted. It will return status 200 even if user is not exists in DB.
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| string | true | User email |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 500 |
|
Register new user
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| fname | string | true | First name | |
| lname | string | true | Last name | |
| string | true | |||
| password | string | true | Password | |
| conf_password | string | true | Confirm password | |
| company | string | true | Company name |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 500 |
|
Reset password for the user if token and passwords are valid
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| token | string | true | Token from the reset email | |
| password | string | true | New password | |
| conf_password | string | true | Confirmation password |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 500 |
|
Delete user
| Name | Requirement | Type | Description |
|---|---|---|---|
| user_id | string | User ID |
| Status Code | Description |
|---|---|
| 204 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get user information
| Name | Requirement | Type | Description |
|---|---|---|---|
| user_id | string | User ID |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Patch user
Note: email is not allowed to change in path
| Name | Requirement | Type | Description |
|---|---|---|---|
| user_id | string | User ID |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| fname | string | false | First name | |
| lname | string | false | Last name | |
| string | false | |||
| password | string | false | Password | |
| enabled | boolean | false | Set if user is enabled (defult false) | |
| roles | json | false | Array of user roles |
| Status Code | Description |
|---|---|
| 204 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Update user * Note: email is not allowed to change in put
| Name | Requirement | Type | Description |
|---|---|---|---|
| user_id | string | User ID |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| fname | string | true | First name | |
| lname | string | true | Last name | |
| string | true | |||
| password | string | true | Password | |
| enabled | boolean | false | Set if user is enabled (defult false) | |
| roles | json | false | Array of user roles |
| Status Code | Description |
|---|---|
| 204 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get list of users
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| search | string | false | Search by first name or last name or email | |
| sort_field | string | false | Field to sort, fname by default | |
| sort_direction | string | false | Sort direction, asc by default | |
| items_per_page | integer | false | Maximum number of records in result, default 30, max 1000 | |
| offset | integer | false | Offset |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 500 |
|
Documentation auto-generated on Mon, 18 Nov 19 17:33:49 +0000