DELETE Notification Webhook Webhook Id

DELETE Notification Webhook Webhook Id

Delete specified webhook configuration.

Request
URI
DELETE
https://{api_host}/api/v2/notification/webhook/{webhookId}
COPY
Path Parameters
string
webhookId
Required

The UUID of the webhook

Query Parameters
boolean
force
Optional
Constraints: default: false

Force delete specified webhook configuration and ignore its dependencies.


Authentication
This operation uses the following authentication methods.
Responses
200

Successfully deleted webhook configuration.

Operation doesn't return any data structure

401
Operation doesn't return any data structure

404

Provided webhook configuration ID is not found.

Operation doesn't return any data structure

409

Failed to delete webhook configuration because of dependencies.

Operation doesn't return any data structure

440
Operation doesn't return any data structure

500

Internal error while processing the client request

Returns error of type(s) application/json
{
    "errorMessage": "The operation failed due to an internal error."
}
string
errorMessage
Required

A message describing the error.

string
errorCode
Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,
object
errorDetails
Optional

Dynamic error details, where the field name can vary depending on the request field and error code.


Code Samples
COPY
                    curl -X DELETE -H 'Authorization: <value>' https://{api_host}/api/v2/notification/webhook/{webhookId}