Skip to content

Commit 0008aed

Browse files
author
API Spec Updater
committed
Update API specification from live endpoint
Automatically fetched from https://api.checklyhq.com/swagger.json Updated on 2025-10-09 02:32:12 UTC
1 parent 28e6c01 commit 0008aed

1 file changed

Lines changed: 11 additions & 15 deletions

File tree

‎api-reference/openapi.json‎

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4127,7 +4127,7 @@ This endpoint will return data within a 6-hour timeframe. If the `from` and `to`
41274127
],
41284128
"responses": {
41294129
"201": {
4130-
"description": "Returns the check sessions that were created for the checks.",
4130+
"description": "Returns a check session for each check matching target conditions.",
41314131
"content": {
41324132
"application/json": {
41334133
"schema": {
@@ -4193,7 +4193,7 @@ This endpoint will return data within a 6-hour timeframe. If the `from` and `to`
41934193
"get": {
41944194
"summary": "Retrieve a check session",
41954195
"operationId": "getV1ChecksessionsChecksessionid",
4196-
"description": "Retrieves a check session. Note that the returned data may be incomplete if the check session is still in progress.\n\nResults for all finished check runs are included. A check session should have one result for each of its run locations. Each result contains just enough information to quickly determine whether the check run was successful or not. To dive even deeper into individual results, use the `GET /v1/check-results/{checkId}/{checkResultId}` endpoint to retrieve detailed data about a specific result.",
4196+
"description": "Retrieves a check session. Results may be incomplete if the check session is still in progress.\n\nOnce a check session has finished, results will include at least one check result for each run location: one result with `resultType` equal to `\"FINAL\"`, and zero or more results with `resultType` equal to `\"ATTEMPT\"` (one for each failed attempt, if any).\n\nEach result contains just enough information to quickly determine whether the check run was successful or not. To dive even deeper into individual results, use the `GET /v1/check-results/{checkId}/{checkResultId}` endpoint to retrieve detailed data about a specific result.",
41974197
"parameters": [
41984198
{
41994199
"description": "The unique identifier of the check session.",
@@ -5335,7 +5335,7 @@ This endpoint will return data within a 6-hour timeframe. If the `from` and `to`
53355335
"schema": {
53365336
"type": "string",
53375337
"format": "date",
5338-
"default": "2025-10-06T02:30:37.264Z"
5338+
"default": "2025-10-08T02:32:04.593Z"
53395339
}
53405340
},
53415341
{
@@ -5345,7 +5345,7 @@ This endpoint will return data within a 6-hour timeframe. If the `from` and `to`
53455345
"schema": {
53465346
"type": "string",
53475347
"format": "date",
5348-
"default": "2025-10-07T02:30:37.265Z"
5348+
"default": "2025-10-09T02:32:04.594Z"
53495349
}
53505350
}
53515351
],
@@ -5441,7 +5441,7 @@ This endpoint will return data within a 6-hour timeframe. If the `from` and `to`
54415441
"schema": {
54425442
"type": "string",
54435443
"format": "date",
5444-
"default": "2025-10-06T02:30:37.266Z"
5444+
"default": "2025-10-08T02:32:04.596Z"
54455445
}
54465446
},
54475447
{
@@ -5451,7 +5451,7 @@ This endpoint will return data within a 6-hour timeframe. If the `from` and `to`
54515451
"schema": {
54525452
"type": "string",
54535453
"format": "date",
5454-
"default": "2025-10-07T02:30:37.266Z"
5454+
"default": "2025-10-09T02:32:04.597Z"
54555455
}
54565456
},
54575457
{
@@ -19435,7 +19435,6 @@ For example, set **Authorization** header while using cURL: `curl -H \"Authoriza
1943519435
"enum": [
1943619436
"API",
1943719437
"BROWSER",
19438-
"HEARTBEAT",
1943919438
"MULTI_STEP",
1944019439
"TCP",
1944119440
"PLAYWRIGHT",
@@ -19540,14 +19539,14 @@ For example, set **Authorization** header while using cURL: `curl -H \"Authoriza
1954019539
},
1954119540
"sessions": {
1954219541
"type": "array",
19543-
"description": "The list of checks in the check session.",
19542+
"description": "A list of check sessions, with one check session for each check.",
1954419543
"items": {
1954519544
"$ref": "#/components/schemas/CheckSession"
1954619545
}
1954719546
},
1954819547
"TriggerCheckSessionResponse": {
1954919548
"type": "object",
19550-
"description": "Returns the check sessions that were created for the checks.",
19549+
"description": "Returns a check session for each check matching target conditions.",
1955119550
"properties": {
1955219551
"sessions": {
1955319552
"$ref": "#/components/schemas/sessions"
@@ -19586,7 +19585,6 @@ For example, set **Authorization** header while using cURL: `curl -H \"Authoriza
1958619585
"enum": [
1958719586
"API",
1958819587
"BROWSER",
19589-
"HEARTBEAT",
1959019588
"MULTI_STEP",
1959119589
"TCP",
1959219590
"PLAYWRIGHT",
@@ -19615,7 +19613,6 @@ For example, set **Authorization** header while using cURL: `curl -H \"Authoriza
1961519613
"enum": [
1961619614
"API",
1961719615
"BROWSER",
19618-
"HEARTBEAT",
1961919616
"MULTI_STEP",
1962019617
"TCP",
1962119618
"PLAYWRIGHT",
@@ -19711,7 +19708,7 @@ For example, set **Authorization** header while using cURL: `curl -H \"Authoriza
1971119708
},
1971219709
"results": {
1971319710
"type": "array",
19714-
"description": "THe results of the check session. Only partial results are available until the check session has completed.",
19711+
"description": "The results of the check session. Only partial results are available until the check session has completed.",
1971519712
"items": {
1971619713
"$ref": "#/components/schemas/CheckSessionConciseCheckResult"
1971719714
}
@@ -19818,7 +19815,6 @@ For example, set **Authorization** header while using cURL: `curl -H \"Authoriza
1981819815
"enum": [
1981919816
"API",
1982019817
"BROWSER",
19821-
"HEARTBEAT",
1982219818
"MULTI_STEP",
1982319819
"TCP",
1982419820
"PLAYWRIGHT",
@@ -27410,7 +27406,7 @@ For example, set **Authorization** header while using cURL: `curl -H \"Authoriza
2741027406
"publicIncidentUpdateDate": {
2741127407
"type": "string",
2741227408
"format": "date-time",
27413-
"default": "2025-10-07T02:30:37.858Z"
27409+
"default": "2025-10-09T02:32:05.521Z"
2741427410
},
2741527411
"notifySubscribers": {
2741627412
"type": "boolean",
@@ -27900,7 +27896,7 @@ For example, set **Authorization** header while using cURL: `curl -H \"Authoriza
2790027896
"publicIncidentUpdateDate": {
2790127897
"type": "string",
2790227898
"format": "date-time",
27903-
"default": "2025-10-07T02:30:37.899Z"
27899+
"default": "2025-10-09T02:32:05.582Z"
2790427900
},
2790527901
"created_at": {
2790627902
"type": "string",

0 commit comments

Comments
 (0)