Analysis: Webhook

#340490

Description

The /webhook/analysis resource is used to manage the webhook definition for a Densify analysis. The webhook definition is the path and authentication to a third-party application, where recommendation results are sent when the analysis completes. The receiving application can process the resulting data for downstream consumption. For example, the receiving application can route recommendations to an orchestration engine or distribute reports to instance owners.

You can define the webhook when you initiate data collection and analysis with the /analysis/<platformType>/<platformSubType>/analyze request. See the example, Run AWS data collection and analysis for details of specifying webhook input parameters. Results are posted to the webhook location when the analysis is complete. You can edit or delete a webhook at any time.

Resource

/webhook/analysis

Supported Operations

Table: Webhook Supported Operations

Operation	HTTP Method	Input	Output	Description
List all analyses webhooks for a specific platform type	GET /webhook/analysis/<platformType>	Path Parameter: platformType	Collection of: analysisId analysisName href uri webHookStatus	Use this resource to list all analysis webhook definitions for a particular platform type in Densify. Example: Retrieving All Cloud Webhook Definitions Example: Retrieving All Container Webhook Definitions
Get a webhook definition for an analysis	GET /webhook/analysis/<platformType>/<platformSubType>/<analysisId>	Path Parameters: platformType platformSubType analysisId	analysisId analysisName href uri webHookStatus	Use this resource to return the webhook details of a specific analysis in Densify. Example: Getting a Webhook Definition for an AWS Analysis
Add webhook to an analysis	POST /webhook/analysis/<platformType>/<platformSubType>/<analysisId>	Path Parameters: platformType platformSubType analysisId Request Body Parameters: uri authType authValue	message status	Use this resource to add a webhook definition to an existing analysis in Densify. You can only add a webhook to an analysis without a webhook. To update a webhook, use the PUT method. See Update a webhook for an analysis for details. Example: Adding a Webhook to an Existing AWS Analysis
Update a webhook for an analysis	PUT /webhook/analysis/<platformType>/<platformSubType>/<analysisId>	Path Parameters: platformType platformSubType analysisId Request Body Parameters: uri authType authValue	message status	Use this resource to update a webhook definition of an existing analysis in Densify. Example: Updating an AWS Analysis Webhook
Delete a webhook from an analysis	DELETE /webhook/analysis/<platformType>/<platformSubType>/<analysisId>	Path Parameters: platformType platformSubType analysisId	message status	Use this resource to delete a webhook definition from an existing analysis. Example: Deleting a Webhook from an AWS Analysis

Parameters

Path Parameters

Table: Webhook Path Parameters

Parameter Name	Type	Description
platformType	string	[cloud\|containers] The technology platform of the analysis.
platformSubType	string	The platform sub-type of the analysis. This is the vendor for the cloud platform. Possible platform sub-types depend on the platformType specified: For platformType = cloud, platformSubType = [aws\|gcp\|azure] For platformType = containers, platformSubType = [kubernetes]
analysisId	string	The referenced ID of the analysis.

Request Body Parameters

Table: Webhook Request Body Parameters

Parameter Name	Type	Description
uri	string	The URI to the webhook application. Note: You must ensure that the webhook URI is accessible from the Densify system with a fully qualified domain name or an IP address.
authType	string	The authorization type (i.e. Basic, Bearer) for the webhook application.
authValue	string	The authorization value (i.e. username, password, token) for the webhook application. Densify assumes that the authorization value is in standard Base64 encoding, but if a colon (":") is present in the value, then Densify assumes that the value is in plain text with username:password format.

Response

Table: Webhook Response Schema

Element	Type	Sort By/Filter	Description
analysisId	string		The Densify assigned ID for the analysis entity.
href	string		The analysis webhook resource reference.
uri	string		The webhook URI.
webHookStatus	string		The status of the last webhook POST request. Recommendations are pushed to the webhook URI via a POST request after analysis completion.
analysisName	string		The name assigned to the analysis. The default analysis name is the platform-specific cluster, account, project, or subscription ID.
message	string		The message for the status response. For example, the following messages are returned for the error codes below: 400—"Analysis webhook already exists." 404—"Analysis webhook not found."
status	number		The HTTP response code of the request. Possible status values include: 200—success with webhook request; 400—object already exists or invalid parameters; 401—authentication failed; 404—resource not found.

Examples

Example: Retrieving All Cloud Webhook Definitions

The following example shows you how to list all cloud webhook definitions in Densify.

Example: Listing All Cloud Webhook Definitions

Request:

GET /webhook/analysis/cloud

Response:

[

{

"analysisId": "f73e13ca-09d3-4395-8e32-894669a6d1eb",

"analysisName": "551345225429"

"href": "/webhook/analysis/cloud/aws/f73e13ca-09d3-4395-8e32-894669a6d1eb",

"uri": "https://webhookdensify:443/results/display/",

"webHookStatus": "success"

{

"analysisId": "329959e9-3641-4677-a665-dff754943944",

"analysisName": "330076083786"

"href": "/webhook/analysis/cloud/aws/329959e9-3641-4677-a665-dff754943944",

"uri": "https://webhooknow:443/api/results/test",

"webHookStatus": "An error occured executing POST request"

}

]

Example: Retrieving All Container Webhook Definitions

The following example shows you how to list all container webhook definitions in Densify.

Example: Listing All Container Webhook Definitions

Request:

GET /webhook/analysis/containers

Response:

[

{

"analysisId": "e8298ac3-a143-41bb-b7d7-62f659f43ec5",

"analysisName": "kube-prod-341ops",

"href": "/webhook/analysis/containers/kubernetes/e8298ac3-a143-41bb-b7d7-62f659f43ec5",

"uri": "https://webhookdensify:443/results/display/",

"webHookStatus": "success"

{

"analysisId": "d32959e9-3641-4677-a665-dff754943945",

"analysisName": "kube-dev-543",

"href": "/webhook/analysis/containers/kubernetes/d32959e9-3641-4677-a665-dff754943945",

"uri": "https://mycontainerresources:443/api/results/",

"webHookStatus": "An error occured executing POST request"

}

]

Example: Getting a Webhook Definition for an AWS Analysis

The following example shows you how to return the details of a webhook definition for an AWS analysis.

Example: Adding a Webhook to an Existing AWS Analysis

The following example shows you how to add a webhook definition to an existing AWS analysis without a webhook.

Example: Updating an AWS Analysis Webhook

The following example shows you how to update a webhook definition for an AWS analysis.

Example: Deleting a Webhook from an AWS Analysis

The following example shows you how to delete a webhook definition from an AWS analysis.