---
title: "Creates a new check."
method: POST
path: "/checks"
tags: ["Checks"]
---

# Creates a new check.

`POST /checks`

Creates a new check with settings specified by provided parameters.

## Request body

- union
  - object
    - `url` string — Path to target on server
    - `encryption` boolean — Connection encryption
    - `port` integer — Target port
    - `shouldcontain` string — Target site should contain this string. Note! This parameter cannot be used together with the parameter “shouldnotcontain”, use only one of them in your request.
    - `shouldnotcontain` string — Target site should NOT contain this string. Note! This parameter cannot be used together with the parameter “shouldcontain”, use only one of them in your request.
    - `postdata` string — Data that should be posted to the web page, for example submission data for a sign-up or login form. The data needs to be formatted in the same way as a web browser would send it to the web server
    - `requestheaders` string[] — Custom HTTP header. The entry value should contain a one-element string array. The element should contain `headerName` and `headerValue` colon-separated. To add more than one header send other parameters named `requestheaders{number}`.
    - `verify_certificate` boolean — Treat target site as down if an invalid/unverifiable certificate is found.
    - `ssl_down_days_before` integer — Treat the target site as down if a certificate expires within the given number of days. This parameter will be ignored if `verify_certificate` is set to `false`. It will appear provided `verify_certificate` is true and `ssl_down_days_before` value is greater than or equals 1.
    - `auth` string — Username and password, colon separated.
    - `name` string, required — Check name
    - `host` string, required — Target host
    - `type` 'http' | 'httpcustom' | 'tcp' | 'ping' | 'dns' | 'udp' | 'smtp' | 'pop3' | 'imap', required — Type of check
    - `paused` boolean
    - `resolution` 1 | 5 | 15 | 30 | 60 — How often should the check be tested? (minutes)
    - `userids` string — User identifiers. For example userids=154325,465231,765871
    - `sendnotificationwhendown` integer — Send notification when down X times
    - `notifyagainevery` integer — Notify again every n result. 0 means that no extra notifications will be sent.
    - `notifywhenbackup` boolean — Notify when back up again
    - `tags` string[] — List of tags for check. The maximum length of a tag is 64 characters.
    - `probe_filters` string[] — Filters used for probe selections. Overwrites previous filters for check. To remove all filters from a check, use an empty value. Comma separated key:value pairs. Currently only region is supported. Possible values are 'EU', 'NA', 'APAC' and 'LATAM'. For example, "region: NA".
    - `ipv6` boolean — Use ipv6 instead of ipv4, if an IP address is provided as host this will be overrided by the IP address version
    - `responsetime_threshold` integer — Triggers a down alert if the response time exceeds threshold specified in ms (Not available for Starter and Free plans.)
    - `integrationids` integer[] — Integration identifiers. For example integrationids:[1,2,3].
    - `teamids` string — Teams to alert. Comma separated Integers.
    - `custom_message` string — Custom message that will be added to email and webhook alerts.
  - object
    - `verify_certificate` boolean — Treat target site as down if an invalid/unverifiable certificate is found.
    - `ssl_down_days_before` integer — Treat the target site as down if a certificate expires within the given number of days. This parameter will be ignored if `verify_certificate` is set to `false`.
    - `url` string, required — Path to target on server
    - `encryption` boolean — Connection encryption
    - `port` integer — Target port
    - `additionalurls` string — Full URL (including hostname) to target additional XML file
    - `name` string, required — Check name
    - `host` string, required — Target host
    - `type` 'http' | 'httpcustom' | 'tcp' | 'ping' | 'dns' | 'udp' | 'smtp' | 'pop3' | 'imap', required — Type of check
    - `paused` boolean
    - `resolution` 1 | 5 | 15 | 30 | 60 — How often should the check be tested? (minutes)
    - `userids` string — User identifiers. For example userids=154325,465231,765871
    - `sendnotificationwhendown` integer — Send notification when down X times
    - `notifyagainevery` integer — Notify again every n result. 0 means that no extra notifications will be sent.
    - `notifywhenbackup` boolean — Notify when back up again
    - `tags` string[] — List of tags for check. The maximum length of a tag is 64 characters.
    - `probe_filters` string[] — Filters used for probe selections. Overwrites previous filters for check. To remove all filters from a check, use an empty value. Comma separated key:value pairs. Currently only region is supported. Possible values are 'EU', 'NA', 'APAC' and 'LATAM'. For example, "region: NA".
    - `ipv6` boolean — Use ipv6 instead of ipv4, if an IP address is provided as host this will be overrided by the IP address version
    - `responsetime_threshold` integer — Triggers a down alert if the response time exceeds threshold specified in ms (Not available for Starter and Free plans.)
    - `integrationids` integer[] — Integration identifiers. For example integrationids:[1,2,3].
    - `teamids` string — Teams to alert. Comma separated Integers.
    - `custom_message` string — Custom message that will be added to email and webhook alerts.
  - object
    - `port` integer, required — Target port
    - `stringtosend` string — String to send
    - `stringtoexpect` string — String to expect in response
    - `name` string, required — Check name
    - `host` string, required — Target host
    - `type` 'http' | 'httpcustom' | 'tcp' | 'ping' | 'dns' | 'udp' | 'smtp' | 'pop3' | 'imap', required — Type of check
    - `paused` boolean
    - `resolution` 1 | 5 | 15 | 30 | 60 — How often should the check be tested? (minutes)
    - `userids` string — User identifiers. For example userids=154325,465231,765871
    - `sendnotificationwhendown` integer — Send notification when down X times
    - `notifyagainevery` integer — Notify again every n result. 0 means that no extra notifications will be sent.
    - `notifywhenbackup` boolean — Notify when back up again
    - `tags` string[] — List of tags for check. The maximum length of a tag is 64 characters.
    - `probe_filters` string[] — Filters used for probe selections. Overwrites previous filters for check. To remove all filters from a check, use an empty value. Comma separated key:value pairs. Currently only region is supported. Possible values are 'EU', 'NA', 'APAC' and 'LATAM'. For example, "region: NA".
    - `ipv6` boolean — Use ipv6 instead of ipv4, if an IP address is provided as host this will be overrided by the IP address version
    - `responsetime_threshold` integer — Triggers a down alert if the response time exceeds threshold specified in ms (Not available for Starter and Free plans.)
    - `integrationids` integer[] — Integration identifiers. For example integrationids:[1,2,3].
    - `teamids` string — Teams to alert. Comma separated Integers.
    - `custom_message` string — Custom message that will be added to email and webhook alerts.
  - object
    - `nameserver` string, required — DNS server to use
    - `expectedip` string, required — Expected IP
    - `name` string, required — Check name
    - `host` string, required — Target host
    - `type` 'http' | 'httpcustom' | 'tcp' | 'ping' | 'dns' | 'udp' | 'smtp' | 'pop3' | 'imap', required — Type of check
    - `paused` boolean
    - `resolution` 1 | 5 | 15 | 30 | 60 — How often should the check be tested? (minutes)
    - `userids` string — User identifiers. For example userids=154325,465231,765871
    - `sendnotificationwhendown` integer — Send notification when down X times
    - `notifyagainevery` integer — Notify again every n result. 0 means that no extra notifications will be sent.
    - `notifywhenbackup` boolean — Notify when back up again
    - `tags` string[] — List of tags for check. The maximum length of a tag is 64 characters.
    - `probe_filters` string[] — Filters used for probe selections. Overwrites previous filters for check. To remove all filters from a check, use an empty value. Comma separated key:value pairs. Currently only region is supported. Possible values are 'EU', 'NA', 'APAC' and 'LATAM'. For example, "region: NA".
    - `ipv6` boolean — Use ipv6 instead of ipv4, if an IP address is provided as host this will be overrided by the IP address version
    - `responsetime_threshold` integer — Triggers a down alert if the response time exceeds threshold specified in ms (Not available for Starter and Free plans.)
    - `integrationids` integer[] — Integration identifiers. For example integrationids:[1,2,3].
    - `teamids` string — Teams to alert. Comma separated Integers.
    - `custom_message` string — Custom message that will be added to email and webhook alerts.
  - object
    - `port` integer, required — Target port
    - `stringtosend` string, required — String to send
    - `stringtoexpect` string, required — String to expect in response
    - `name` string, required — Check name
    - `host` string, required — Target host
    - `type` 'http' | 'httpcustom' | 'tcp' | 'ping' | 'dns' | 'udp' | 'smtp' | 'pop3' | 'imap', required — Type of check
    - `paused` boolean
    - `resolution` 1 | 5 | 15 | 30 | 60 — How often should the check be tested? (minutes)
    - `userids` string — User identifiers. For example userids=154325,465231,765871
    - `sendnotificationwhendown` integer — Send notification when down X times
    - `notifyagainevery` integer — Notify again every n result. 0 means that no extra notifications will be sent.
    - `notifywhenbackup` boolean — Notify when back up again
    - `tags` string[] — List of tags for check. The maximum length of a tag is 64 characters.
    - `probe_filters` string[] — Filters used for probe selections. Overwrites previous filters for check. To remove all filters from a check, use an empty value. Comma separated key:value pairs. Currently only region is supported. Possible values are 'EU', 'NA', 'APAC' and 'LATAM'. For example, "region: NA".
    - `ipv6` boolean — Use ipv6 instead of ipv4, if an IP address is provided as host this will be overrided by the IP address version
    - `responsetime_threshold` integer — Triggers a down alert if the response time exceeds threshold specified in ms (Not available for Starter and Free plans.)
    - `integrationids` integer[] — Integration identifiers. For example integrationids:[1,2,3].
    - `teamids` string — Teams to alert. Comma separated Integers.
    - `custom_message` string — Custom message that will be added to email and webhook alerts.
  - object
    - `port` integer — Target port
    - `encryption` boolean — Connection encryption
    - `stringtoexpect` string — String to expect in response
    - `auth` string — Username and password colon separated for target SMTP authentication
    - `name` string, required — Check name
    - `host` string, required — Target host
    - `type` 'http' | 'httpcustom' | 'tcp' | 'ping' | 'dns' | 'udp' | 'smtp' | 'pop3' | 'imap', required — Type of check
    - `paused` boolean
    - `resolution` 1 | 5 | 15 | 30 | 60 — How often should the check be tested? (minutes)
    - `userids` string — User identifiers. For example userids=154325,465231,765871
    - `sendnotificationwhendown` integer — Send notification when down X times
    - `notifyagainevery` integer — Notify again every n result. 0 means that no extra notifications will be sent.
    - `notifywhenbackup` boolean — Notify when back up again
    - `tags` string[] — List of tags for check. The maximum length of a tag is 64 characters.
    - `probe_filters` string[] — Filters used for probe selections. Overwrites previous filters for check. To remove all filters from a check, use an empty value. Comma separated key:value pairs. Currently only region is supported. Possible values are 'EU', 'NA', 'APAC' and 'LATAM'. For example, "region: NA".
    - `ipv6` boolean — Use ipv6 instead of ipv4, if an IP address is provided as host this will be overrided by the IP address version
    - `responsetime_threshold` integer — Triggers a down alert if the response time exceeds threshold specified in ms (Not available for Starter and Free plans.)
    - `integrationids` integer[] — Integration identifiers. For example integrationids:[1,2,3].
    - `teamids` string — Teams to alert. Comma separated Integers.
    - `custom_message` string — Custom message that will be added to email and webhook alerts.
  - object
    - `port` integer — Target port
    - `stringtoexpect` string — String to expect in response
    - `name` string, required — Check name
    - `host` string, required — Target host
    - `type` 'http' | 'httpcustom' | 'tcp' | 'ping' | 'dns' | 'udp' | 'smtp' | 'pop3' | 'imap', required — Type of check
    - `paused` boolean
    - `resolution` 1 | 5 | 15 | 30 | 60 — How often should the check be tested? (minutes)
    - `userids` string — User identifiers. For example userids=154325,465231,765871
    - `sendnotificationwhendown` integer — Send notification when down X times
    - `notifyagainevery` integer — Notify again every n result. 0 means that no extra notifications will be sent.
    - `notifywhenbackup` boolean — Notify when back up again
    - `tags` string[] — List of tags for check. The maximum length of a tag is 64 characters.
    - `probe_filters` string[] — Filters used for probe selections. Overwrites previous filters for check. To remove all filters from a check, use an empty value. Comma separated key:value pairs. Currently only region is supported. Possible values are 'EU', 'NA', 'APAC' and 'LATAM'. For example, "region: NA".
    - `ipv6` boolean — Use ipv6 instead of ipv4, if an IP address is provided as host this will be overrided by the IP address version
    - `responsetime_threshold` integer — Triggers a down alert if the response time exceeds threshold specified in ms (Not available for Starter and Free plans.)
    - `integrationids` integer[] — Integration identifiers. For example integrationids:[1,2,3].
    - `teamids` string — Teams to alert. Comma separated Integers.
    - `custom_message` string — Custom message that will be added to email and webhook alerts.
  - object
    - `port` integer — Target port
    - `stringtoexpect` string — String to expect in response
    - `name` string, required — Check name
    - `host` string, required — Target host
    - `type` 'http' | 'httpcustom' | 'tcp' | 'ping' | 'dns' | 'udp' | 'smtp' | 'pop3' | 'imap', required — Type of check
    - `paused` boolean
    - `resolution` 1 | 5 | 15 | 30 | 60 — How often should the check be tested? (minutes)
    - `userids` string — User identifiers. For example userids=154325,465231,765871
    - `sendnotificationwhendown` integer — Send notification when down X times
    - `notifyagainevery` integer — Notify again every n result. 0 means that no extra notifications will be sent.
    - `notifywhenbackup` boolean — Notify when back up again
    - `tags` string[] — List of tags for check. The maximum length of a tag is 64 characters.
    - `probe_filters` string[] — Filters used for probe selections. Overwrites previous filters for check. To remove all filters from a check, use an empty value. Comma separated key:value pairs. Currently only region is supported. Possible values are 'EU', 'NA', 'APAC' and 'LATAM'. For example, "region: NA".
    - `ipv6` boolean — Use ipv6 instead of ipv4, if an IP address is provided as host this will be overrided by the IP address version
    - `responsetime_threshold` integer — Triggers a down alert if the response time exceeds threshold specified in ms (Not available for Starter and Free plans.)
    - `integrationids` integer[] — Integration identifiers. For example integrationids:[1,2,3].
    - `teamids` string — Teams to alert. Comma separated Integers.
    - `custom_message` string — Custom message that will be added to email and webhook alerts.

## Response `200`

Successful operation

- object
  - `check` object
    - `id` integer — Created check ID.
    - `name` string — Created check name.

---

[API](https://skmtc.net/pingdom/apis/pingdom-public-api.md) · [All operations](https://skmtc.net/pingdom/apis/pingdom-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pingdom/pingdom-public-api/revisions/d05c91a3c64b/schema)