---
title: "POST /api/v1/checks/add-ssh/"
method: POST
path: "/api/v1/checks/add-ssh/"
tags: ["checks"]
---

# POST /api/v1/checks/add-ssh/

`POST /api/v1/checks/add-ssh/`

## 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/add-ssh/`
- Auth: none declared
- TypeScript: <https://skmtc.dev/uptime/apis/uptime-com-openapi-schema/docs/api/v1/checks/add-ssh/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a new SSH check

## Request body

- ChecksSSH
  - `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, required
  - `msp_address` string, required
  - `msp_port` integer, nullable
  - `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

## Response `200`

- ChecksSSH
  - `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, required
  - `msp_address` string, required
  - `msp_port` integer, nullable
  - `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

---

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