Skip to main content
POST
Create a synthetic check

Authorizations

Authorization
string
header
required

A workspace API key, created in Superlog under Settings → API keys.

Body

application/json
name
string
required
Maximum string length: 200
url
string
required

The full HTTP or HTTPS URL to request.

Maximum string length: 2048
assertions
object[]

Checks on the response. Without any, a run passes when the request completes.

Maximum array length: 20
body
string | null

The request body. Not for GET or HEAD.

Maximum string length: 65536
enabled
boolean

A disabled check does not run.

failuresToAlert
integer

Failed runs in a row before the check posts to Slack.

Required range: 1 <= x <= 10
followRedirects
boolean
headers
object[]

Request headers. The list replaces the saved headers.

Maximum array length: 30
intervalSeconds
integer

How often the check runs: one of 60, 300, 900, 1800, 3600 seconds.

method
enum<string>
Available options:
GET,
HEAD,
POST,
PUT,
PATCH,
DELETE,
OPTIONS
retries
integer

Immediate retries before a run counts as failed.

Required range: 0 <= x <= 2
slack
object | null

Where failures and recoveries are posted. Without a channel the check only records its runs.

timeoutMs
integer
Required range: 1000 <= x <= 30000

Response

Created

check
object
required