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.
Creates a new Check.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:data-health-write.
objectunionConfiguration of a check.
stringA note about why the Check was set up.
objectThe created Check
stringThe unique resource identifier (RID) of a Check.
list<CheckGroupRid>unionConfiguration of a check.
stringA note about why the Check was set up.
stringThe user that created the Check.
stringThe timestamp when the Check was last updated.
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/dataHealth/checks?preview=true" \
-d '{"intent":"Check to ensure builds are passing."}'1
2
3
4
5
6
7
8
9
{
"updatedTime": "2024-09-25T17:29:35.974Z",
"createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"groups": [
"ri.data-health.main.check-group.08e376a8-607d-4f44-b8dd-b4587be6ce9b"
],
"rid": "ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3",
"intent": "Check to ensure builds are passing."
}| Error Name | ||
|---|---|---|
Check | Error Code | CONFLICT |
| Status Code | 409 | |
| Description | A check of the given type for the given subject(s) already exists. The conflicting check will be returned if the provided token has permission to view it. | |
| Parameters | conflictingCheck | |
Create | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not create the Check. | |
| Parameters | | |
Create | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not create the Check. | |
| Parameters | | |
See Errors for a general overview of errors in the platform.