Uptime
Create uptime checks, read their status and results, and see when your app stopped answering.
An uptime check is a request the engine makes to a URL of yours on a schedule. A check is down after two
failures in a row and up again after one success. Going down and coming back each create an
alert.
A self-hosted engine checks from where it runs, so it sees your app from one place. Sypnia Cloud checks from three regions and calls a check down when at least two of them fail.
The uptime check object
Fields
-
idstring optionalchk_…. -
namestring optional -
urlURL optional -
methodstring optional -
interval_secondsinteger optional -
timeout_msinteger optional -
expected_statusstring optional -
body_containsstring or null optional -
headersobject optional -
enabledboolean optional -
statusstring optionalunknownuntil the first check ran. One of:up,down,paused,unknown. -
down_sincetimestamp or null optionalThe first failure of the current outage.
-
last_checked_attimestamp or null optional -
last_status_codeinteger or null optionalThe HTTP status of the latest check.
nullwhen there was no answer. -
last_response_msinteger or null optional -
last_errorstring or null optionalWhy the latest check failed:
timeout,dns,connection_refused,tls,status_503,body_mismatch. -
uptime_24hnumber or null optionalPercent of checks that passed in the last 24 hours.
-
uptime_30dnumber or null optional -
created_attimestamp optional
List uptime checks
/v1/uptime/checks EngineCloud Every check of the project with its current status. This is what the MCP tool uptime returns.
Query parameters
-
projectstring optionalThe project’s id or slug. Needed only with a credential that can see several projects (the root token). With an API token it is ignored unless it names another project, which is
403. -
statusstring optionalOnly checks in this status. One of:
up,down,paused,unknown. -
limitinteger, 1 to 200 optionalMost items to return.
Default:
50 -
cursorstring optionalThe
next_cursorof the previous page. Keep every other parameter the same.
Request
curl "https://api.sypnia.com/v1/uptime/checks" \
-H "Authorization: Bearer $SYPNIA_API_TOKEN"Response200
{
"data": [
{
"id": "chk_1q9w3e7r5t2y",
"name": "Shop home",
"url": "https://shop.example.com/",
"method": "GET",
"interval_seconds": 60,
"timeout_ms": 10000,
"expected_status": "200-399",
"body_contains": null,
"headers": {},
"enabled": true,
"status": "up",
"down_since": null,
"last_checked_at": "2026-03-12T10:34:00Z",
"last_status_code": 200,
"last_response_ms": 184,
"last_error": null,
"uptime_24h": 100,
"uptime_30d": 99.98,
"created_at": "2026-02-02T09:20:00Z"
}
],
"next_cursor": null
}Create an uptime check
/v1/uptime/checks EngineCloud Starts checking a URL. The first check runs within a minute. The engine sends the header
User-Agent: Sypnia-Uptime/1.0, follows up to 3 redirects and never sends cookies. Only http and https
URLs on public addresses are allowed: a URL that resolves to a private or loopback address is refused, so a
check cannot be used to reach inside your own network.
Query parameters
-
projectstring optionalThe project’s id or slug. Needed only with a credential that can see several projects (the root token). With an API token it is ignored unless it names another project, which is
403.
Headers
-
Idempotency-Keystring, up to 255 characters optionalA value of your own, 1 to 255 characters, that makes the call safe to repeat. See idempotency.
Body
-
namestring, up to 80 characters optionalA name for people. Required when creating.
-
urlURL, up to 2,000 characters optionalThe URL to request. Required when creating.
-
methodstring optionalThe HTTP method. One of:
GET,HEAD.Default:
GET -
interval_secondsinteger optionalHow often to check. One of:
60,300,900.Default:
60 -
timeout_msinteger, 1,000 to 30,000 optionalAn answer slower than this is a failure.
Default:
10000 -
expected_statusstring optionalThe statuses that count as up: one (
200), a range (200-299) or a list (200,204,301).Default:
200-399 -
body_containsstring, up to 200 characters or null optionalText the answer’s body must contain to count as up. Only with
GET. The engine reads the first 256 KB. -
headersobject optionalUp to 10 request headers. They are stored and returned as you send them, so do not put secrets here.
-
enabledboolean optionalfalsepauses the check.Default:
true
Request
curl -X POST "https://api.sypnia.com/v1/uptime/checks" \
-H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "Shop home", "url": "https://shop.example.com/"}'Response201
{
"id": "chk_1q9w3e7r5t2y",
"name": "Shop home",
"url": "https://shop.example.com/",
"method": "GET",
"interval_seconds": 60,
"timeout_ms": 10000,
"expected_status": "200-399",
"body_contains": null,
"headers": {},
"enabled": true,
"status": "unknown",
"down_since": null,
"last_checked_at": null,
"last_status_code": null,
"last_response_ms": null,
"last_error": null,
"uptime_24h": null,
"uptime_30d": null,
"created_at": "2026-02-02T09:20:00Z"
}Errors
- 400
invalid_requestThe URL is not
httporhttps, resolves to a private address, or a field is out of range.paramnames the field. - 409
limit_reachedThe project already has as many checks as its plan allows (Sypnia Cloud), or as
SYPNIA_QUOTA_UPTIME_CHECKSallows (engine).
Get an uptime check
/v1/uptime/checks/{check_id} EngineCloud One check with its current status.
Path parameters
-
check_idstring requiredThe check’s id (
chk_…).
Query parameters
-
projectstring optionalThe project’s id or slug. Needed only with a credential that can see several projects (the root token). With an API token it is ignored unless it names another project, which is
403.
Request
curl "https://api.sypnia.com/v1/uptime/checks/chk_1q9w3e7r5t2y" \
-H "Authorization: Bearer $SYPNIA_API_TOKEN"Response200
{
"id": "chk_1q9w3e7r5t2y",
"name": "Shop home",
"url": "https://shop.example.com/",
"method": "GET",
"interval_seconds": 60,
"timeout_ms": 10000,
"expected_status": "200-399",
"body_contains": null,
"headers": {},
"enabled": true,
"status": "up",
"down_since": null,
"last_checked_at": "2026-03-12T10:34:00Z",
"last_status_code": 200,
"last_response_ms": 184,
"last_error": null,
"uptime_24h": 100,
"uptime_30d": 99.98,
"created_at": "2026-02-02T09:20:00Z"
}Errors
- 404
not_foundNo check has this id in the project.
Update an uptime check
/v1/uptime/checks/{check_id} EngineCloud Changes the fields you send and leaves the rest. Set enabled to false to pause a check; a paused check has status paused and creates no alerts.
Path parameters
-
check_idstring requiredThe check’s id (
chk_…).
Query parameters
-
projectstring optionalThe project’s id or slug. Needed only with a credential that can see several projects (the root token). With an API token it is ignored unless it names another project, which is
403.
Body
-
namestring, up to 80 characters optionalA name for people. Required when creating.
-
urlURL, up to 2,000 characters optionalThe URL to request. Required when creating.
-
methodstring optionalThe HTTP method. One of:
GET,HEAD.Default:
GET -
interval_secondsinteger optionalHow often to check. One of:
60,300,900.Default:
60 -
timeout_msinteger, 1,000 to 30,000 optionalAn answer slower than this is a failure.
Default:
10000 -
expected_statusstring optionalThe statuses that count as up: one (
200), a range (200-299) or a list (200,204,301).Default:
200-399 -
body_containsstring, up to 200 characters or null optionalText the answer’s body must contain to count as up. Only with
GET. The engine reads the first 256 KB. -
headersobject optionalUp to 10 request headers. They are stored and returned as you send them, so do not put secrets here.
-
enabledboolean optionalfalsepauses the check.Default:
true
Request
curl -X PATCH "https://api.sypnia.com/v1/uptime/checks/chk_1q9w3e7r5t2y" \
-H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN" \
-H "Content-Type: application/json" \
-d '{"interval_seconds": 300, "body_contains": "Add to cart"}'Response200
{
"id": "chk_1q9w3e7r5t2y",
"name": "Shop home",
"url": "https://shop.example.com/",
"method": "GET",
"interval_seconds": 300,
"timeout_ms": 10000,
"expected_status": "200-399",
"body_contains": "Add to cart",
"headers": {},
"enabled": true,
"status": "up",
"down_since": null,
"last_checked_at": "2026-03-12T10:33:00Z",
"last_status_code": 200,
"last_response_ms": 184,
"last_error": null,
"uptime_24h": 100,
"uptime_30d": 99.98,
"created_at": "2026-02-02T09:20:00Z"
}Errors
- 400
invalid_requestA field is out of range.
paramnames it. - 404
not_foundNo check has this id in the project.
Delete an uptime check
/v1/uptime/checks/{check_id} EngineCloud Stops the check and deletes its results. Alerts it created stay.
Path parameters
-
check_idstring requiredThe check’s id (
chk_…).
Query parameters
-
projectstring optionalThe project’s id or slug. Needed only with a credential that can see several projects (the root token). With an API token it is ignored unless it names another project, which is
403.
Request
curl -X DELETE "https://api.sypnia.com/v1/uptime/checks/chk_1q9w3e7r5t2y" \
-H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN"Errors
- 404
not_foundNo check has this id in the project.
Get an uptime check’s results
/v1/uptime/checks/{check_id}/results EngineCloud The check’s history: one bucket per hour with how many checks ran, how many failed and how long the answers took, plus the incidents, each stretch of time the check was down. Single results are kept for 7 days and hourly buckets for 400 days.
Path parameters
-
check_idstring requiredThe check’s id (
chk_…).
Query parameters
-
projectstring optionalThe project’s id or slug. Needed only with a credential that can see several projects (the root token). With an API token it is ignored unless it names another project, which is
403. -
sincestring optionalStart of the period.
Default:
24h -
untilstring optionalEnd of the time range. An ISO 8601 timestamp or a relative value. Defaults to now.
Request
curl "https://api.sypnia.com/v1/uptime/checks/chk_1q9w3e7r5t2y/results?since=3h" \
-H "Authorization: Bearer $SYPNIA_API_TOKEN"Response200
{
"check_id": "chk_1q9w3e7r5t2y",
"uptime": 99.44,
"buckets": [
{
"start": "2026-03-12T08:00:00Z",
"checks": 60,
"failures": 0,
"avg_ms": 181,
"p95_ms": 240
},
{
"start": "2026-03-12T09:00:00Z",
"checks": 60,
"failures": 1,
"avg_ms": 190,
"p95_ms": 262
},
{
"start": "2026-03-12T10:00:00Z",
"checks": 33,
"failures": 0,
"avg_ms": 184,
"p95_ms": 251
}
],
"incidents": []
}Errors
- 404
not_foundNo check has this id in the project.
The errors every endpoint can answer (401, 403, 429, 500, 503) are on Errors, limits, pagination.