NAV Navigation
curl

Checkly API V1 (beta)

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Checkly public API

Base URLs:

Authentication

The Checkly API uses API keys to authenticate requests. You can manage your API keys in the Checkly account settings. Your API key is like a password: keep it secure!

Authentication to the API is performed using the bearer auth method in the Authorization header.

For example, use -H "Authorization: Bearer " when using cURL.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Check results (rolled up)

Lists all rolled up check results

Code samples

curl -X GET https://api.checklyhq.com/v1/check-results-rolled-up/{checkId} \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

GET /v1/check-results-rolled-up/{checkId}

Lists the rolled up check results per hour for a specific check.

This means that one hour after a raw result for a check is recorded, it is also available in the rolled up results.

The result contains all discrete response times and aggregated counters for failing and successful check. Using this data you can reconstruct averages, percentiles and ratios, approximating the individual raw check results very closely.

You can filter by check type and result type to narrow down the list. Use the to and from parameters to specify a date range. Depending on the check type, some fields might be null.

Note that results from this endpoint start at roughly 2019-4-11, earlier results are not available.

Parameters

Name In Type Description
checkId
(required)
path string none
limit query number none
page query number none
location query string Provide a data center location, e.g. "eu-west-1" to filter by location
to query number Select results up to this UNIX timestamp date, i.e. < date
from query number Select results from this UNIX timestamp date, i.e. >= date

Example responses

200 Response

[
  {
    "checkId": "string",
    "runLocation": "string",
    "errorCount": 0,
    "failureCount": 0,
    "resultsCount": 0,
    "hour": "2019-08-22",
    "responseTimes": [
      "string"
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Successful RolledUpCheckResultsList
401 Unauthorized Unauthorized string
404 Not Found Not Found Model_1

Check results

Lists all check results

Code samples

curl -X GET https://api.checklyhq.com/v1/check-results/{checkId} \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

GET /v1/check-results/{checkId}

Lists the full, raw check results for a specific check. We keep raw results for 30 days. After 30 days they are erased. However we keep the rolled up results for an indefinite period.

You can filter by check type and result type to narrow down the list. Use the to and from parameters to specify a date range. Depending on the check type, some fields might be null.

Parameters

Name In Type Description
checkId
(required)
path string none
limit query number none
page query number none
location query string Provide a data center location, e.g. "eu-west-1" to filter by location
to query number Select results up to this UNIX timestamp date, i.e. < date
from query number Select results from this UNIX timestamp date, i.e. >= date
checkType query string The type of the check
hasFailures query boolean Check result has one or more failures

Enumerated Values

Parameter Value
checkType BROWSER
checkType API

Example responses

200 Response

[
  {
    "id": "string",
    "name": "string",
    "checkId": "string",
    "hasFailures": true,
    "hasErrors": true,
    "runLocation": "string",
    "startedAt": "2019-08-22",
    "stoppedAt": "2019-08-22",
    "created_at": "2019-08-22",
    "responseTime": 0,
    "apiCheckResult": {},
    "browserCheckResult": {},
    "checkRunId": 0,
    "attempts": 0
  }
]

Responses

Status Meaning Description Schema
200 OK Successful CheckResultsList
401 Unauthorized Unauthorized string

Retrieve a check result

Code samples

curl -X GET https://api.checklyhq.com/v1/check-results/{checkId}/{checkResultId} \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

GET /v1/check-results/{checkId}/{checkResultId}

Show details of a specific check result.

Parameters

Name In Type Description
checkId
(required)
path string none
checkResultId
(required)
path string none

Example responses

200 Response

{
  "id": "string",
  "name": "string",
  "checkId": "string",
  "hasFailures": true,
  "hasErrors": true,
  "runLocation": "string",
  "startedAt": "2019-08-22",
  "stoppedAt": "2019-08-22",
  "created_at": "2019-08-22",
  "responseTime": 0,
  "apiCheckResult": {},
  "browserCheckResult": {},
  "checkRunId": 0,
  "attempts": 0
}

Responses

Status Meaning Description Schema
200 OK Successful CheckResult
401 Unauthorized Unauthorized string
404 Not Found Not Found string

Check status

List all check statuses

Code samples

curl -X GET https://api.checklyhq.com/v1/check-statuses \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

GET /v1/check-statuses

Shows the current status information for all checks in your account. The check status records are continuously updatedas new check results come in.

Example responses

200 Response

[
  {
    "checkId": "string",
    "hasFailures": true,
    "hasErrors": true,
    "longestRun": 0,
    "shortestRun": 0,
    "lastRunLocation": "string",
    "lastCheckRunId": "string",
    "sslDaysRemaining": 0,
    "created_at": "2019-08-22",
    "updated_at": "2019-08-22"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful CheckStatusList
401 Unauthorized Unauthorized string
404 Not Found Not Found Model_2

Retrieve check status details

Code samples

curl -X GET https://api.checklyhq.com/v1/check-statuses/{checkId} \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

GET /v1/check-statuses/{checkId}

Show the current status information for a specific check.

Parameters

Name In Type Description
checkId
(required)
path string none

Example responses

200 Response

{
  "checkId": "string",
  "hasFailures": true,
  "hasErrors": true,
  "longestRun": 0,
  "shortestRun": 0,
  "lastRunLocation": "string",
  "lastCheckRunId": "string",
  "sslDaysRemaining": 0,
  "created_at": "2019-08-22",
  "updated_at": "2019-08-22"
}

Responses

Status Meaning Description Schema
200 OK Successful CheckStatus
401 Unauthorized Unauthorized string
404 Not Found Not Found Model_1

Checks

List all checks

Code samples

curl -X GET https://api.checklyhq.com/v1/checks \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

GET /v1/checks

Lists all current checks in your account.

Parameters

Name In Type Description
limit query number none
page query number none

Example responses

200 Response

[
  {
    "id": "string",
    "name": "string",
    "checkType": "BROWSER",
    "frequency": 5,
    "activated": true,
    "muted": false,
    "doubleCheck": true,
    "sslCheck": true,
    "sslCheckDomain": "string",
    "shouldFail": true,
    "locations": [
      "us-east-1"
    ],
    "request": {
      "method": "GET",
      "url": "localhost",
      "followRedirects": true,
      "body": "",
      "bodyType": "NONE",
      "headers": [],
      "queryParameters": [],
      "assertions": [],
      "basicAuth": {
        "username": "",
        "password": ""
      }
    },
    "script": "string",
    "environmentVariables": [
      {
        "key": "string",
        "value": "",
        "locked": false
      }
    ],
    "alertChannels": {
      "email": [
        {
          "address": ""
        }
      ],
      "webhook": [
        {
          "name": "",
          "url": ""
        }
      ],
      "slack": [
        {
          "url": ""
        }
      ],
      "sms": [
        {
          "number": "",
          "name": "string"
        }
      ]
    },
    "tags": [
      "string"
    ],
    "setupSnippetId": 0,
    "tearDownSnippetId": 0,
    "localSetupScript": "string",
    "localTearDownScript": "string",
    "alertSettings": {
      "escalationType": "RUN_BASED",
      "runBasedEscalation": {
        "failedRunThreshold": 1
      },
      "timeBasedEscalation": {
        "minutesFailingThreshold": 5
      },
      "reminders": {
        "amount": 0,
        "interval": 5
      },
      "sslCertificates": {
        "enabled": true,
        "alertThreshold": 30
      }
    },
    "useGlobalAlertSettings": true,
    "created_at": "2019-08-22",
    "updated_at": "2019-08-22"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful CheckList
401 Unauthorized Unauthorized string

Create a check

Code samples

curl -X POST https://api.checklyhq.com/v1/checks \
 -H 'Content-Type: application/json' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

POST /v1/checks

Creates a new API or browser check. Will return a 402 when you are over the limit of your plan. When using the globalAlertSetting, the alertSetting can be null

Body parameter

{
  "name": "string",
  "checkType": "BROWSER",
  "frequency": 5,
  "activated": true,
  "muted": false,
  "doubleCheck": true,
  "sslCheck": true,
  "sslCheckDomain": "string",
  "shouldFail": true,
  "locations": [
    "us-east-1"
  ],
  "request": {
    "method": "GET",
    "url": "localhost",
    "followRedirects": true,
    "body": "",
    "bodyType": "NONE",
    "headers": [],
    "queryParameters": [],
    "assertions": [],
    "basicAuth": {
      "username": "",
      "password": ""
    }
  },
  "script": "string",
  "environmentVariables": [
    {
      "key": "string",
      "value": "",
      "locked": false
    }
  ],
  "alertChannels": {},
  "tags": [
    "string"
  ],
  "setupSnippetId": 0,
  "tearDownSnippetId": 0,
  "localSetupScript": "string",
  "localTearDownScript": "string",
  "alertSettings": {
    "escalationType": "RUN_BASED",
    "runBasedEscalation": {
      "failedRunThreshold": 1
    },
    "timeBasedEscalation": {
      "minutesFailingThreshold": 5
    },
    "reminders": {
      "amount": 0,
      "interval": 5
    },
    "sslCertificates": {
      "enabled": true,
      "alertThreshold": 30
    }
  },
  "useGlobalAlertSettings": true
}

Parameters

Name In Type Description
body body CheckCreate none

Example responses

201 Response

{
  "id": "string",
  "name": "string",
  "checkType": "BROWSER",
  "frequency": 5,
  "activated": true,
  "muted": false,
  "doubleCheck": true,
  "sslCheck": true,
  "sslCheckDomain": "string",
  "shouldFail": true,
  "locations": [
    "us-east-1"
  ],
  "request": {
    "method": "GET",
    "url": "localhost",
    "followRedirects": true,
    "body": "",
    "bodyType": "NONE",
    "headers": [],
    "queryParameters": [],
    "assertions": [],
    "basicAuth": {
      "username": "",
      "password": ""
    }
  },
  "script": "string",
  "environmentVariables": [
    {
      "key": "string",
      "value": "",
      "locked": false
    }
  ],
  "alertChannels": {
    "email": [
      {
        "address": ""
      }
    ],
    "webhook": [
      {
        "name": "",
        "url": ""
      }
    ],
    "slack": [
      {
        "url": ""
      }
    ],
    "sms": [
      {
        "number": "",
        "name": "string"
      }
    ]
  },
  "tags": [
    "string"
  ],
  "setupSnippetId": 0,
  "tearDownSnippetId": 0,
  "localSetupScript": "string",
  "localTearDownScript": "string",
  "alertSettings": {
    "escalationType": "RUN_BASED",
    "runBasedEscalation": {
      "failedRunThreshold": 1
    },
    "timeBasedEscalation": {
      "minutesFailingThreshold": 5
    },
    "reminders": {
      "amount": 0,
      "interval": 5
    },
    "sslCertificates": {
      "enabled": true,
      "alertThreshold": 30
    }
  },
  "useGlobalAlertSettings": true,
  "created_at": "2019-08-22",
  "updated_at": "2019-08-22"
}

Responses

Status Meaning Description Schema
201 Created Created Check
401 Unauthorized Unauthorized string
402 Payment Required Payment Required string

Delete a check

Code samples

curl -X DELETE https://api.checklyhq.com/v1/checks/{id} \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

DELETE /v1/checks/{id}

Permanently removes a API or browser check and all its related status and results data.

Parameters

Name In Type Description
id
(required)
path string none

Example responses

204 Response

"string"

Responses

Status Meaning Description Schema
204 No Content No Content string
401 Unauthorized Unauthorized string

Retrieve a check

Code samples

curl -X GET https://api.checklyhq.com/v1/checks/{id} \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

GET /v1/checks/{id}

Show details of a specific API or browser check

Parameters

Name In Type Description
id
(required)
path string none

Example responses

200 Response

{
  "id": "string",
  "name": "string",
  "checkType": "BROWSER",
  "frequency": 5,
  "activated": true,
  "muted": false,
  "doubleCheck": true,
  "sslCheck": true,
  "sslCheckDomain": "string",
  "shouldFail": true,
  "locations": [
    "us-east-1"
  ],
  "request": {
    "method": "GET",
    "url": "localhost",
    "followRedirects": true,
    "body": "",
    "bodyType": "NONE",
    "headers": [],
    "queryParameters": [],
    "assertions": [],
    "basicAuth": {
      "username": "",
      "password": ""
    }
  },
  "script": "string",
  "environmentVariables": [
    {
      "key": "string",
      "value": "",
      "locked": false
    }
  ],
  "alertChannels": {
    "email": [
      {
        "address": ""
      }
    ],
    "webhook": [
      {
        "name": "",
        "url": ""
      }
    ],
    "slack": [
      {
        "url": ""
      }
    ],
    "sms": [
      {
        "number": "",
        "name": "string"
      }
    ]
  },
  "tags": [
    "string"
  ],
  "setupSnippetId": 0,
  "tearDownSnippetId": 0,
  "localSetupScript": "string",
  "localTearDownScript": "string",
  "alertSettings": {
    "escalationType": "RUN_BASED",
    "runBasedEscalation": {
      "failedRunThreshold": 1
    },
    "timeBasedEscalation": {
      "minutesFailingThreshold": 5
    },
    "reminders": {
      "amount": 0,
      "interval": 5
    },
    "sslCertificates": {
      "enabled": true,
      "alertThreshold": 30
    }
  },
  "useGlobalAlertSettings": true,
  "created_at": "2019-08-22",
  "updated_at": "2019-08-22"
}

Responses

Status Meaning Description Schema
200 OK Successful Check
401 Unauthorized Unauthorized string
404 Not Found Not Found Model_1

Update a check

Code samples

curl -X PUT https://api.checklyhq.com/v1/checks/{id} \
 -H 'Content-Type: application/json' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

PUT /v1/checks/{id}

Updates a new API or browser check.

Body parameter

{
  "name": "string",
  "checkType": "BROWSER",
  "frequency": 5,
  "activated": true,
  "muted": false,
  "doubleCheck": true,
  "sslCheck": true,
  "sslCheckDomain": "string",
  "shouldFail": true,
  "locations": [
    "us-east-1"
  ],
  "request": {
    "method": "GET",
    "url": "localhost",
    "followRedirects": true,
    "body": "",
    "bodyType": "NONE",
    "headers": [],
    "queryParameters": [],
    "assertions": [],
    "basicAuth": {
      "username": "",
      "password": ""
    }
  },
  "script": "string",
  "environmentVariables": [
    {
      "key": "string",
      "value": "",
      "locked": false
    }
  ],
  "alertChannels": {},
  "tags": [
    "string"
  ],
  "setupSnippetId": 0,
  "tearDownSnippetId": 0,
  "localSetupScript": "string",
  "localTearDownScript": "string",
  "alertSettings": {
    "escalationType": "RUN_BASED",
    "runBasedEscalation": {
      "failedRunThreshold": 1
    },
    "timeBasedEscalation": {
      "minutesFailingThreshold": 5
    },
    "reminders": {
      "amount": 0,
      "interval": 5
    },
    "sslCertificates": {
      "enabled": true,
      "alertThreshold": 30
    }
  },
  "useGlobalAlertSettings": true
}

Parameters

Name In Type Description
id
(required)
path string none
body body CheckCreate none

Example responses

200 Response

{
  "id": "string",
  "name": "string",
  "checkType": "BROWSER",
  "frequency": 5,
  "activated": true,
  "muted": false,
  "doubleCheck": true,
  "sslCheck": true,
  "sslCheckDomain": "string",
  "shouldFail": true,
  "locations": [
    "us-east-1"
  ],
  "request": {
    "method": "GET",
    "url": "localhost",
    "followRedirects": true,
    "body": "",
    "bodyType": "NONE",
    "headers": [],
    "queryParameters": [],
    "assertions": [],
    "basicAuth": {
      "username": "",
      "password": ""
    }
  },
  "script": "string",
  "environmentVariables": [
    {
      "key": "string",
      "value": "",
      "locked": false
    }
  ],
  "alertChannels": {
    "email": [
      {
        "address": ""
      }
    ],
    "webhook": [
      {
        "name": "",
        "url": ""
      }
    ],
    "slack": [
      {
        "url": ""
      }
    ],
    "sms": [
      {
        "number": "",
        "name": "string"
      }
    ]
  },
  "tags": [
    "string"
  ],
  "setupSnippetId": 0,
  "tearDownSnippetId": 0,
  "localSetupScript": "string",
  "localTearDownScript": "string",
  "alertSettings": {
    "escalationType": "RUN_BASED",
    "runBasedEscalation": {
      "failedRunThreshold": 1
    },
    "timeBasedEscalation": {
      "minutesFailingThreshold": 5
    },
    "reminders": {
      "amount": 0,
      "interval": 5
    },
    "sslCertificates": {
      "enabled": true,
      "alertThreshold": 30
    }
  },
  "useGlobalAlertSettings": true,
  "created_at": "2019-08-22",
  "updated_at": "2019-08-22"
}

Responses

Status Meaning Description Schema
200 OK Successful Check
401 Unauthorized Unauthorized string

Dashboards

List all dashboards

Code samples

curl -X GET https://api.checklyhq.com/v1/dashboards \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

GET /v1/dashboards

Lists all current dashboards in your account.

Parameters

Name In Type Description
limit query number none
page query number none

Example responses

200 Response

[
  {
    "customUrl": "string",
    "customDomain": "string",
    "logo": "string",
    "header": "string",
    "width": "FULL",
    "refreshRate": 60,
    "paginate": true,
    "paginationRate": 30,
    "tags": [
      "string"
    ],
    "hideTags": false,
    "dashboardId": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful DashboardsList
401 Unauthorized Unauthorized string

Create a dashboard

Code samples

curl -X POST https://api.checklyhq.com/v1/dashboards \
 -H 'Content-Type: application/json' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

POST /v1/dashboards

Creates a new dashboard. Will return a 409 when attempting to create a dashboard with a custom URL or custom domain that is already taken.

Body parameter

{
  "customUrl": "string",
  "customDomain": "string",
  "logo": "string",
  "header": "string",
  "width": "FULL",
  "refreshRate": 60,
  "paginate": true,
  "paginationRate": 30,
  "tags": [
    "string"
  ],
  "hideTags": false
}

Parameters

Name In Type Description
body body DashboardSchema none

Example responses

201 Response

{
  "customUrl": "string",
  "customDomain": "string",
  "logo": "string",
  "header": "string",
  "width": "FULL",
  "refreshRate": 60,
  "paginate": true,
  "paginationRate": 30,
  "tags": [
    "string"
  ],
  "hideTags": false,
  "dashboardId": "string"
}

Responses

Status Meaning Description Schema
201 Created Created DashboardResponse
401 Unauthorized Unauthorized string
409 Conflict Conflict Model_1

Delete a dashboard

Code samples

curl -X DELETE https://api.checklyhq.com/v1/dashboards/{id} \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

DELETE /v1/dashboards/{id}

Permanently removes a dashboard.

Parameters

Name In Type Description
id
(required)
path string none

Example responses

204 Response

"string"

Responses

Status Meaning Description Schema
204 No Content No Content string
401 Unauthorized Unauthorized string

Retrieve a dashboard

Code samples

curl -X GET https://api.checklyhq.com/v1/dashboards/{id} \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

GET /v1/dashboards/{id}

Show details of a specific dashboard.

Parameters

Name In Type Description
id
(required)
path string none

Example responses

200 Response

{
  "customUrl": "string",
  "customDomain": "string",
  "logo": "string",
  "header": "string",
  "width": "FULL",
  "refreshRate": 60,
  "paginate": true,
  "paginationRate": 30,
  "tags": [
    "string"
  ],
  "hideTags": false,
  "dashboardId": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful DashboardResponse
401 Unauthorized Unauthorized string
404 Not Found Not Found Model_1

Update a dashboard

Code samples

curl -X PUT https://api.checklyhq.com/v1/dashboards/{id} \
 -H 'Content-Type: application/json' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

PUT /v1/dashboards/{id}

Updates a dashboard. Will return a 409 when attempting to create a dashboard with a custom URL or custom domain that is already taken.

Body parameter

{
  "customUrl": "string",
  "customDomain": "string",
  "logo": "string",
  "header": "string",
  "width": "FULL",
  "refreshRate": 60,
  "paginate": true,
  "paginationRate": 30,
  "tags": [
    "string"
  ],
  "hideTags": false
}

Parameters

Name In Type Description
id
(required)
path string none
body body DashboardSchema none

Example responses

200 Response

{
  "customUrl": "string",
  "customDomain": "string",
  "logo": "string",
  "header": "string",
  "width": "FULL",
  "refreshRate": 60,
  "paginate": true,
  "paginationRate": 30,
  "tags": [
    "string"
  ],
  "hideTags": false,
  "dashboardId": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful DashboardResponse
401 Unauthorized Unauthorized string
404 Not Found Not Found Model_1
409 Conflict Conflict Model_1

Snippets

List all snippets

Code samples

curl -X GET https://api.checklyhq.com/v1/snippets \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

GET /v1/snippets

Lists all current snippets in your account.

Parameters

Name In Type Description
limit query number none
page query number none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "script": "string",
    "created_at": "2019-08-22",
    "updated_at": "2019-08-22"
  }
]

Responses

Status Meaning Description Schema
200 OK Successful SnippetsList
401 Unauthorized Unauthorized string

Create a snippet

Code samples

curl -X POST https://api.checklyhq.com/v1/snippets \
 -H 'Content-Type: application/json' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

POST /v1/snippets

Creates a new snippet.

Body parameter

{
  "name": "string",
  "script": "string"
}

Parameters

Name In Type Description
body body SnippetCreate none

Example responses

201 Response

{
  "id": 0,
  "name": "string",
  "script": "string",
  "created_at": "2019-08-22",
  "updated_at": "2019-08-22"
}

Responses

Status Meaning Description Schema
201 Created Created Snippet
401 Unauthorized Unauthorized string

Delete a snippet

Code samples

curl -X DELETE https://api.checklyhq.com/v1/snippets/{id} \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

DELETE /v1/snippets/{id}

Permanently removes a snippet.

Parameters

Name In Type Description
id
(required)
path number none

Example responses

204 Response

"string"

Responses

Status Meaning Description Schema
204 No Content No Content string
401 Unauthorized Unauthorized string

Retrieve a snippet

Code samples

curl -X GET https://api.checklyhq.com/v1/snippets/{id} \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

GET /v1/snippets/{id}

Show details of a specific snippet.

Parameters

Name In Type Description
id
(required)
path number none

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "script": "string",
  "created_at": "2019-08-22",
  "updated_at": "2019-08-22"
}

Responses

Status Meaning Description Schema
200 OK Successful Snippet
401 Unauthorized Unauthorized string
404 Not Found Not Found Model_1

Update a snippet

Code samples

curl -X PUT https://api.checklyhq.com/v1/snippets/{id} \
 -H 'Content-Type: application/json' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

PUT /v1/snippets/{id}

Updates a snippet.

Body parameter

{
  "name": "string",
  "script": "string"
}

Parameters

Name In Type Description
id
(required)
path number none
body body SnippetCreate none

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "script": "string",
  "created_at": "2019-08-22",
  "updated_at": "2019-08-22"
}

Responses

Status Meaning Description Schema
200 OK Successful Snippet
401 Unauthorized Unauthorized string
404 Not Found Not Found Model_1

Environment variables

List all environment variables

Code samples

curl -X GET https://api.checklyhq.com/v1/variables \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

GET /v1/variables

Lists all current environment variables in your account.

Parameters

Name In Type Description
limit query number none
page query number none

Example responses

200 Response

[
  {
    "key": "string",
    "value": "",
    "locked": false
  }
]

Responses

Status Meaning Description Schema
200 OK Successful EnvironmentVariablesList
401 Unauthorized Unauthorized string

Create a environment variable

Code samples

curl -X POST https://api.checklyhq.com/v1/variables \
 -H 'Content-Type: application/json' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

POST /v1/variables

Creates a new environment variable.

Body parameter

{
  "key": "string",
  "value": "",
  "locked": false
}

Parameters

Name In Type Description
body body EnvironmentVariable none

Example responses

201 Response

{
  "key": "string",
  "value": "",
  "locked": false
}

Responses

Status Meaning Description Schema
201 Created Created EnvironmentVariable
401 Unauthorized Unauthorized string

Delete an environment variable

Code samples

curl -X DELETE https://api.checklyhq.com/v1/variables/{key} \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

DELETE /v1/variables/{key}

Permanently removes an environment variable. Uses the "key" field as the ID for deletion.

Parameters

Name In Type Description
key
(required)
path string none

Example responses

204 Response

"string"

Responses

Status Meaning Description Schema
204 No Content No Content string
401 Unauthorized Unauthorized string

Retrieve an environment variable

Code samples

curl -X GET https://api.checklyhq.com/v1/variables/{key} \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

GET /v1/variables/{key}

Show details of a specific environment variable. Uses the "key" field for selection.

Parameters

Name In Type Description
key
(required)
path string none

Example responses

200 Response

{
  "key": "string",
  "value": "",
  "locked": false
}

Responses

Status Meaning Description Schema
200 OK Successful EnvironmentVariable
401 Unauthorized Unauthorized string
404 Not Found Not Found Model_1

Update a environment variable

Code samples

curl -X PUT https://api.checklyhq.com/v1/variables/{key} \
 -H 'Content-Type: application/json' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer API_KEY'

PUT /v1/variables/{key}

Updates an environment variable. Uses the "key" field as the ID for updating. Only updates the value.

Body parameter

{
  "key": "string",
  "value": "",
  "locked": false
}

Parameters

Name In Type Description
key
(required)
path string none
body body EnvironmentVariable none

Example responses

200 Response

{
  "key": "string",
  "value": "",
  "locked": false
}

Responses

Status Meaning Description Schema
200 OK Successful EnvironmentVariable
401 Unauthorized Unauthorized string
404 Not Found Not Found Model_1

Schemas

responseTimes

[
  "string"
]

Properties

None

RolledUpCheckResult

{
  "checkId": "string",
  "runLocation": "string",
  "errorCount": 0,
  "failureCount": 0,
  "resultsCount": 0,
  "hour": "2019-08-22",
  "responseTimes": [
    "string"
  ]
}

Properties

Name Type Description
checkId string none
runLocation string What data center location this set of check results originated from
errorCount number The total amount of errored out check results for this hour. This value should be 0 in almost all cases as it records failures in the Checkly backend.
failureCount number The total amount of failed check results for this hour.
resultsCount number The total amount of results recorded for this hour. Depends on how often this check is scheduled to run.
hour string(date) All results per time unit / per location are rolled up to a specific hour
responseTimes responseTimes none

RolledUpCheckResultsList

[
  {
    "checkId": "string",
    "runLocation": "string",
    "errorCount": 0,
    "failureCount": 0,
    "resultsCount": 0,
    "hour": "2019-08-22",
    "responseTimes": [
      "string"
    ]
  }
]

Properties

Name Type Description
anonymous [RolledUpCheckResult] none

apiCheckResult

{}

Properties

None

browserCheckResult

{}

Properties

None

CheckResult

{
  "id": "string",
  "name": "string",
  "checkId": "string",
  "hasFailures": true,
  "hasErrors": true,
  "runLocation": "string",
  "startedAt": "2019-08-22",
  "stoppedAt": "2019-08-22",
  "created_at": "2019-08-22",
  "responseTime": 0,
  "apiCheckResult": {},
  "browserCheckResult": {},
  "checkRunId": 0,
  "attempts": 0
}

Properties

Name Type Description
id string The unique ID of this result
name string The name of the check
checkId string The ID of the check
hasFailures boolean Describes if any failure has occurred during this check run. This is should be your mainmain focus for assessing API or browser check behaviour. Assertions that fail, timeouts or failing scripts all resolve tothis value being true
hasErrors boolean Describes if an internal error has occured in Checkly's backend. This should be false in almost all cases.
runLocation string What data center location this check result originated from
startedAt string(date) none
stoppedAt string(date) none
created_at string(date) none
responseTime number Describes the time it took to execute relevant parts of this check. Any setup timeor system time needed to start executing this check in the Checkly backend is not part of this.
apiCheckResult apiCheckResult none
browserCheckResult browserCheckResult none
checkRunId number The id of the specific check run that created this check result
attempts number How often this check was retried. This will be larger than 0 when double checking is enabled

CheckResultsList

[
  {
    "id": "string",
    "name": "string",
    "checkId": "string",
    "hasFailures": true,
    "hasErrors": true,
    "runLocation": "string",
    "startedAt": "2019-08-22",
    "stoppedAt": "2019-08-22",
    "created_at": "2019-08-22",
    "responseTime": 0,
    "apiCheckResult": {},
    "browserCheckResult": {},
    "checkRunId": 0,
    "attempts": 0
  }
]

Properties

Name Type Description
anonymous [CheckResult] none

CheckStatus

{
  "checkId": "string",
  "hasFailures": true,
  "hasErrors": true,
  "longestRun": 0,
  "shortestRun": 0,
  "lastRunLocation": "string",
  "lastCheckRunId": "string",
  "sslDaysRemaining": 0,
  "created_at": "2019-08-22",
  "updated_at": "2019-08-22"
}

Properties

Name Type Description
checkId string The ID of check this status belongs to
hasFailures boolean Describes if this check is currently failing. If any of the assertions for an API checkfail this value is true. If a browser check fails for whatever reason, this is true
hasErrors boolean Describes if due to some error outside of normal operation this check is failing. This should be extremely rare and only when there is an error in the Checkly backend
longestRun number The longest ever recorded response time for this check
shortestRun number The shortest ever recorded response time for this check
lastRunLocation string What location this check was last run at
lastCheckRunId string The unique incrementing ID for each check run
sslDaysRemaining number How many days remain till the current SSL certifacte expires
created_at string(date) none
updated_at string(date) none

CheckStatusList

[
  {
    "checkId": "string",
    "hasFailures": true,
    "hasErrors": true,
    "longestRun": 0,
    "shortestRun": 0,
    "lastRunLocation": "string",
    "lastCheckRunId": "string",
    "sslDaysRemaining": 0,
    "created_at": "2019-08-22",
    "updated_at": "2019-08-22"
  }
]

Properties

Name Type Description
anonymous [CheckStatus] none

Locations

[
  "us-east-1"
]

An array of one or more data center locations where to run the this check

Properties

None

KeyValue

{
  "key": "string",
  "value": "",
  "locked": false
}

Properties

Name Type Description
key
(required)
string none
value
(required)
string none
locked boolean none

Headers

[]

Properties

Name Type Description
anonymous [KeyValue] none

QueryParameters

[]

Properties

Name Type Description
anonymous [KeyValue] none

Assertions

{
  "source": "STATUS_CODE",
  "property": "",
  "comparison": "EQUALS",
  "target": ""
}

Properties

Name Type Description
source string none
property string none
comparison string none
target string none

Enumerated Values

Property Value
source STATUS_CODE
source JSON_BODY
source HEADERS
source TEXT_BODY
source RESPONSE_TIME
comparison EQUALS
comparison NOT_EQUALS
comparison HAS_KEY
comparison NOT_HAS_KEY
comparison HAS_VALUE
comparison NOT_HAS_VALUE
comparison IS_EMPTY
comparison NOT_EMPTY
comparison GREATER_THAN
comparison LESS_THAN
comparison CONTAINS
comparison NOT_CONTAINS

assertions

[]

Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the "property" field.

Properties

Name Type Description
anonymous [Assertions] Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the "property" field.

basicAuth

{
  "username": "",
  "password": ""
}

Properties

Name Type Description
username string none
password string none

Request

{
  "method": "GET",
  "url": "localhost",
  "followRedirects": true,
  "body": "",
  "bodyType": "NONE",
  "headers": [],
  "queryParameters": [],
  "assertions": [],
  "basicAuth": {
    "username": "",
    "password": ""
  }
}

Properties

Name Type Description
method
(required)
string none
url
(required)
string none
followRedirects boolean none
body string none
bodyType string none
headers Headers none
queryParameters QueryParameters none
assertions assertions Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the "property" field.
basicAuth basicAuth none

Enumerated Values

Property Value
method GET
method POST
method PUT
method HEAD
method DELETE
method PATCH
bodyType NONE
bodyType JSON
bodyType FORM
bodyType RAW
bodyType GRAPHQL

EnvironmentVariable

{
  "key": "string",
  "value": "",
  "locked": false
}

Properties

Name Type Description
key
(required)
string none
value
(required)
string none
locked boolean Used only in the UI to hide the value like a password

EnvironmentVariables

[
  {
    "key": "string",
    "value": "",
    "locked": false
  }
]

Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.

Properties

Name Type Description
anonymous [EnvironmentVariable] Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.

AlertEmail

{
  "address": ""
}

Properties

Name Type Description
address
(required)
string none

email

[
  {
    "address": ""
  }
]

Properties

Name Type Description
anonymous [AlertEmail] none

AlertWebhook

{
  "name": "",
  "url": ""
}

Properties

Name Type Description
name string none
url
(required)
string none

webhook

[
  {
    "name": "",
    "url": ""
  }
]

Properties

Name Type Description
anonymous [AlertWebhook] none

AlertSlack

{
  "url": ""
}

Properties

Name Type Description
url
(required)
string none

slack

[
  {
    "url": ""
  }
]

Properties

Name Type Description
anonymous [AlertSlack] none

AlertSms

{
  "number": "",
  "name": "string"
}

Properties

Name Type Description
number
(required)
string none
name
(required)
string none

sms

[
  {
    "number": "",
    "name": "string"
  }
]

Properties

Name Type Description
anonymous [AlertSms] none

AlertChannels

{
  "email": [
    {
      "address": ""
    }
  ],
  "webhook": [
    {
      "name": "",
      "url": ""
    }
  ],
  "slack": [
    {
      "url": ""
    }
  ],
  "sms": [
    {
      "number": "",
      "name": "string"
    }
  ]
}

Properties

Name Type Description
email email none
webhook webhook none
slack slack none
sms sms none

Tags

[
  "string"
]

Tags for organizing and filtering checks

Properties

None

runBasedEscalation

{
  "failedRunThreshold": 1
}

Properties

Name Type Description
failedRunThreshold number After how many failed consecutive check runs an alert notification should be send

Enumerated Values

Property Value
failedRunThreshold 1
failedRunThreshold 2
failedRunThreshold 3
failedRunThreshold 4
failedRunThreshold 5

timeBasedEscalation

{
  "minutesFailingThreshold": 5
}

Properties

Name Type Description
minutesFailingThreshold number After how many minutes after a check starts failing an alert should be send

Enumerated Values

Property Value
minutesFailingThreshold 5
minutesFailingThreshold 10
minutesFailingThreshold 15
minutesFailingThreshold 30

reminders

{
  "amount": 0,
  "interval": 5
}

Properties

Name Type Description
amount number How many reminders to send out after the initial alert notification
interval number At what interval the reminders should be send

Enumerated Values

Property Value
amount 0
amount 1
amount 2
amount 3
amount 4
amount 5
interval 5
interval 10
interval 15
interval 30

sslCertificates

{
  "enabled": true,
  "alertThreshold": 30
}

Properties

Name Type Description
enabled boolean Determines if alert notifications should be send for expiring SSL certificates
alertThreshold number At what moment in time to start alerting on SSL certificates

Enumerated Values

Property Value
alertThreshold 3
alertThreshold 7
alertThreshold 14
alertThreshold 30

AlertSettingsSchema

{
  "escalationType": "RUN_BASED",
  "runBasedEscalation": {
    "failedRunThreshold": 1
  },
  "timeBasedEscalation": {
    "minutesFailingThreshold": 5
  },
  "reminders": {
    "amount": 0,
    "interval": 5
  },
  "sslCertificates": {
    "enabled": true,
    "alertThreshold": 30
  }
}

Properties

Name Type Description
escalationType string Determines what type of escalation to use
runBasedEscalation runBasedEscalation none
timeBasedEscalation timeBasedEscalation none
reminders reminders none
sslCertificates sslCertificates none

Enumerated Values

Property Value
escalationType RUN_BASED
escalationType TIME_BASED

Check

{
  "id": "string",
  "name": "string",
  "checkType": "BROWSER",
  "frequency": 5,
  "activated": true,
  "muted": false,
  "doubleCheck": true,
  "sslCheck": true,
  "sslCheckDomain": "string",
  "shouldFail": true,
  "locations": [
    "us-east-1"
  ],
  "request": {
    "method": "GET",
    "url": "localhost",
    "followRedirects": true,
    "body": "",
    "bodyType": "NONE",
    "headers": [],
    "queryParameters": [],
    "assertions": [],
    "basicAuth": {
      "username": "",
      "password": ""
    }
  },
  "script": "string",
  "environmentVariables": [
    {
      "key": "string",
      "value": "",
      "locked": false
    }
  ],
  "alertChannels": {
    "email": [
      {
        "address": ""
      }
    ],
    "webhook": [
      {
        "name": "",
        "url": ""
      }
    ],
    "slack": [
      {
        "url": ""
      }
    ],
    "sms": [
      {
        "number": "",
        "name": "string"
      }
    ]
  },
  "tags": [
    "string"
  ],
  "setupSnippetId": 0,
  "tearDownSnippetId": 0,
  "localSetupScript": "string",
  "localTearDownScript": "string",
  "alertSettings": {
    "escalationType": "RUN_BASED",
    "runBasedEscalation": {
      "failedRunThreshold": 1
    },
    "timeBasedEscalation": {
      "minutesFailingThreshold": 5
    },
    "reminders": {
      "amount": 0,
      "interval": 5
    },
    "sslCertificates": {
      "enabled": true,
      "alertThreshold": 30
    }
  },
  "useGlobalAlertSettings": true,
  "created_at": "2019-08-22",
  "updated_at": "2019-08-22"
}

Properties

Name Type Description
id string none
name string The name of the check
checkType
(required)
string The type of the check
frequency number none
activated boolean Determines if the check is running or not
muted boolean Determines if any notifications will be send out when a check fails and/or recovers
doubleCheck boolean Setting this to "true" will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed
sslCheck boolean Determines if the SSL certificate should be validated for expiry
sslCheckDomain string Provides the domain for the SSLCheck option
shouldFail boolean Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404
locations Locations An array of one or more data center locations where to run the this check
request Request none
script string A valid piece of Node.js javascript code describing a browser interaction with the Puppeteer framework.
environmentVariables EnvironmentVariables Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.
alertChannels AlertChannels none
tags Tags Tags for organizing and filtering checks
setupSnippetId number An ID reference to a snippet to use in the setup phase of an API check
tearDownSnippetId number An ID reference to a snippet to use in the teardown phase of an API check
localSetupScript string A valid piece of Node.js code to run in the setup phase
localTearDownScript string A valid piece of Node.js code to run in the teardown phase
alertSettings AlertSettingsSchema none
useGlobalAlertSettings boolean When true, the account level alert setting will be used, not the alert setting defined on this check
created_at string(date) none
updated_at string(date) none

Enumerated Values

Property Value
checkType BROWSER
checkType API
frequency 5
frequency 10
frequency 15
frequency 30
frequency 60
frequency 720
frequency 1440

CheckList

[
  {
    "id": "string",
    "name": "string",
    "checkType": "BROWSER",
    "frequency": 5,
    "activated": true,
    "muted": false,
    "doubleCheck": true,
    "sslCheck": true,
    "sslCheckDomain": "string",
    "shouldFail": true,
    "locations": [
      "us-east-1"
    ],
    "request": {
      "method": "GET",
      "url": "localhost",
      "followRedirects": true,
      "body": "",
      "bodyType": "NONE",
      "headers": [],
      "queryParameters": [],
      "assertions": [],
      "basicAuth": {
        "username": "",
        "password": ""
      }
    },
    "script": "string",
    "environmentVariables": [
      {
        "key": "string",
        "value": "",
        "locked": false
      }
    ],
    "alertChannels": {
      "email": [
        {
          "address": ""
        }
      ],
      "webhook": [
        {
          "name": "",
          "url": ""
        }
      ],
      "slack": [
        {
          "url": ""
        }
      ],
      "sms": [
        {
          "number": "",
          "name": "string"
        }
      ]
    },
    "tags": [
      "string"
    ],
    "setupSnippetId": 0,
    "tearDownSnippetId": 0,
    "localSetupScript": "string",
    "localTearDownScript": "string",
    "alertSettings": {
      "escalationType": "RUN_BASED",
      "runBasedEscalation": {
        "failedRunThreshold": 1
      },
      "timeBasedEscalation": {
        "minutesFailingThreshold": 5
      },
      "reminders": {
        "amount": 0,
        "interval": 5
      },
      "sslCertificates": {
        "enabled": true,
        "alertThreshold": 30
      }
    },
    "useGlobalAlertSettings": true,
    "created_at": "2019-08-22",
    "updated_at": "2019-08-22"
  }
]

Properties

Name Type Description
anonymous [Check] none

CheckCreate

{
  "name": "string",
  "checkType": "BROWSER",
  "frequency": 5,
  "activated": true,
  "muted": false,
  "doubleCheck": true,
  "sslCheck": true,
  "sslCheckDomain": "string",
  "shouldFail": true,
  "locations": [
    "us-east-1"
  ],
  "request": {
    "method": "GET",
    "url": "localhost",
    "followRedirects": true,
    "body": "",
    "bodyType": "NONE",
    "headers": [],
    "queryParameters": [],
    "assertions": [],
    "basicAuth": {
      "username": "",
      "password": ""
    }
  },
  "script": "string",
  "environmentVariables": [
    {
      "key": "string",
      "value": "",
      "locked": false
    }
  ],
  "alertChannels": {},
  "tags": [
    "string"
  ],
  "setupSnippetId": 0,
  "tearDownSnippetId": 0,
  "localSetupScript": "string",
  "localTearDownScript": "string",
  "alertSettings": {
    "escalationType": "RUN_BASED",
    "runBasedEscalation": {
      "failedRunThreshold": 1
    },
    "timeBasedEscalation": {
      "minutesFailingThreshold": 5
    },
    "reminders": {
      "amount": 0,
      "interval": 5
    },
    "sslCertificates": {
      "enabled": true,
      "alertThreshold": 30
    }
  },
  "useGlobalAlertSettings": true
}

Properties

Name Type Description
name
(required)
string The name of the check
checkType
(required)
string The type of the check
frequency number none
activated
(required)
boolean Determines if the check is running or not
muted boolean Determines if any notifications will be send out when a check fails and/or recovers
doubleCheck boolean Setting this to "true" will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed
sslCheck boolean Determines if the SSL certificate should be validated for expiry
sslCheckDomain string Provides the domain for the SSLCheck option
shouldFail boolean Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404
locations Locations An array of one or more data center locations where to run the this check
request Request none
script string A valid piece of Node.js javascript code describing a browser interaction with the Puppeteer framework.
environmentVariables EnvironmentVariables Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.
alertChannels Model_3 none
tags Tags Tags for organizing and filtering checks
setupSnippetId number An ID reference to a snippet to use in the setup phase of an API check
tearDownSnippetId number An ID reference to a snippet to use in the teardown phase of an API check
localSetupScript string A valid piece of Node.js code to run in the setup phase
localTearDownScript string A valid piece of Node.js code to run in the teardown phase
alertSettings AlertSettingsSchema none
useGlobalAlertSettings boolean When true, the account level alert setting will be used, not the alert setting defined on this check

Enumerated Values

Property Value
checkType BROWSER
checkType API
frequency 5
frequency 10
frequency 15
frequency 30
frequency 60
frequency 720
frequency 1440

tags

[
  "string"
]

A list of one or more tags that filter which checks to display on the dashboard.

Properties

None

DashboardResponse

{
  "customUrl": "string",
  "customDomain": "string",
  "logo": "string",
  "header": "string",
  "width": "FULL",
  "refreshRate": 60,
  "paginate": true,
  "paginationRate": 30,
  "tags": [
    "string"
  ],
  "hideTags": false,
  "dashboardId": "string"
}

Properties

Name Type Description
customUrl
(required)
string A subdomain name under "checklyhq.com". Needs to be unique across all users.
customDomain
(required)
string A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
logo
(required)
string A URL pointing to an image file.
header
(required)
string A piece of text displayed at the top of your dashboard.
width string Determines whether to use the full screen or focus in the center.
refreshRate
(required)
number How often to refresh the dashboard in seconds.
paginate
(required)
boolean Determines of pagination is on or off.
paginationRate
(required)
number How often to trigger pagination in seconds.
tags tags A list of one or more tags that filter which checks to display on the dashboard.
hideTags
(required)
boolean Show or hide the tags on the dashboard.
dashboardId
(required)
string none

Enumerated Values

Property Value
width FULL
width 960PX
refreshRate 60
refreshRate 300
refreshRate 600
paginationRate 30
paginationRate 60
paginationRate 300

DashboardsList

[
  {
    "customUrl": "string",
    "customDomain": "string",
    "logo": "string",
    "header": "string",
    "width": "FULL",
    "refreshRate": 60,
    "paginate": true,
    "paginationRate": 30,
    "tags": [
      "string"
    ],
    "hideTags": false,
    "dashboardId": "string"
  }
]

Properties

Name Type Description
anonymous [DashboardResponse] none

DashboardSchema

{
  "customUrl": "string",
  "customDomain": "string",
  "logo": "string",
  "header": "string",
  "width": "FULL",
  "refreshRate": 60,
  "paginate": true,
  "paginationRate": 30,
  "tags": [
    "string"
  ],
  "hideTags": false
}

Properties

Name Type Description
customUrl
(required)
string A subdomain name under "checklyhq.com". Needs to be unique across all users.
customDomain
(required)
string A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
logo
(required)
string A URL pointing to an image file.
header
(required)
string A piece of text displayed at the top of your dashboard.
width string Determines whether to use the full screen or focus in the center.
refreshRate
(required)
number How often to refresh the dashboard in seconds.
paginate
(required)
boolean Determines of pagination is on or off.
paginationRate
(required)
number How often to trigger pagination in seconds.
tags tags A list of one or more tags that filter which checks to display on the dashboard.
hideTags
(required)
boolean Show or hide the tags on the dashboard.

Enumerated Values

Property Value
width FULL
width 960PX
refreshRate 60
refreshRate 300
refreshRate 600
paginationRate 30
paginationRate 60
paginationRate 300

Snippet

{
  "id": 0,
  "name": "string",
  "script": "string",
  "created_at": "2019-08-22",
  "updated_at": "2019-08-22"
}

Properties

Name Type Description
id number none
name string The snippet name
script string Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.
created_at string(date) none
updated_at string(date) none

SnippetsList

[
  {
    "id": 0,
    "name": "string",
    "script": "string",
    "created_at": "2019-08-22",
    "updated_at": "2019-08-22"
  }
]

Properties

Name Type Description
anonymous [Snippet] none

SnippetCreate

{
  "name": "string",
  "script": "string"
}

Properties

Name Type Description
name
(required)
string The snippet name
script
(required)
string Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.

EnvironmentVariablesList

[
  {
    "key": "string",
    "value": "",
    "locked": false
  }
]

Properties

Name Type Description
anonymous [EnvironmentVariable] none

Model_1

{}

Properties

None

Model_2

[
  "string"
]

Properties

None

Model_3

{}

Properties

Name Type Description
email email none
webhook webhook none
slack slack none
sms sms none

schema1

{
  "key": "string",
  "value": "",
  "locked": false
}

Properties

Name Type Description
key
(required)
string none
value
(required)
string none
locked boolean none

schema2

{
  "source": "STATUS_CODE",
  "property": "",
  "comparison": "EQUALS",
  "target": ""
}

Properties

Name Type Description
source string none
property string none
comparison string none
target string none

Enumerated Values

Property Value
source STATUS_CODE
source JSON_BODY
source HEADERS
source TEXT_BODY
source RESPONSE_TIME
comparison EQUALS
comparison NOT_EQUALS
comparison HAS_KEY
comparison NOT_HAS_KEY
comparison HAS_VALUE
comparison NOT_HAS_VALUE
comparison IS_EMPTY
comparison NOT_EMPTY
comparison GREATER_THAN
comparison LESS_THAN
comparison CONTAINS
comparison NOT_CONTAINS

schema3

[]

Properties

Name Type Description
anonymous [schema1] none

schema4

[]

Properties

Name Type Description
anonymous [schema1] none

schema5

[]

Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the "property" field.

Properties

Name Type Description
anonymous [schema2] Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the "property" field.

schema6

{
  "username": "",
  "password": ""
}

Properties

Name Type Description
username string none
password string none

schema7

{
  "method": "GET",
  "url": "localhost",
  "followRedirects": true,
  "body": "",
  "bodyType": "NONE",
  "headers": [],
  "queryParameters": [],
  "assertions": [],
  "basicAuth": {
    "username": "",
    "password": ""
  }
}

Properties

Name Type Description
method
(required)
string none
url
(required)
string none
followRedirects boolean none
body string none
bodyType string none
headers schema3 none
queryParameters schema4 none
assertions schema5 Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the "property" field.
basicAuth schema6 none

Enumerated Values

Property Value
method GET
method POST
method PUT
method HEAD
method DELETE
method PATCH
bodyType NONE
bodyType JSON
bodyType FORM
bodyType RAW
bodyType GRAPHQL

schema8

{}

Properties

None