---
title: "Returns a detailed description of a check."
method: GET
path: "/checks/{checkid}"
tags: ["Checks"]
---

# Returns a detailed description of a check.

`GET /checks/{checkid}`

Returns a detailed description of a specified check.

## Path parameters

- `checkid` integer, required

## Query parameters

- `include_teams` boolean

## Response `200`

Successful operation

- union
  - DetailedCheckHttp
    - `check` object
      - `type` object
        - `http` HttpAttributesGet
          - `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.
      - `probe_filters` string[] — Filters used for probe selections
      - `sendnotificationwhendown` integer
      - `notifyagainevery` integer
      - `notifywhenbackup` boolean
      - `responsetime_threshold` boolean
      - `custom_message` string
      - `integrationids` integer[]
      - `id` integer
      - `name` string
      - `lasterrortime` integer — Timestamp of last error (if any). Format is UNIX timestamp
      - `lasttesttime` integer — Timestamp of last test (if any). Format is UNIX timestamp
      - `lastresponsetime` integer — Response time (in milliseconds) of last test.
      - `lastdownstart` integer — Timestamp of start of last check down (if any). Format is UNIX timestamp.
      - `lastdownend` integer — Timestamp of end of last check down (if any). Format is UNIX timestamp. During a downtime it will be lasttesttime.
      - `status` 'up' | 'down' | 'unconfirmed_down' | 'unknown' | 'paused'
      - `resolution` integer — How often should the check be tested? (minutes)
      - `hostname` string — Target host
      - `created` integer — Creating time. Format is UNIX timestamp
      - `tags` Tag[] — List of tags for check
        - `name` string
        - `type` string
        - `count` integer
      - `ipv6` boolean — Use ipv6 instead of ipv4
  - DetailedCheckHttpCustom
    - `check` object
      - `type` object
        - `httpcustom` HttpCustomAttributes
          - `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`.
      - `probe_filters` string[] — Filters used for probe selections
      - `sendnotificationwhendown` integer
      - `notifyagainevery` integer
      - `notifywhenbackup` boolean
      - `responsetime_threshold` boolean
      - `custom_message` string
      - `integrationids` integer[]
      - `id` integer
      - `name` string
      - `lasterrortime` integer — Timestamp of last error (if any). Format is UNIX timestamp
      - `lasttesttime` integer — Timestamp of last test (if any). Format is UNIX timestamp
      - `lastresponsetime` integer — Response time (in milliseconds) of last test.
      - `lastdownstart` integer — Timestamp of start of last check down (if any). Format is UNIX timestamp.
      - `lastdownend` integer — Timestamp of end of last check down (if any). Format is UNIX timestamp. During a downtime it will be lasttesttime.
      - `status` 'up' | 'down' | 'unconfirmed_down' | 'unknown' | 'paused'
      - `resolution` integer — How often should the check be tested? (minutes)
      - `hostname` string — Target host
      - `created` integer — Creating time. Format is UNIX timestamp
      - `tags` Tag[] — List of tags for check
        - `name` string
        - `type` string
        - `count` integer
      - `ipv6` boolean — Use ipv6 instead of ipv4
      - `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`.
  - DetailedCheckTcp
    - `check` object
      - `type` object
        - `tcp` TcpAttributes
          - `port` integer, required — Target port
          - `stringtosend` string — String to send
          - `stringtoexpect` string — String to expect in response
      - `probe_filters` string[] — Filters used for probe selections
      - `sendnotificationwhendown` integer
      - `notifyagainevery` integer
      - `notifywhenbackup` boolean
      - `responsetime_threshold` boolean
      - `custom_message` string
      - `integrationids` integer[]
      - `id` integer
      - `name` string
      - `lasterrortime` integer — Timestamp of last error (if any). Format is UNIX timestamp
      - `lasttesttime` integer — Timestamp of last test (if any). Format is UNIX timestamp
      - `lastresponsetime` integer — Response time (in milliseconds) of last test.
      - `lastdownstart` integer — Timestamp of start of last check down (if any). Format is UNIX timestamp.
      - `lastdownend` integer — Timestamp of end of last check down (if any). Format is UNIX timestamp. During a downtime it will be lasttesttime.
      - `status` 'up' | 'down' | 'unconfirmed_down' | 'unknown' | 'paused'
      - `resolution` integer — How often should the check be tested? (minutes)
      - `hostname` string — Target host
      - `created` integer — Creating time. Format is UNIX timestamp
      - `tags` Tag[] — List of tags for check
        - `name` string
        - `type` string
        - `count` integer
      - `ipv6` boolean — Use ipv6 instead of ipv4
  - DetailedCheckDns
    - `check` object
      - `type` object
        - `dns` DnsAttributes
          - `nameserver` string, required — DNS server to use
          - `expectedip` string, required — Expected IP
      - `probe_filters` string[] — Filters used for probe selections
      - `sendnotificationwhendown` integer
      - `notifyagainevery` integer
      - `notifywhenbackup` boolean
      - `responsetime_threshold` boolean
      - `custom_message` string
      - `integrationids` integer[]
      - `id` integer
      - `name` string
      - `lasterrortime` integer — Timestamp of last error (if any). Format is UNIX timestamp
      - `lasttesttime` integer — Timestamp of last test (if any). Format is UNIX timestamp
      - `lastresponsetime` integer — Response time (in milliseconds) of last test.
      - `lastdownstart` integer — Timestamp of start of last check down (if any). Format is UNIX timestamp.
      - `lastdownend` integer — Timestamp of end of last check down (if any). Format is UNIX timestamp. During a downtime it will be lasttesttime.
      - `status` 'up' | 'down' | 'unconfirmed_down' | 'unknown' | 'paused'
      - `resolution` integer — How often should the check be tested? (minutes)
      - `hostname` string — Target host
      - `created` integer — Creating time. Format is UNIX timestamp
      - `tags` Tag[] — List of tags for check
        - `name` string
        - `type` string
        - `count` integer
      - `ipv6` boolean — Use ipv6 instead of ipv4
  - DetailedCheckUdp
    - `check` object
      - `type` object
        - `udp` UdpAttributes
          - `port` integer, required — Target port
          - `stringtosend` string, required — String to send
          - `stringtoexpect` string, required — String to expect in response
      - `probe_filters` string[] — Filters used for probe selections
      - `sendnotificationwhendown` integer
      - `notifyagainevery` integer
      - `notifywhenbackup` boolean
      - `responsetime_threshold` boolean
      - `custom_message` string
      - `integrationids` integer[]
      - `id` integer
      - `name` string
      - `lasterrortime` integer — Timestamp of last error (if any). Format is UNIX timestamp
      - `lasttesttime` integer — Timestamp of last test (if any). Format is UNIX timestamp
      - `lastresponsetime` integer — Response time (in milliseconds) of last test.
      - `lastdownstart` integer — Timestamp of start of last check down (if any). Format is UNIX timestamp.
      - `lastdownend` integer — Timestamp of end of last check down (if any). Format is UNIX timestamp. During a downtime it will be lasttesttime.
      - `status` 'up' | 'down' | 'unconfirmed_down' | 'unknown' | 'paused'
      - `resolution` integer — How often should the check be tested? (minutes)
      - `hostname` string — Target host
      - `created` integer — Creating time. Format is UNIX timestamp
      - `tags` Tag[] — List of tags for check
        - `name` string
        - `type` string
        - `count` integer
      - `ipv6` boolean — Use ipv6 instead of ipv4
  - DetailedCheckSmtp
    - `check` object
      - `type` object
        - `smtp` SmtpAttributesGet
          - `port` integer — Target port
          - `encryption` boolean — Connection encryption
          - `stringtoexpect` string — String to expect in response
      - `probe_filters` string[] — Filters used for probe selections
      - `sendnotificationwhendown` integer
      - `notifyagainevery` integer
      - `notifywhenbackup` boolean
      - `responsetime_threshold` boolean
      - `custom_message` string
      - `integrationids` integer[]
      - `id` integer
      - `name` string
      - `lasterrortime` integer — Timestamp of last error (if any). Format is UNIX timestamp
      - `lasttesttime` integer — Timestamp of last test (if any). Format is UNIX timestamp
      - `lastresponsetime` integer — Response time (in milliseconds) of last test.
      - `lastdownstart` integer — Timestamp of start of last check down (if any). Format is UNIX timestamp.
      - `lastdownend` integer — Timestamp of end of last check down (if any). Format is UNIX timestamp. During a downtime it will be lasttesttime.
      - `status` 'up' | 'down' | 'unconfirmed_down' | 'unknown' | 'paused'
      - `resolution` integer — How often should the check be tested? (minutes)
      - `hostname` string — Target host
      - `created` integer — Creating time. Format is UNIX timestamp
      - `tags` Tag[] — List of tags for check
        - `name` string
        - `type` string
        - `count` integer
      - `ipv6` boolean — Use ipv6 instead of ipv4
  - DetailedCheckPop3
    - `check` object
      - `type` object
        - `pop3` Pop3Attributes
          - `port` integer — Target port
          - `stringtoexpect` string — String to expect in response
      - `probe_filters` string[] — Filters used for probe selections
      - `sendnotificationwhendown` integer
      - `notifyagainevery` integer
      - `notifywhenbackup` boolean
      - `responsetime_threshold` boolean
      - `custom_message` string
      - `integrationids` integer[]
      - `id` integer
      - `name` string
      - `lasterrortime` integer — Timestamp of last error (if any). Format is UNIX timestamp
      - `lasttesttime` integer — Timestamp of last test (if any). Format is UNIX timestamp
      - `lastresponsetime` integer — Response time (in milliseconds) of last test.
      - `lastdownstart` integer — Timestamp of start of last check down (if any). Format is UNIX timestamp.
      - `lastdownend` integer — Timestamp of end of last check down (if any). Format is UNIX timestamp. During a downtime it will be lasttesttime.
      - `status` 'up' | 'down' | 'unconfirmed_down' | 'unknown' | 'paused'
      - `resolution` integer — How often should the check be tested? (minutes)
      - `hostname` string — Target host
      - `created` integer — Creating time. Format is UNIX timestamp
      - `tags` Tag[] — List of tags for check
        - `name` string
        - `type` string
        - `count` integer
      - `ipv6` boolean — Use ipv6 instead of ipv4
  - DetailedCheckImap
    - `check` object
      - `type` object
        - `imap` ImapAttributes
          - `port` integer — Target port
          - `stringtoexpect` string — String to expect in response
      - `probe_filters` string[] — Filters used for probe selections
      - `sendnotificationwhendown` integer
      - `notifyagainevery` integer
      - `notifywhenbackup` boolean
      - `responsetime_threshold` boolean
      - `custom_message` string
      - `integrationids` integer[]
      - `id` integer
      - `name` string
      - `lasterrortime` integer — Timestamp of last error (if any). Format is UNIX timestamp
      - `lasttesttime` integer — Timestamp of last test (if any). Format is UNIX timestamp
      - `lastresponsetime` integer — Response time (in milliseconds) of last test.
      - `lastdownstart` integer — Timestamp of start of last check down (if any). Format is UNIX timestamp.
      - `lastdownend` integer — Timestamp of end of last check down (if any). Format is UNIX timestamp. During a downtime it will be lasttesttime.
      - `status` 'up' | 'down' | 'unconfirmed_down' | 'unknown' | 'paused'
      - `resolution` integer — How often should the check be tested? (minutes)
      - `hostname` string — Target host
      - `created` integer — Creating time. Format is UNIX timestamp
      - `tags` Tag[] — List of tags for check
        - `name` string
        - `type` string
        - `count` integer
      - `ipv6` boolean — Use ipv6 instead of ipv4

---

[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)