Create a TCP Monitor

Last modified on May 22, 2024

To create a new TCP monitor, send a POST request to /monitors/tcp with a JSON body containing the monitor configuration.

Request URL



The request must include the Authorization header containing a user’s access token:

Authorization: Bearer ACCESS_TOKEN

See Authentication for more information.

The authenticating user must have permissions to create monitors.

Request body

The request body is a JSON object containing the monitor configuration parameters (see Monitor Object). The minimum required fields are:

  • billing_plancode

  • hostname

  • name

  • port

  "billing_plancode": "UBM - A/A",
  "hostname": "",
  "port": 443,
  "name": "Check port 443"

If you want to monitor an IP address rather than a domain name, use:

  "billing_plancode": "UBM - A/A",
  "hostname": "",
  "ipv4": "",
  "resolve_dns": false,
  "port": 443,
  "name": "Check port 443"

Here is the example with all supported fields (see Monitor Object for a description of these fields):

  "alert_note": "Optional alert notes",
  "allow_internal_testing": true,
  "billing_plancode": "UBM - A/A",
  "enabled": true,
  "home_location": 10,
  "hostname": "",
  "interval": 5,
  "ipv4": "",  // IP is only used if resolve_dns = true
  "locations": [
    {"id": 10},
    {"id": 20}
  "mode": "Global Verify",
  "monitor_location_count": 1,
  "name": "Check port 443",
  "note": "Optional dashboard notes",
  "notify_on_error": true,
  "port": 443,
  "resolve_dns": true,
  "retry_on_failure": true,
  "rotate_locations": true,
  "timeout": 1,
  "traceroute_on_error": true

Response body

On success, the operation returns the ID of the created monitor.

  "id": "123456"

Error responses have a non-200 status code and contain the errors list, such as:

  "errors": [
      "code": 400,
      "message": "invalid_request - User authentication failed."

Try it out

Click here to test this operation in AlertSite’s interactive API console.

Code examples

This code creates a TCP monitor for, port 443:

cURL (Windows)

curl -X POST
  -H "Authorization: Bearer ACCESS_TOKEN"
  -H "Content-Type: application/json"
  -d "{\"billing_plancode\": \"UBM - A/A\", \"hostname\": \"\", \"port\": 443, \"name\": \"Check port 443\"}"

Note: New lines are added for readability.
The actual command should be one continuous line.

cURL (Bash)

curl -X POST \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"billing_plancode": "UBM - A/A", "hostname": "", "port": 443, "name": "Check port 443"}'


import requests # Requests library
import json

baseUrl = ''
username = '[email protected]'  # Replace with your AlertSite login email
password = 'pa55w0rd'          # Replace with your AlertSite password

monitor_params = {
  'billing_plancode': 'UBM - A/A',
  'name': 'Check port 443',
  'hostname': '',
  'port': 443

# Login
payload = {'username': username, 'password': password}
r ='/access-tokens', data=json.dumps(payload), headers={'Content-Type': 'application/json'})
token = r.json()['access_token']

# Create the monitor
headers = {
  'Authorization': 'Bearer ' + token,
  'Content-Type': 'application/json'
r ='/monitors/tcp', data=json.dumps(monitor_params), headers=headers)
result = r.json()
if r.status_code ==
    monitor_id = result['id']
    print('Successfully created the monitor. ID:{}'.format(monitor_id))
    print('Could not create a monitor. The following error(s) occurred:', *result['errors'], sep='\n')

See Also

Monitor Operations
Get Monitor by ID
Get Monitors
Edit a TCP Monitor

Highlight search results