Skip to main content

security_reports

Overview

Namesecurity_reports
TypeResource
Idgoogle.apigee.security_reports

Fields

NameDatatypeDescription
createdstringCreation time of the query.
displayNamestringDisplay Name specified by the user.
envgroupHostnamestringHostname is available only when query is executed at host level.
errorstringError is set when query fails.
executionTimestringExecutionTime is available only after the query is completed.
queryParamsobjectMetadata for the security report.
reportDefinitionIdstringReport Definition ID.
resultobjectContains informations about the security report results.
resultFileSizestringResultFileSize is available only after the query is completed.
resultRowsstringResultRows is available only after the query is completed.
selfstringSelf link of the query. Example: /organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
statestringQuery state could be "enqueued", "running", "completed", "expired" and "failed".
updatedstringOutput only. Last updated timestamp for the query.

Methods

NameAccessible byRequired ParamsDescription
organizations_environments_security_reports_getSELECTenvironmentsId, organizationsId, securityReportsIdGet security report status If the query is still in progress, the state is set to "running" After the query has completed successfully, state is set to "completed"
organizations_environments_security_reports_listSELECTenvironmentsId, organizationsIdReturn a list of Security Reports
organizations_environments_security_reports_createINSERTenvironmentsId, organizationsIdSubmit a report request to be processed in the background. If the submission succeeds, the API returns a 200 status and an ID that refer to the report request. In addition to the HTTP status 200, the state of "enqueued" means that the request succeeded.
_organizations_environments_security_reports_listEXECenvironmentsId, organizationsIdReturn a list of Security Reports