--- title: "GET /api/v1/checks/{pk}/" method: GET path: "/api/v1/checks/{pk}/" tags: ["checks"] --- # GET /api/v1/checks/{pk}/ `GET /api/v1/checks/{pk}/` ## Request - Base URL: `https://uptime.com` (the document declares no server; this is the origin it was published from) - URL: `https://uptime.com/api/v1/checks/{pk}/` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) Get a single check ## Path parameters - `pk` string, required ## Response `200` - ChecksExtraConfig - `pk` integer - `url` string - `stats_url` string, uri - `alerts_url` string, uri - `share_url` string, uri - `name` string - `cached_response_time` number - `contact_groups` string[], required: Array of contact names or IDs associated with this check. Use GET /api/v1/contacts/ to list available contacts. - `created_at` string, date-time - `modified_at` string, date-time - `locations` string[]: Array of locations associated with this check. Use GET /api/v1/checks/locations/ to list available locations. - `tags` string[]: Array of tag names or IDs associated with this check. Use GET /api/v1/check-tags/ to list available tags. - `check_type` string - `escalations` string - `monitoring_service_type` string - `is_paused` boolean - `send_resolved_notifications` boolean: Send resolve notifications when pausing the check - `is_under_maintenance` string - `state_is_up` boolean - `state_changed_at` string, date-time - `maintenance_schedules` integer[]: Array of maintenance schedule IDs associated with this check. - `msp_interval` integer - `msp_address` string, required - `msp_port` integer, nullable - `msp_username` string - `msp_password` string - `msp_proxy` string - `msp_dns_server` string - `msp_dns_record_type` 'A' | 'AAAA' | 'CNAME' | 'MX' | 'NS' | 'PTR' | 'SOA' | 'TXT' | 'ANY' - `msp_status_code` string - `msp_send_string` string - `msp_expect_string` string - `msp_expect_string_type` 'STRING' | 'REGEX' | 'INVERSE_REGEX' - `msp_encryption` '' | 'SSL_TLS' - `msp_threshold` integer, nullable - `msp_headers` string - `msp_script` string - `msp_version` integer - `msp_sensitivity` integer - `msp_num_retries` integer - `msp_use_ip_version` '' | 'IPV4' | 'IPV6' - `msp_uptime_sla` string, decimal - `msp_response_time_sla` string, decimal, nullable - `msp_notes` string - `msp_include_in_global_metrics` boolean - `webhook_url` string - `heartbeat_url` string - `rumconfig` object, nullable - `aggregation_type` 'MED' | 'AVG' | 'P75' | 'P90' | 'P95' | 'P98' | 'P99' - `exclude_useragents` string - `apdex_threshold` integer - `url_groups` string - `external_domains` string - `exclude_get_params` string - `is_ajax_disabled` boolean - `groupcheckconfig` object, nullable - `group_check_services` string[]: Include checks from this list - `group_check_tags` string[]: Include checks with one or more of the selected tags - `group_check_down_condition` 'ANY' | 'TWO' | 'THREE' | 'FOUR' | 'FIVE' | 'TEN' | 'ONE_PCT' | 'THREE_PCT' | 'FIVE_PCT' | 'TEN_PCT' | 'TWENTYFIVE_PCT' | 'FIFTY_PCT' | 'ALL' - `group_uptime_percent_calculation` 'UP_DOWN_STATES' | 'AVERAGE' - `group_response_time_calculation_mode` 'NONE' | 'COPY' | 'AVERAGE' - `group_response_time_check_type` 'HTTP' | 'TRANSACTION' | 'API' | 'ICMP' | 'HEARTBEAT' | 'WEBHOOK' - `group_response_time_single_check` string, nullable: Service to copy response time from - `sslconfig` object, nullable - `ssl_cert_protocol` 'https' | 'ftp' | 'ftps' | 'http' | 'h2' | 'imap' | 'imaps' | 'irc' | 'ircs' | 'ldap' | 'ldaps' | 'mysql' | 'pop3' | 'pop3s' | 'postgres' | 'sieve' | 'smtp' | 'smtps' | 'xmpp' | 'xmpp-server': Protocol to use - `ssl_cert_crl` boolean: CRL fallback when OSCP is not available - `ssl_cert_first_element_only` boolean: Check only the first certificate in the chain - `ssl_cert_match` string: Additional names to match in certificate - `ssl_cert_issuer` string: Issuer to match in certificate - `ssl_cert_resolve` string: Force host IP address resolution - `ssl_cert_minimum_ssl_tls_version` 'sslv3' | 'tlsv1' | 'tlsv11' | 'tlsv12' | 'tlsv13': Minimum SSL/TLS versions - `ssl_cert_fingerprint` string: Match certificate fingerprint (SHA1) - `ssl_cert_selfsigned` boolean: Allow self-signed certificates - `ssl_cert_file` string, uri, nullable: Validate certificate/CRL at URL - `ssl_ignore_authority_warnings` boolean: Ignore authority warnings (check expiration only) - `ssl_ignore_sct` boolean: Do not check for signed certificate timestamps (SCT) - `pagespeedconfig` object, nullable - `emulated_device` 'DEFAULT' | 'DESKTOP_LOW_END' | 'IPHONE_17_PRO_MAX' | 'IPHONE_17' | 'IPHONE_16_PRO_MAX' | 'IPHONE_16' | 'IPHONE_15_PRO_MAX' | 'IPHONE_15' | 'IPHONE_14_PRO_MAX' | 'IPHONE_13_PRO_MAX' | 'IPHONE_13' | 'IPHONE_12_PRO_MAX' | 'IPHONE_12' | 'IPHONE_11_PRO_MAX' | 'IPHONE_11_PRO' | 'IPHONE_11' | 'GOOGLE_PIXEL_10' | 'GOOGLE_PIXEL_10_PRO' | 'GOOGLE_PIXEL_9' | 'GOOGLE_PIXEL_9_PRO' | 'GOOGLE_PIXEL_8_PRO' | 'GOOGLE_PIXEL_7' | 'GOOGLE_PIXEL_6' | 'GOOGLE_PIXEL_6_PRO' | 'SAMSUNG_GALAXY_S24_ULTRA' | 'SAMSUNG_GALAXY_S23' | 'SAMSUNG_GALAXY_Z_FOLD_5' | 'SAMSUNG_GALAXY_S10' | 'SAMSUNG_GALAXY_S10_PLUS' | 'SAMSUNG_GALAXY_S21' | 'SAMSUNG_GALAXY_S21_PLUS' | 'SAMSUNG_GALAXY_S21_ULTRA' | 'SAMSUNG_GALAXY_S22' | 'IPAD_PRO_12_9' | 'IPAD_AIR' | 'IPAD_MINI' | 'IPAD_PRO_11' | 'MOBILE_MID_TIER' | 'MOBILE_LOW_END' - `connection_throttling` 'UNTHROTTLED' | 'BROADBAND_FAST' | 'BROADBAND' | 'BROADBAND_SLOW' | 'LTE' | 'FOUR_G' | 'FOUR_G_SLOW' | 'THREE_G' | 'THREE_G_SLOW' - `exclude_urls` string - `uptime_grade_threshold` '' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' - `cached_uptime_grade` string, nullable - `cached_performance_score` integer, nullable - `cached_best_practices_score` integer, nullable - `cloudstatusconfig` object, required - `notify_only_on_down` boolean: Opt out of maintenance notifications. - `service_name` string, nullable: (deprecated) The cloud status component name or ID. Use GET /api/v1/checks/cloudstatus-services/ to list available services. - `group` integer, nullable: The group ID to monitor. Use GET /api/v1/checks/cloudstatus-groups/ to list available groups. - `monitoring_type` 'ALL' | 'SPECIFIC', nullable: ALL monitors every component in the group. SPECIFIC monitors only the components listed in services and/or service_titles. - `services` integer[]: List of specific service IDs to monitor directly. Use GET /api/v1/checks/cloudstatus-services/?group= to list available services for a group. - `service_titles` string[]: List of service title strings. All current and future services matching these titles will be monitored automatically. - `ftpconfig` object, nullable - `ftp_paths` string, nullable - `ftp_skip_cert_verification` boolean - `ftp_explicit_tls` boolean - `sftpconfig` object, nullable - `ftp_paths` string, nullable - `sftp_private_key` string, nullable - `sftp_passphrase` string, nullable - `sftp_known_hosts` string, nullable - `networkconfig` object, nullable - `network_locations` object[]: Array of location filters selecting where the check runs from. Within one entry, the non-empty values of continent_code, region_name, country_code, state_code and city are AND-ed; multiple entries are combined. Example: [{"continent_code": "EU"}, {"continent_code": "NA", "country_code": "US", "city": "New York"}]. - `network_name` string: Optional network/ISP to monitor from within the chosen locations. Example: "Google LLC". Leave blank to use any available network. - `network_capture_traceroute` boolean - `network_no_probe_fallback` 'UP' | 'DOWN' --- [API](https://skmtc.dev/uptime/apis/uptime-com-openapi-schema.md) - [All operations](https://skmtc.dev/uptime/apis/uptime-com-openapi-schema/llms.txt) - [OpenAPI document](https://skmtc.dev/uptime/apis/uptime-com-openapi-schema/revisions/e1e4a57a60d8?raw)