API Reference
FEEDBACKGet API Updates
  1. Armis API v3
  2. Data Export

Enable / disable export of entity.

patch
https://api.armis.com/v3/data-export/

Each time_frame_days value of an entity is exported separately, so
applications with time_frame_days=7 and applications with time_frame_days=30 are two independent exports
that are enabled, disabled and read on their own. Omitting time_frame_days addresses the entity's default window.

EntitySupported time_frame_daysDefaultNotes
applications2, 7, 14, 3030
device-delete-events2, 7, 14, 30, 9014
device-merge-events2, 7, 14, 30, 9014
ip-connections1-7-accepted when reading, to pick the aggregation date; cannot be set when enabling the export
risk-factors2, 7, 14, 3030
vulnerabilities2, 7, 14, 3030

Required scopes:

  • PERMISSION.REPORT.MANAGE.CREATE
  • PERMISSION.REPORT.MANAGE.DELETE
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required
Allowed:
Body Params
boolean
required
1 to 90

Size of the exported time window, in days.

Supported values differ per entity. Omit to use the entity's default.

EntitySupported time_frame_daysDefaultNotes
applications2, 7, 14, 3030
device-delete-events2, 7, 14, 30, 9014
device-merge-events2, 7, 14, 30, 9014
ip-connections1-7-accepted when reading, to pick the aggregation date; cannot be set when enabling the export
risk-factors2, 7, 14, 3030
vulnerabilities2, 7, 14, 3030
Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?