Documentation · API reference
GET
/api/v1/nightlyThe nightly check, as it last ran on this tidekeeper
This page as Markdown, or in an AI chatMore ways to read this page
The nightly check, as it last ran on this tidekeeper.
# The nightly check, as it last ran on this tidekeeper
> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-nightly
`GET /api/v1/nightly`
The nightly check, as it last ran on this tidekeeper.
## The answer
200, `NightlyView`: The nightly check (the Stores board): what each check found the last time it ran here.
- `checks` (list of NightlyLine, needed)
- `next` (integer, needed): When it runs next.
- `of` (integer, needed)
- `passed` (integer, needed): Of the checks that run here, how many passed, and how many there are.
- `ran` (integer or null): When it last ran. None: not yet, on this tidekeeper.
- `version` (string, needed): The version that ran it.
## Asking
```sh
curl https://tidekeeper.eu/api/v1/nightly \
-H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```
The answer
Status 200
NightlyView The nightly check (the Stores board): what each check found the last time it ran here.
- checks
- list of NightlyLineneeded
- next
- integerneededWhen it runs next.
- of
- integerneeded
- passed
- integerneededOf the checks that run here, how many passed, and how many there are.
- ran
- integer or nullWhen it last ran. None: not yet, on this tidekeeper.
- version
- stringneededThe version that ran it.
Asking
curl https://tidekeeper.eu/api/v1/nightly \ -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
const answer = await fetch("https://tidekeeper.eu/api/v1/nightly", { headers: { Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`, }, }).then((r) => r.json());