Distributed Cloud AIP supports two types of Reports: Compliance and Insight.
Compliance Reports are a quick way to prove your company is in compliance with various frameworks, including SOC-2, ISO 27001, PCI, and HIPAA. You can generate ad hoc Compliance Reports, or schedule reports for a specific compliance framework to run daily or weekly. In order to generate a Compliance Report, you must attach a classifier to an existing rule.
Insight Reports provide an overview of your Distributed Cloud AIP environment's security metrics and an analysis of events that have occurred over the course of the previous month. Insight Reports are automatically generated and available on the first day of each month. Insight Reports cannot be requested for custom schedules or custom timeframes.
This method enables you to retrieve the full list of reports available for download in your organization. If your organization has more than 360 reports available, then the results will paginate.
Get the full list of reports available for download:
https://api.threatstack.com/v2/reports/generated-reports
A 400 error code can occur when the list of all generated reports could not be returned due to bad request data. Example message: Field is required but was not supplied
Success
Bad parameters
Unauthorized response
The resource was not found
Rate limit hit
An internal error has occurred
{- "id": "string",
- "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
- "orgId": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "reportType": "insight",
- "pdfStatus": "not_applicable",
- "csvStatus": "not_applicable",
- "jsonStatus": "not_applicable",
- "expiresAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "scheduleId": "string",
- "token": "string"
}
This method enables you to retrieve a single generated report using the report's ID
Get a specific generated report:
https://api.threatstack.com/v2/reports/generated-reports/{reportId}
OK
Bad parameters
Unauthorized response
The resource was not found
Rate limit hit
An internal error has occurred
{- "id": "string",
- "categoryId": "string",
- "orgId": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "reportType": "insight",
- "pdfStatus": "not_applicable",
- "csvStatus": "not_applicable",
- "jsonStatus": "not_applicable",
- "expiresAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "scheduleId": "string",
- "token": "string"
}
This method enables you to delete a single generated report using the report's ID.
https://api.threatstack.com/v2/reports/generated-reports/{reportId}
400
OK
Bad parameters
Unauthorized response
The resource was not found
Rate limit hit
An internal error has occurred
{- "message": "string"
}
This method enables you to retrieve a download URL for single generated report using the report's ID.
Get the download URL for a specific generated report:
https://api.threatstack.com/v2/reports/generated-reports/{reportId}/link
Get the download URL for a specific generated report in PDF format:
https://api.threatstack.com/v2/reports/generated-reports/{reportId}/link?format=pdf
Success
Bad parameters
Unauthorized response
The resource was not found
Rate limit hit
An internal error has occurred
{- "id": "string",
- "url": "string",
- "expirationTime": 0
}
This method enables you to generate a report using data from a specified time period.
Generate a report for the past seven days:
https://api.threatstack.com/v2/reports/generate-report?from=2021-12-01&until=2021-12-07
Success
Bad parameters
Unauthorized response
The resource was not found
Rate limit hit
An internal error has occurred
{- "id": "string",
- "categoryId": "string",
- "orgId": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "reportType": "compliance",
- "pdfStatus": "not_applicable",
- "csvStatus": "not_applicable",
- "jsonStatus": "not_applicable",
- "expiresAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "scheduleId": "string",
- "token": "string"
}
This method enables you to retrieve the full list of report generation schedules available for your organization.
Get a list of report generation schedules:
https://api.threatstack.com/v2/reports/scheduled-reports
Success
Bad parameters
Unauthorized response
The resource was not found
Rate limit hit
An internal error has occurred
{- "scheduleId": "string",
- "orgId": "string",
- "reportType": "compliance",
- "cadence": "daily",
- "categoryComplianceId": "string"
}
This method enables you to create a report generation schedule for your organization.
Create a report generation schedule:
https://api.threatstack.com/v2/reports/scheduled-reports
Success
Bad parameters
Unauthorized response
Rate limit hit
An internal error has occurred
{- "scheduleId": "string",
- "orgId": "string",
- "reportType": "insight",
- "cadence": "daily",
- "categoryComplianceId": "string"
}
This method enables you to retrieve the information for a single report generation schedule.
Get a specific report generation schedule:
https://api.threatstack.com/v2/reports/scheduled-reports/{scheduleId}
Success
Bad parameters
Unauthorized response
The resource was not found
Rate limit hit
An internal error has occurred
{- "scheduleId": "string",
- "orgId": "string",
- "reportType": "insight",
- "cadence": "daily",
- "categoryComplianceId": "string"
}
This method enables you to delete a single report generation schedule.
Delete a specific generated report:
https://api.threatstack.com/v2/reports/scheduled-reports/{scheduleId}
Success
Bad parameters
Unauthorized response
The resource was not found
Rate limit hit
An internal error has occurred
{- "message": "string"
}