Recommender API

Service: recommender.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://recommender.googleapis.com

REST Resource: v1beta1.billingAccounts.locations.insightTypes

Methods
getConfig GET /v1beta1/{name=billingAccounts/*/locations/*/insightTypes/*/config}
Gets the requested InsightTypeConfig.
updateConfig PATCH /v1beta1/{insightTypeConfig.name=billingAccounts/*/locations/*/insightTypes/*/config}
Updates an InsightTypeConfig change.

REST Resource: v1beta1.billingAccounts.locations.insightTypes.insights

Methods
get GET /v1beta1/{name=billingAccounts/*/locations/*/insightTypes/*/insights/*}
Gets the requested insight.
list GET /v1beta1/{parent=billingAccounts/*/locations/*/insightTypes/*}/insights
Lists insights for the specified Cloud Resource.
markAccepted POST /v1beta1/{name=billingAccounts/*/locations/*/insightTypes/*/insights/*}:markAccepted
Marks the Insight State as Accepted.

REST Resource: v1beta1.billingAccounts.locations.recommenders

Methods
getConfig GET /v1beta1/{name=billingAccounts/*/locations/*/recommenders/*/config}
Gets the requested Recommender Config.
updateConfig PATCH /v1beta1/{recommenderConfig.name=billingAccounts/*/locations/*/recommenders/*/config}
Updates a Recommender Config.

REST Resource: v1beta1.billingAccounts.locations.recommenders.recommendations

Methods
get GET /v1beta1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}
Gets the requested recommendation.
list GET /v1beta1/{parent=billingAccounts/*/locations/*/recommenders/*}/recommendations
Lists recommendations for the specified Cloud Resource.
markClaimed POST /v1beta1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}:markClaimed
Marks the Recommendation State as Claimed.
markDismissed POST /v1beta1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}:markDismissed
Mark the Recommendation State as Dismissed.
markFailed POST /v1beta1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}:markFailed
Marks the Recommendation State as Failed.
markSucceeded POST /v1beta1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}:markSucceeded
Marks the Recommendation State as Succeeded.

REST Resource: v1beta1.folders.locations.insightTypes.insights

Methods
get GET /v1beta1/{name=folders/*/locations/*/insightTypes/*/insights/*}
Gets the requested insight.
list GET /v1beta1/{parent=folders/*/locations/*/insightTypes/*}/insights
Lists insights for the specified Cloud Resource.
markAccepted POST /v1beta1/{name=folders/*/locations/*/insightTypes/*/insights/*}:markAccepted
Marks the Insight State as Accepted.

REST Resource: v1beta1.folders.locations.recommenders.recommendations

Methods
get GET /v1beta1/{name=folders/*/locations/*/recommenders/*/recommendations/*}
Gets the requested recommendation.
list GET /v1beta1/{parent=folders/*/locations/*/recommenders/*}/recommendations
Lists recommendations for the specified Cloud Resource.
markClaimed POST /v1beta1/{name=folders/*/locations/*/recommenders/*/recommendations/*}:markClaimed
Marks the Recommendation State as Claimed.
markDismissed POST /v1beta1/{name=folders/*/locations/*/recommenders/*/recommendations/*}:markDismissed
Mark the Recommendation State as Dismissed.
markFailed POST /v1beta1/{name=folders/*/locations/*/recommenders/*/recommendations/*}:markFailed
Marks the Recommendation State as Failed.
markSucceeded POST /v1beta1/{name=folders/*/locations/*/recommenders/*/recommendations/*}:markSucceeded
Marks the Recommendation State as Succeeded.

REST Resource: v1beta1.insightTypes

Methods
list GET /v1beta1/insightTypes
Lists available InsightTypes.

REST Resource: v1beta1.organizations.locations.insightTypes

Methods
getConfig GET /v1beta1/{name=organizations/*/locations/*/insightTypes/*/config}
Gets the requested InsightTypeConfig.
updateConfig PATCH /v1beta1/{insightTypeConfig.name=organizations/*/locations/*/insightTypes/*/config}
Updates an InsightTypeConfig change.

REST Resource: v1beta1.organizations.locations.insightTypes.insights

Methods
get GET /v1beta1/{name=organizations/*/locations/*/insightTypes/*/insights/*}
Gets the requested insight.
list GET /v1beta1/{parent=organizations/*/locations/*/insightTypes/*}/insights
Lists insights for the specified Cloud Resource.
markAccepted POST /v1beta1/{name=organizations/*/locations/*/insightTypes/*/insights/*}:markAccepted
Marks the Insight State as Accepted.

REST Resource: v1beta1.organizations.locations.recommenders

Methods
getConfig GET /v1beta1/{name=organizations/*/locations/*/recommenders/*/config}
Gets the requested Recommender Config.
updateConfig PATCH /v1beta1/{recommenderConfig.name=organizations/*/locations/*/recommenders/*/config}
Updates a Recommender Config.

REST Resource: v1beta1.organizations.locations.recommenders.recommendations

Methods
get GET /v1beta1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}
Gets the requested recommendation.
list GET /v1beta1/{parent=organizations/*/locations/*/recommenders/*}/recommendations
Lists recommendations for the specified Cloud Resource.
markClaimed POST /v1beta1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}:markClaimed
Marks the Recommendation State as Claimed.
markDismissed POST /v1beta1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}:markDismissed
Mark the Recommendation State as Dismissed.
markFailed POST /v1beta1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}:markFailed
Marks the Recommendation State as Failed.
markSucceeded POST /v1beta1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}:markSucceeded
Marks the Recommendation State as Succeeded.

REST Resource: v1beta1.projects.locations.insightTypes

Methods
getConfig GET /v1beta1/{name=projects/*/locations/*/insightTypes/*/config}
Gets the requested InsightTypeConfig.
updateConfig PATCH /v1beta1/{insightTypeConfig.name=projects/*/locations/*/insightTypes/*/config}
Updates an InsightTypeConfig change.

REST Resource: v1beta1.projects.locations.insightTypes.insights

Methods
get GET /v1beta1/{name=projects/*/locations/*/insightTypes/*/insights/*}
Gets the requested insight.
list GET /v1beta1/{parent=projects/*/locations/*/insightTypes/*}/insights
Lists insights for the specified Cloud Resource.
markAccepted POST /v1beta1/{name=projects/*/locations/*/insightTypes/*/insights/*}:markAccepted
Marks the Insight State as Accepted.

REST Resource: v1beta1.projects.locations.recommenders

Methods
getConfig GET /v1beta1/{name=projects/*/locations/*/recommenders/*/config}
Gets the requested Recommender Config.
updateConfig PATCH /v1beta1/{recommenderConfig.name=projects/*/locations/*/recommenders/*/config}
Updates a Recommender Config.

REST Resource: v1beta1.projects.locations.recommenders.recommendations

Methods
get GET /v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}
Gets the requested recommendation.
list GET /v1beta1/{parent=projects/*/locations/*/recommenders/*}/recommendations
Lists recommendations for the specified Cloud Resource.
markClaimed POST /v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markClaimed
Marks the Recommendation State as Claimed.
markDismissed POST /v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markDismissed
Mark the Recommendation State as Dismissed.
markFailed POST /v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markFailed
Marks the Recommendation State as Failed.
markSucceeded POST /v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markSucceeded
Marks the Recommendation State as Succeeded.

REST Resource: v1beta1.recommenders

Methods
list GET /v1beta1/recommenders
Lists all available Recommenders.

REST Resource: v1.billingAccounts.locations.insightTypes

Methods
getConfig GET /v1/{name=billingAccounts/*/locations/*/insightTypes/*/config}
Gets the requested InsightTypeConfig.
updateConfig PATCH /v1/{insightTypeConfig.name=billingAccounts/*/locations/*/insightTypes/*/config}
Updates an InsightTypeConfig change.

REST Resource: v1.billingAccounts.locations.insightTypes.insights

Methods
get GET /v1/{name=billingAccounts/*/locations/*/insightTypes/*/insights/*}
Gets the requested insight.
list GET /v1/{parent=billingAccounts/*/locations/*/insightTypes/*}/insights
Lists insights for the specified Cloud Resource.
markAccepted POST /v1/{name=billingAccounts/*/locations/*/insightTypes/*/insights/*}:markAccepted
Marks the Insight State as Accepted.

REST Resource: v1.billingAccounts.locations.recommenders

Methods
getConfig GET /v1/{name=billingAccounts/*/locations/*/recommenders/*/config}
Gets the requested Recommender Config.
updateConfig PATCH /v1/{recommenderConfig.name=billingAccounts/*/locations/*/recommenders/*/config}
Updates a Recommender Config.

REST Resource: v1.billingAccounts.locations.recommenders.recommendations

Methods
get GET /v1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}
Gets the requested recommendation.
list GET /v1/{parent=billingAccounts/*/locations/*/recommenders/*}/recommendations
Lists recommendations for the specified Cloud Resource.
markClaimed POST /v1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}:markClaimed
Marks the Recommendation State as Claimed.
markDismissed POST /v1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}:markDismissed
Mark the Recommendation State as Dismissed.
markFailed POST /v1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}:markFailed
Marks the Recommendation State as Failed.
markSucceeded POST /v1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}:markSucceeded
Marks the Recommendation State as Succeeded.

REST Resource: v1.folders.locations.insightTypes.insights

Methods
get GET /v1/{name=folders/*/locations/*/insightTypes/*/insights/*}
Gets the requested insight.
list GET /v1/{parent=folders/*/locations/*/insightTypes/*}/insights
Lists insights for the specified Cloud Resource.
markAccepted POST /v1/{name=folders/*/locations/*/insightTypes/*/insights/*}:markAccepted
Marks the Insight State as Accepted.

REST Resource: v1.folders.locations.recommenders.recommendations

Methods
get GET /v1/{name=folders/*/locations/*/recommenders/*/recommendations/*}
Gets the requested recommendation.
list GET /v1/{parent=folders/*/locations/*/recommenders/*}/recommendations
Lists recommendations for the specified Cloud Resource.
markClaimed POST /v1/{name=folders/*/locations/*/recommenders/*/recommendations/*}:markClaimed
Marks the Recommendation State as Claimed.
markDismissed POST /v1/{name=folders/*/locations/*/recommenders/*/recommendations/*}:markDismissed
Mark the Recommendation State as Dismissed.
markFailed POST /v1/{name=folders/*/locations/*/recommenders/*/recommendations/*}:markFailed
Marks the Recommendation State as Failed.
markSucceeded POST /v1/{name=folders/*/locations/*/recommenders/*/recommendations/*}:markSucceeded
Marks the Recommendation State as Succeeded.

REST Resource: v1.organizations.locations.insightTypes

Methods
getConfig GET /v1/{name=organizations/*/locations/*/insightTypes/*/config}
Gets the requested InsightTypeConfig.
updateConfig PATCH /v1/{insightTypeConfig.name=organizations/*/locations/*/insightTypes/*/config}
Updates an InsightTypeConfig change.

REST Resource: v1.organizations.locations.insightTypes.insights

Methods
get GET /v1/{name=organizations/*/locations/*/insightTypes/*/insights/*}
Gets the requested insight.
list GET /v1/{parent=organizations/*/locations/*/insightTypes/*}/insights
Lists insights for the specified Cloud Resource.
markAccepted POST /v1/{name=organizations/*/locations/*/insightTypes/*/insights/*}:markAccepted
Marks the Insight State as Accepted.

REST Resource: v1.organizations.locations.recommenders

Methods
getConfig GET /v1/{name=organizations/*/locations/*/recommenders/*/config}
Gets the requested Recommender Config.
updateConfig PATCH /v1/{recommenderConfig.name=organizations/*/locations/*/recommenders/*/config}
Updates a Recommender Config.

REST Resource: v1.organizations.locations.recommenders.recommendations

Methods
get GET /v1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}
Gets the requested recommendation.
list GET /v1/{parent=organizations/*/locations/*/recommenders/*}/recommendations
Lists recommendations for the specified Cloud Resource.
markClaimed POST /v1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}:markClaimed
Marks the Recommendation State as Claimed.
markDismissed POST /v1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}:markDismissed
Mark the Recommendation State as Dismissed.
markFailed POST /v1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}:markFailed
Marks the Recommendation State as Failed.
markSucceeded POST /v1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}:markSucceeded
Marks the Recommendation State as Succeeded.

REST Resource: v1.projects.locations.insightTypes

Methods
getConfig GET /v1/{name=projects/*/locations/*/insightTypes/*/config}
Gets the requested InsightTypeConfig.
updateConfig PATCH /v1/{insightTypeConfig.name=projects/*/locations/*/insightTypes/*/config}
Updates an InsightTypeConfig change.

REST Resource: v1.projects.locations.insightTypes.insights

Methods
get GET /v1/{name=projects/*/locations/*/insightTypes/*/insights/*}
Gets the requested insight.
list GET /v1/{parent=projects/*/locations/*/insightTypes/*}/insights
Lists insights for the specified Cloud Resource.
markAccepted POST /v1/{name=projects/*/locations/*/insightTypes/*/insights/*}:markAccepted
Marks the Insight State as Accepted.

REST Resource: v1.projects.locations.recommenders

Methods
getConfig GET /v1/{name=projects/*/locations/*/recommenders/*/config}
Gets the requested Recommender Config.
updateConfig PATCH /v1/{recommenderConfig.name=projects/*/locations/*/recommenders/*/config}
Updates a Recommender Config.

REST Resource: v1.projects.locations.recommenders.recommendations

Methods
get GET /v1/{name=projects/*/locations/*/recommenders/*/recommendations/*}
Gets the requested recommendation.
list GET /v1/{parent=projects/*/locations/*/recommenders/*}/recommendations
Lists recommendations for the specified Cloud Resource.
markClaimed POST /v1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markClaimed
Marks the Recommendation State as Claimed.
markDismissed POST /v1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markDismissed
Mark the Recommendation State as Dismissed.
markFailed POST /v1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markFailed
Marks the Recommendation State as Failed.
markSucceeded POST /v1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markSucceeded
Marks the Recommendation State as Succeeded.