Spyctl

Generate a spyderbat report

This will schedule a report to be generated based on provided input report type and arguments.

post/api/v1/org/{orgUID}/spyctl/report

Request

  • Base URL: https://api.prod.spyderbat.com
  • URL: https://api.prod.spyderbat.com/api/v1/org/{orgUID}/spyctl/report
  • Auth: HTTP bearer

Path parameters

orgUIDstring required

Request body

report_argsobject required

name value pair arguments for the report to generate

report_idstring required

identifier for the type of report to generate

report_tagsobject

name value pairs to tag the report to generate

Response

OK

context_uidstring

Context UID for this query, it's used to track the query as it flows through the system

errorstring

Error message if the report generation failed

formatsstring[]

List of formats available for the report

idstring

Identifier for the generated report, to use in subsequent status update requests

inputobject

Input arguments for the report

statusstring

Status of the report generation

Changes

No recorded changes to this operation across all 1 revision of this API.