POST /v2/uptime/checks

To create an Uptime check, send a POST request to /v2/uptime/checks specifying the attributes in the table below in the JSON body.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
name String Yes

A human-friendly display name.

target String Yes

The endpoint to perform healthchecks on.

regions[] Array Yes

An array containing the selected regions to perform healthchecks from.

type String Yes

The type of health check to perform.

Possible values:

  • "http"
  • "https"
  • "ping"
enabled Boolean Yes

A boolean value indicating whether the check is enabled/disabled.

Default value: true

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.