Nodes/health/config/webhook/listEventWebhook: GET

Gets a list of webhook event URLs.

Availability

Available on all IBM Storage Scale editions.

Description

The GET nodes/health/config/webhook/listEventWebhook request gets a list of webhook event URLs. For more information about the fields in the returned data structure, see mmhealth command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/nodes/health/config/webhook/listEventWebhook

where

webhook/listEventWebhook: Specifies the webhook event URLs as the resource. Required.

Request headers

Accept: application/json

Parameters

No parameters.

Request data

No request data.

Response data

{
  "status": {
    "code": Return Code,
    "message": "Return message."
  },
  "webhookEventList": []
    
  }

The details of the parameters are provided in the following list:

status

The request status

"code" : The Return code: The HTTP Status code.
"message" : "Return message": The return message.

"webhookEventList": Array

The list of overbook events.

Examples

The following example lists the webhook event URLs.

Request data:

curl -k -u user:password -X GET --header 'accept:application/json' --header 'Authorization: Basic YWRtaW46YWRtaW4wMDE=' 'https://198.51.100.1:443/scalemgmt/v2/nodes/health/config/webhook/listEventWebhook

Response data:

Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error.

{
  "status": {
    "code": 200,
    "message": "The request finished successfully."
  },
  "webhookEventList": [
    "mmhealth:webhook:HEADER:version:reserved:reserved:url:uuid:status:",
    "mmhealth:webhook:0:1:::http%3A//www.ibm.com:d7044381-2a54-4619-b84f-4b40734d62d5:enabled:"
  ]
}