Version 2.0

Delete Check

DELETE/api/v2/dataHealth/checks/{checkRid}

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Delete the Check with the specified rid.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:data-health-write.

Path parameters

checkRid

string

The unique resource identifier (RID) of a Data Health Check.

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Examples

Request

Copied!

curl -X DELETE \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/dataHealth/checks/ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3?preview=true"

Error responses

Error Name
`DeleteCheckPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not delete the Check.
	Parameters	`checkRid`
`CheckNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given Check could not be found.
	Parameters	`checkRid`

See Errors for a general overview of errors in the platform.