---
title: "POST /api/tcp-monitors"
method: POST
path: "/api/tcp-monitors"
tags: ["Tcp Monitors"]
---

# POST /api/tcp-monitors

`POST /api/tcp-monitors`

## Request

- Base URL: `https://uptimeify.io`
- URL: `https://uptimeify.io/api/tcp-monitors`
- Auth: HTTP bearer

## Request body

- object
  - `customerId` union, required
    - integer
    - string
  - `name` string, required
  - `hostname` string, required
  - `port` integer, required
  - `config` object
    - `expectBanner` string
  - `status` 'active' | 'inactive' | 'maintenance' | 'disabled'
  - `checkInterval` integer
  - `timeoutSeconds` integer
  - `allowedCheckCountryCodes` string[]
  - `managementType` 'managed' | 'self_service'

## Response `200`

Successful response

- object
  - `id` integer, required
  - `allowedCheckCountryCodes` string[], nullable, required: ISO country codes of the allowed check locations; null = all.
  - `publicId` string, uuid, required
  - `organizationId` integer, required
  - `customerId` integer, required
  - `name` string, required
  - `hostname` string, required
  - `checkInterval` integer, required: Minutes.
  - `timeoutSeconds` integer, required
  - `status` 'active' | 'maintenance' | 'disabled', required
  - `managementType` 'managed' | 'self_service', required
  - `notificationPhoneNumber` string, nullable, required
  - `notificationEmail` string, nullable, required
  - `lastCheckedAt` string, date-time, nullable, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required
  - `port` integer, required
  - `config` object, required: Protocol settings. Secrets (password, privateKey, passphrase, auth.pass) are always null.

## Other responses

- `400`: Invalid or missing parameters.
- `401`: Missing, invalid or expired API token.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api.md) · [All operations](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/revisions/2129a771ee7e?raw)