How to programmatically get all data health check RIDs in a Space

Ask the Community
,
1

Is there a way to programmatically determine all the data health checks in a space?

I want to do something like the following:

GET {HOSTNAME}/{space_rid}/checks

and receive a list of health check RIDS. From there we can use the platform SDK to retrieve information about each check.

2

Hi @coffee-operator,

We don’t have support for this yet in the Platform SDK.

As you’ve probably seen, we have Create Check and Delete Check. Get Check (for an individual check rid) is coming very soon.

After that, we are also planning support for getting all checks for a given subject (eg, Get Checks for Dataset, Get Checks for Schedule) in the coming weeks.

We can look into the feasibility of getting all checks for a given space but implementation of that may be further off.

Best,
Tom

1 Like
3

Thanks @tompp this is a great update for our use cases. I’ve been looking at this endpoint closely, if you could ping when this is available I would greatly appreciate it.

Two follow-up questions:

  1. Is it possible to programmatically get all schedules in a project?
    1. Datasets are more straightforward.
  2. Have you considered incorporating the DevOps/Marketplace APIs in the Platform SDK?
    1. It would be really valuable to walk between installed products → installation health (via data health checks).
4

Hi @coffee-operator,

  1. I think the only way to do this at the moment would be to use List Children Of Folder recursively, starting from the project, and for each dataset you find, call Get Dataset Schedules. So yes, technically it’s possible to do it programmatically but not with a single API call.
  2. We have definitely considered this and know that it would be a very useful feature of the Platform SDK. However, there are quite a lot of complexities involved so I don’t have a timeline, I’m afraid.

Best,
Tom

1 Like
5

Hi @coffee-operator,

Just a quick update to let you know that Get Check and Get Dataset Health Checks are now both available to use.

Best,
Tom

6

Thank you! I’ve started using these. Any plans to enable retrieval of a check’s runs?

For example: GET /api/v2/dataHealth/checks/{checkRid}/runs

Similar idea to retrieving the runs of a schedule, i.e. https://www.palantir.com/docs/foundry/api/v2/orchestration-v2-resources/schedules/list-runs-of-schedule/.

7

Yes, that’s next on the list! In the context of Data Health, I think these will be known as a Check Report. I’ll update you when that’s available.

1 Like
8

Thank you so much. These endpoints and the SDK(s) are really improving our work with the platform.