Search documentation
karat

+

K

User Documentation ↗
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 Check.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Examples

Request

Copied!
1 2 3 curl -X DELETE \ -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
DeleteCheckPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not delete the Check.
ParameterscheckRid
DeleteCheckPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not delete the Check.
ParameterscheckRid
CheckNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given Check could not be found.
ParameterscheckRid