Assured Workloads API (assuredworkloads:v1)

Additions

Methods


• ▼ ▲ assuredworkloads.organizations.locations.dbFrameworkComplianceSummaries.list

  Parameter Order : parent

  Parameters :

  parent

  Type : string

  Description : Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location}

  Required : Yes

  Location : path

  Pattern : ^organizations/[^/]+/locations/[^/]+$

  pageToken

  Description : Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.

  Type : string

  Location : query

  filter

  Location : query

  Type : string

  Description : Optional. The filtering results.

  view

  Description : Optional. Specifies the level of detail to return in the response.

  Enum Descriptions :

  • The default / unset value. The API will default to the BASIC view.
  • Includes basic compliance metadata, but omits trend data.
  • Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days.

  Type : string

  Enum :

  • FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED
  • FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC
  • FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL

  Location : query

  pageSize

  Type : integer

  Location : query

  Description : Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.

  Format : int32

  Scopes : https://www.googleapis.com/auth/cloud-platform

  HTTP Method : GET

  Description : Lists the framework compliance summary for a given scope.

  Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceSummaries

  Path : v1/{+parent}/dbFrameworkComplianceSummaries

• ▼ ▲ assuredworkloads.organizations.locations.dbFrameworkComplianceReports.fetch

  Parameter Order : name

  Parameters :

  endTime

  Description : Optional. The end time of the report.

  Format : google-datetime

  Type : string

  Location : query

  name

  Pattern : ^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$

  Location : path

  Description : Required. The name of the framework compliance report to retrieve.

  Required : Yes

  Type : string

  filter

  Description : Optional. The filtering results.

  Location : query

  Type : string

  Scopes : https://www.googleapis.com/auth/cloud-platform

  HTTP Method : GET

  Description : Fetches the framework compliance report for a given scope.

  Path : v1/{+name}:fetch

  Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch

• ▼ ▲ assuredworkloads.organizations.locations.dbFrameworkComplianceReports.aggregate

  HTTP Method : GET

  Description : Gets the aggregated compliance report over time for a given scope.

  Parameters :

  interval.endTime

  Location : query

  Type : string

  Description : Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

  Format : google-datetime

  name

  Description : Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`

  Required : Yes

  Type : string

  Pattern : ^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$

  Location : path

  interval.startTime

  Location : query

  Type : string

  Description : Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

  Format : google-datetime

  filter

  Description : Optional. The filtering results.

  Type : string

  Location : query

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Parameter Order : name

  Path : v1/{+name}:aggregate

  Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate

• ▼ ▲ assuredworkloads.organizations.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list

  Parameter Order : parent

  Parameters :

  filter

  Location : query

  Type : string

  Description : Optional. The filtering results.

  parent

  Pattern : ^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$

  Location : path

  Description : Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}

  Required : Yes

  Type : string

  pageSize

  Location : query

  Type : integer

  Description : Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.

  Format : int32

  pageToken

  Description : Optional. A token that identifies the page of results that the server should return.

  Type : string

  Location : query

  Scopes : https://www.googleapis.com/auth/cloud-platform

  HTTP Method : GET

  Description : Lists the control compliance summary for a given scope.

  Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries

  Path : v1/{+parent}/dbControlComplianceSummaries

• ▼ ▲ assuredworkloads.folders.locations.dbFrameworkComplianceSummaries.list

  Parameters :

  view

  Enum Descriptions :

  • The default / unset value. The API will default to the BASIC view.
  • Includes basic compliance metadata, but omits trend data.
  • Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days.

  Type : string

  Enum :

  • FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED
  • FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC
  • FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL

  Description : Optional. Specifies the level of detail to return in the response.

  Location : query

  filter

  Type : string

  Location : query

  Description : Optional. The filtering results.

  pageSize

  Description : Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.

  Format : int32

  Location : query

  Type : integer

  pageToken

  Type : string

  Location : query

  Description : Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.

  parent

  Location : path

  Pattern : ^folders/[^/]+/locations/[^/]+$

  Type : string

  Description : Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location}

  Required : Yes

  Scopes : https://www.googleapis.com/auth/cloud-platform

  HTTP Method : GET

  Description : Lists the framework compliance summary for a given scope.

  Parameter Order : parent

  Flat Path : v1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceSummaries

  Path : v1/{+parent}/dbFrameworkComplianceSummaries

• ▼ ▲ assuredworkloads.folders.locations.dbFrameworkComplianceReports.fetch

  Path : v1/{+name}:fetch

  Flat Path : v1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch

  Parameter Order : name

  Parameters :

  name

  Description : Required. The name of the framework compliance report to retrieve.

  Required : Yes

  Type : string

  Pattern : ^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$

  Location : path

  filter

  Description : Optional. The filtering results.

  Location : query

  Type : string

  endTime

  Location : query

  Type : string

  Description : Optional. The end time of the report.

  Format : google-datetime

  Scopes : https://www.googleapis.com/auth/cloud-platform

  HTTP Method : GET

  Description : Fetches the framework compliance report for a given scope.

• ▼ ▲ assuredworkloads.folders.locations.dbFrameworkComplianceReports.aggregate

  Path : v1/{+name}:aggregate

  Flat Path : v1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate

  Parameters :

  name

  Location : path

  Pattern : ^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$

  Type : string

  Description : Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`

  Required : Yes

  interval.startTime

  Location : query

  Type : string

  Description : Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

  Format : google-datetime

  filter

  Location : query

  Type : string

  Description : Optional. The filtering results.

  interval.endTime

  Description : Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

  Format : google-datetime

  Location : query

  Type : string

  Scopes : https://www.googleapis.com/auth/cloud-platform

  HTTP Method : GET

  Description : Gets the aggregated compliance report over time for a given scope.

  Parameter Order : name

• ▼ ▲ assuredworkloads.folders.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list

  Path : v1/{+parent}/dbControlComplianceSummaries

  Flat Path : v1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries

  Parameter Order : parent

  Parameters :

  filter

  Type : string

  Location : query

  Description : Optional. The filtering results.

  pageToken

  Location : query

  Type : string

  Description : Optional. A token that identifies the page of results that the server should return.

  parent

  Description : Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}

  Required : Yes

  Type : string

  Pattern : ^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$

  Location : path

  pageSize

  Type : integer

  Location : query

  Description : Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.

  Format : int32

  Scopes : https://www.googleapis.com/auth/cloud-platform

  HTTP Method : GET

  Description : Lists the control compliance summary for a given scope.

• ▼ ▲ assuredworkloads.projects.locations.dbFrameworkComplianceSummaries.list

  HTTP Method : GET

  Description : Lists the framework compliance summary for a given scope.

  Parameters :

  view

  Location : query

  Enum Descriptions :

  • The default / unset value. The API will default to the BASIC view.
  • Includes basic compliance metadata, but omits trend data.
  • Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days.

  Type : string

  Enum :

  • FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED
  • FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC
  • FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL

  Description : Optional. Specifies the level of detail to return in the response.

  filter

  Location : query

  Type : string

  Description : Optional. The filtering results.

  pageSize

  Description : Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.

  Format : int32

  Location : query

  Type : integer

  pageToken

  Description : Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.

  Type : string

  Location : query

  parent

  Type : string

  Description : Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location}

  Required : Yes

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+$

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Parameter Order : parent

  Path : v1/{+parent}/dbFrameworkComplianceSummaries

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceSummaries

• ▼ ▲ assuredworkloads.projects.locations.dbFrameworkComplianceReports.fetch

  HTTP Method : GET

  Description : Fetches the framework compliance report for a given scope.

  Parameters :

  endTime

  Description : Optional. The end time of the report.

  Format : google-datetime

  Location : query

  Type : string

  name

  Type : string

  Description : Required. The name of the framework compliance report to retrieve.

  Required : Yes

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$

  filter

  Location : query

  Type : string

  Description : Optional. The filtering results.

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Parameter Order : name

  Path : v1/{+name}:fetch

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch

• ▼ ▲ assuredworkloads.projects.locations.dbFrameworkComplianceReports.aggregate

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate

  Path : v1/{+name}:aggregate

  HTTP Method : GET

  Description : Gets the aggregated compliance report over time for a given scope.

  Parameters :

  name

  Type : string

  Description : Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`

  Required : Yes

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$

  interval.startTime

  Location : query

  Type : string

  Description : Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

  Format : google-datetime

  filter

  Location : query

  Type : string

  Description : Optional. The filtering results.

  interval.endTime

  Location : query

  Type : string

  Description : Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

  Format : google-datetime

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Parameter Order : name

• ▼ ▲ assuredworkloads.projects.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list

  Path : v1/{+parent}/dbControlComplianceSummaries

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries

  Parameter Order : parent

  Parameters :

  filter

  Location : query

  Type : string

  Description : Optional. The filtering results.

  parent

  Pattern : ^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$

  Location : path

  Description : Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}

  Required : Yes

  Type : string

  pageSize

  Description : Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.

  Format : int32

  Location : query

  Type : integer

  pageToken

  Description : Optional. A token that identifies the page of results that the server should return.

  Location : query

  Type : string

  Scopes : https://www.googleapis.com/auth/cloud-platform

  HTTP Method : GET

  Description : Lists the control compliance summary for a given scope.