Openstatus
www.openstatus.dev
📝 add docs
+9
-98
+4
apps/docs/api-reference/check/post-check.mdx
+4
apps/docs/api-reference/check/post-check.mdx
-96
apps/docs/api-reference/checker.mdx
-96
apps/docs/api-reference/checker.mdx
···
1
-
---
2
-
title: Checker
3
-
---
4
-
5
-
You can use the checker to check the status of your services. The checker is a
6
-
global service that runs on Fly.io machines and is available in the following
7
-
supported regions:
8
-
9
-
- `ams` (Amsterdam)
10
-
- `hkg` (Hong-Kong)
11
-
- `iad` (Northern Virginia)
12
-
- `gru` (São Paulo)
13
-
- `syd` (Sydney)
14
-
- `jnb` (Johannesburg)
15
-
16
-
Send a `POST` request to `https://checker.openstatus.dev/ping/[region]` with the
17
-
`url` and `method` as `body` props.
18
-
19
-
<Note>
20
-
You might want to define the `prefer-fly-region: [region]` header
21
-
additionally.
22
-
</Note>
23
-
24
-
### Example
25
-
26
-
```bash
27
-
curl --request POST \
28
-
--url https://checker.openstatus.dev/ping/ams \
29
-
--header 'Content-Type: application/json' \
30
-
--header 'x-openstatus-key: <YOUR_API_KEY>' \
31
-
--header 'prefer-fly-region: ams' \
32
-
--data '{
33
-
"url": "https://api.openstatus.dev/ping",
34
-
"method": "GET"
35
-
}'
36
-
```
37
-
38
-
Response:
39
-
40
-
```json
41
-
{
42
-
"status": 200,
43
-
"latency": 18,
44
-
"headers": {
45
-
"Content-Type": "application/json; charset=UTF-8",
46
-
"Date": "Sat, 20 Jan 2024 16:31:18 GMT",
47
-
"Fly-Request-Id": "01HMKVCQ9P2CBDS5GPFBN8EVYP-ams",
48
-
"Server": "Fly/f9c163a6 (2024-01-16)",
49
-
"Via": "2 fly.io"
50
-
},
51
-
"time": 1705768279337,
52
-
"timing": {
53
-
"dnsStart": 1705768279337,
54
-
"dnsDone": 1705768279343,
55
-
"connectStart": 1705768279343,
56
-
"connectDone": 1705768279343,
57
-
"tlsHandshakeStart": 1705768279343,
58
-
"tlsHandshakeDone": 1705768279350,
59
-
"firstByteStart": 1705768279350,
60
-
"firstByteDone": 1705768279355,
61
-
"transferStart": 1705768279355,
62
-
"transferDone": 1705768279355
63
-
}
64
-
}
65
-
```
66
-
67
-
All timestamps are in UNIX epoch milliseconds. The response `headers` are
68
-
unknown key value string pairs. All other props are fixed.
69
-
70
-
```ts
71
-
type CheckerResponse = {
72
-
status: number;
73
-
latency: number;
74
-
headers: Record<string, string>;
75
-
time: number;
76
-
timing: {
77
-
dnsStart: number;
78
-
dnsDone: number;
79
-
connectStart: number;
80
-
connectDone: number;
81
-
tlsHandshakeStart: number;
82
-
tlsHandshakeDone: number;
83
-
firstByteStart: number;
84
-
firstByteDone: number;
85
-
transferStart: number;
86
-
transferDone: number;
87
-
};
88
-
};
89
-
```
90
-
91
-
You can use it to check from a region the following metrics:
92
-
93
-
- DNS Look up time,
94
-
- TLS handshake time,
95
-
- TCP connection time,
96
-
- Time to first byte.
+5
-2
apps/docs/mint.json
+5
-2
apps/docs/mint.json
···
144
144
]
145
145
},
146
146
{
147
+
"group": "Check",
148
+
"pages": ["api-reference/check/post-check"]
149
+
},
150
+
{
147
151
"group": "Status Page",
148
152
"pages": [
149
153
"api-reference/page/get-page",
···
196
200
"api-reference/errors/code/CONFLICT",
197
201
"api-reference/errors/code/INTERNAL_SERVER_ERROR"
198
202
]
199
-
},
200
-
"api-reference/checker"
203
+
}
201
204
]
202
205
}
203
206
],