Method: organizations.locations.insightTypes.insights.markAccepted

Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated.

insights.markAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight.

HTTP request

POST https://recommender.googleapis.com/v1/{name=organizations/*/locations/*/insightTypes/*/insights/*}:markAccepted

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the insight.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "stateMetadata": {
    string: string,
    ...
  },
  "etag": string
}
Fields
stateMetadata

map (key: string, value: string)

Optional. State properties user wish to include with this state. Full replace of the current stateMetadata.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
etag

string

Required. Fingerprint of the Insight. Provides optimistic locking.

Response body

If successful, the response body contains an instance of Insight.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires one of the following IAM permissions on the name resource, depending on the resource type:

  • recommender.commitmentUtilizationInsights.update
  • recommender.computeAddressIdleResourceInsights.update
  • recommender.computeDiskIdleResourceInsights.update
  • recommender.computeFirewallInsights.update
  • recommender.computeImageIdleResourceInsights.update
  • recommender.iamPolicyInsights.update
  • recommender.iamServiceAccountInsights.update
  • recommender.resourcemanagerProjectUtilizationInsights.update

For more information, see the IAM documentation.