Remediate recommendation

This API triggers action on the recommendations for given resources.

This topic includes the following sections:

HTTP method: POST

Request URL: https://portal.us1.onbmc.com/cloudops/api/v1/recommendations/action/remediate

Header: See HTTP-request-and-response-headers for header information, such as required authorization token.

Request

Accepts list of recommendations with a reference timestamp.

Request body properties

Parameter	Type	Required	Description
resource_id	String	Yes	Identifier of the resource in the cloud.
provider_id	String	Yes	Provider to which the resource is associated to.
category	String	Yes	Source of recommendation. Possible values: COST, SECURITY, PERFORMANCE, and so on.
type	String	Yes	Code of the recommendation type. Possible values: IDLE_VM, IDLE_RDS, OVERALLOCATED_VM, ON-OFF_WORKLOAD, RESERVED_INSTANCES, NO_RECOMMENDATION, FORECASTED_SATURATION, CLUSTER_OVER_SUBSCRIPTION, CLUSTER_UNDER_SUBSCRIPTION, OLD_SNAPSHOTS, GENERIC.

Example request JSON

[
    {
       "resource_id": "abcd-01",
       "provider_id": "aws",
       "category": "COST",
       "type": "OVERALLOCATED_VM"
    },
    {
       "resource_id": "abcd-02",
       "provider_id": "aws",
       "category": "COST",
       "type": "OVERALLOCATED_VM"
    },
    {
       "resource_id": "abcd-03",
       "provider_id": "aws",
       "category": "COST",
       "type": "OVERALLOCATED_VM"
    },
    {
       "resource_id": "abcd-04",
       "provider_id": "aws",
       "category": "COST",
       "type": "OVERALLOCATED_VM"
    }
]

Response

Example response JSON

HTTP/1.1 207 Multi-Status for 4 recommendations

{
   "200": [
            {
               "resource_id": "abcd-01",
               "provider_id": "aws",
               "category": "COST",
               "type": "OVERALLOCATED_VM",
               "message_id": "123456789012",
               "recommendation_details": "{...}"
            },
            {
               "resource_id": "abcd-02",
               "provider_id": "aws",
               "category": "COST",
               "type": "OVERALLOCATED_VM",
               "message_id": "123456789013",
               "recommendation_details": "{...}"
            }
        ],
   "404":[
            {
               "resource_id": "abcd-04",
               "provider_id": "aws",
               "category": "COST",
               "type": "OVERALLOCATED_VM"
            }
        ]
}

Status codes and messages

HTTP code	Message	Description
200	OK	Request succeeded
401		Unauthorized
400		Bad request