Lastline Reporting API

The Lastline Annotation API is accessible at:

https://user.lastline.com/papi/report/<function>

The Lastline Reporting API is a web-based API for controlling the generation of reports on networks protected by Lastline Enterprise.

Reporting

Method Index

These methods control the configuration for periodically generating and sending by email reports about protected networks.

• get_report_configs():

  Get list of configurations for generating reports.

• add_reporting_config():

  Add a new configuration for generating a periodic report.

• update_report_config():

  Update an existing configutation for generating a periodic report.

• delete_report():

  Delete an existing configutation for generating a periodic report.

Method Documentation

report.report.get_report_configs(response_format)

Retrieve a list of report notification statistics

URL

/papi/report/config/list[. response_format]

response_format can be xml or json (defaults to json)

HTTP METHOD

GET

Contents of successful response

A list of mappings, containing the following fields:

• notification_id:

  Unique ID of this configuration

• timezone:

  Timezone of the report

• utc_offset:

  (Deprecated) Timezone offset from UTC (in seconds)

• enabled:

  Is the report being sent?

• report_type:

  report delivery frequency. Allowed values are:

  • day
  • day_verbose
  • week
  • month
  • quarter

• report_format:

  format of the report. Allowed values are:

  • html
  • pdf

• email:

  Report will be sent to these addresses (comma-separated list)

• account:

  email of the account whose sensors are providing data for this report

• key:

  master_key[:sensor_key] license of the sensor[s] providing data for the current report

• account_email:

  (Deprecated) email of the account whose sensors are providing data for this report

• sensor_name:

  Name of the sensor providing data for this report. A None value means all sensors under the current master_key

• master_key:

  (Deprecated) Master license key of the sensors providing data for this report

• subkey:

  (Deprecated) Key of the sensor providing data to this report. A None value means all sensors under the current master_key

report.report.add_reporting_config(response_format)

Add a new report notification statistic

URL

/papi/report/config/add[. response_format]

response_format can be xml or json (defaults to json)

HTTP METHOD

POST

POST Parameters

• key

  access_key[:subkey] of the sensor[s] responsible of providing data. No value means data is collected from all sensor under the main access_key

• sensor_key:

  (Deprecated) access_key[:subkey] of the sensor[s] responsible of providing data. No value means data is collected from all sensor under the main access_key

• timezone:

  Timezone of the report

• email:

  recipients’ emails

• report_type:

  report delivery frequency. Allowed values are:

  • day
  • day_verbose
  • week
  • month
  • quarter

• report_format:

  format of the report. Allowed values are:

  • html
  • pdf

• enabled:

  (Optional, default True) is the report going to be delivered?

Contents of successful response

{“notification_id”: notification_id} the unique identifier of the newly created report statistic

report.report.update_report_config(response_format)

Update an existing report notification statistic

URL

/papi/report/config/update[. response_format]

response_format can be xml or json (defaults to json)

HTTP METHOD

POST

POST Parameters

• notification_id

  unique ID of the report configuration to update

• sensor_key:

  (Optional) access_key[:subkey] of the sensor[s] responsible of providing data. No value means data is collected from all sensor under the main access_key

• timezone:

  (Optional) Timezone of the report

• owner:

  (Optional, additional permissions required) change the account owning this report.

• email:

  (Optional) recipient’s email

• report_type:

  (Optional) report delivery frequency. Allowed values are:

  • day
  • day_verbose
  • week
  • month
  • quarter

• report_format:

  (Optional) format of the report. Allowed values are:

  • html
  • pdf

• enabled:

  (Optional) is the report going to be delivered?

Contents of successful response

OK

report.report.delete_report(response_format)

Delete an existing report notification statistic

URL

/papi/report/config/delete[. response_format]

response_format can be xml or json (defaults to json)

HTTP METHOD

POST

POST Parameters

• notification_id

  unique ID of the report configuration to delete

Contents of successful response

OK