Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get Check

GET/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.

Get the Check with the specified rid.

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

Path parameters

checkRid
string

The unique resource identifier (RID) of a Check.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Response body

Check
object
Hide child attributes

Hide child attributes

rid
string

The unique resource identifier (RID) of a Check.

groups
list<CheckGroupRid>
optional
Show child attributes

Show child attributes

config
union

Configuration of a check.

Show child attributes

Show child attributes

intent
string
optional

A note about why the Check was set up.

createdBy
string
optional

The user that created the Check.

updatedTime
string
optional

The timestamp when the Check was last updated.

Examples

Request

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

Response

Copied!
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 responses

Error Name
CheckTypeNotSupportedError CodeINVALID_ARGUMENT
Status Code400
DescriptionThe type of the requested check is not yet supported in the Platform API.
ParameterscheckType
CheckNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given Check could not be found.
ParameterscheckRid