Servers Playground How we check Add a server Log in

NodePing MCP by usefulapi

Working · 649 ms

io.usefulapi/nodepingv1.8.0 Domain verified

Read NodePing checks, uptime, results and events; mute checks, manage maintenance and schedules.

Cloud & DevOps

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://nodeping.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

nodeping_create_adhoc_maintenance Destructive

WRITE: create a one-off maintenance window that disables the listed checks for duration_minutes and re-enables them afterwards (no alerts meanwhile). Created inactive unless start_now=true, which starts it immediately. POST /maintenance/ad-hoc.

namestring, required

check_idsarray, required

duration_minutesinteger, required

How long the checks stay disabled, in minutes (max 7 days).

start_nowboolean

Start immediately (default false: created but not started).

customer_idstring

SubAccount customer id (MSP accounts). Omit for your own account.

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

NodePing MCP by usefulapi MCP server | mcptry

NodePing MCP by usefulapi

Working · 649 ms

io.usefulapi/nodepingv1.8.0 Domain verified

Read NodePing checks, uptime, results and events; mute checks, manage maintenance and schedules.

Cloud & DevOps

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://nodeping.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

nodeping_create_adhoc_maintenance Destructive

namestring, required

check_idsarray, required

duration_minutesinteger, required

How long the checks stay disabled, in minutes (max 7 days).

start_nowboolean

Start immediately (default false: created but not started).

customer_idstring

SubAccount customer id (MSP accounts). Omit for your own account.

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

Tools (28)

nodeping_create_adhoc_maintenance

destructive

Argument	Type	Description
name*	string
check_ids*	array
start_now	boolean	Start immediately (default false: created but not started).
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.
duration_minutes*	integer	How long the checks stay disabled, in minutes (max 7 days).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name",
    "duration_minutes",
    "check_ids"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "check_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 120,
        "minLength": 1,
        "description": "NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks)."
      },
      "maxItems": 500,
      "minItems": 1
    },
    "start_now": {
      "type": "boolean",
      "description": "Start immediately (default false: created but not started)."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    },
    "duration_minutes": {
      "type": "integer",
      "maximum": 10080,
      "minimum": 1,
      "description": "How long the checks stay disabled, in minutes (max 7 days)."
    }
  }
}

nodeping_create_contact_group

WRITE: create a contact group from existing contact address ids. POST /contactgroups.

destructive

Argument	Type	Description
name*	string
members*	array	Contact ADDRESS ids (from nodeping_list_contacts), not contact ids.
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name",
    "members"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "members": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 64,
        "minLength": 1
      },
      "maxItems": 200,
      "description": "Contact ADDRESS ids (from nodeping_list_contacts), not contact ids."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_delete_contact_group

WRITE (destructive): delete a contact group. Checks that notify the group lose that notification target. DELETE /contactgroups/{id}.

destructive

Argument	Type	Description
group_id*	string	Contact group id.
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "group_id"
  ],
  "properties": {
    "group_id": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Contact group id."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_delete_maintenance

WRITE (destructive): remove a maintenance entry. DELETE /maintenance/{id}.

destructive

Argument	Type	Description
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.
maintenance_id*	string	Maintenance id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "maintenance_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    },
    "maintenance_id": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Maintenance id."
    }
  }
}

nodeping_delete_schedule

WRITE (destructive): delete a notification schedule by name. DELETE /schedules/{name}.

destructive

Argument	Type	Description
name*	string	Schedule name.
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Schedule name."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_disable_check

WRITE: stop a check from running (enabled=false); its history is kept. Re-enabling is done in the NodePing app (it changes the number of billed checks). PUT /checks/{id}.

destructive

Argument	Type	Description
check_id*	string	NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks).
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "check_id"
  ],
  "properties": {
    "check_id": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks)."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_get_account

The NodePing account the token belongs to (name, status, timezone, next billing date, default probe locations), or a SubAccount with customer_id. GET /accounts.

read-only

Argument	Type	Description
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_get_check

One check by id with its full (scrubbed) configuration. Optionally include its latest result and uptime. GET /checks/{id}.

read-only

Argument	Type	Description
uptime	boolean	Include uptime figures.
check_id*	string	NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks).
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.
last_result	boolean	Include the check's most recent result.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "check_id"
  ],
  "properties": {
    "uptime": {
      "type": "boolean",
      "description": "Include uptime figures."
    },
    "check_id": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks)."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    },
    "last_result": {
      "type": "boolean",
      "description": "Include the check's most recent result."
    }
  }
}

nodeping_get_check_events

Down and disabled events of a check (start, end, message, open) newest first: an incident history. limit=1 returns the most recent event. GET /results/events/{id}.

read-only

Argument	Type	Description
end	string	End of the range.
limit	integer
start	string	Start of the range.
check_id*	string	NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks).
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "check_id"
  ],
  "properties": {
    "end": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "End of the range."
    },
    "limit": {
      "type": "integer",
      "maximum": 5000,
      "minimum": 1
    },
    "start": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "Start of the range."
    },
    "check_id": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks)."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_get_check_results

Raw results of a check, newest first by default: pass/fail (su), run time (rt, ms), message (m), status text (sc), start (s) and the probe location (l). Use span (hours) or start/end (ms epoch, ISO 8601 or RFC 2822; GMT unless a zone is given) to bound it. GET /results/{id}.

read-only

Argument	Type	Description
end	string	End of the range (cannot be combined with span).
span	integer	Hours of history to return (narrower than `limit` wins).
limit	integer	Number of results (default 50, max 5000).
start	string	Start of the range.
check_id*	string	NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks).
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "check_id"
  ],
  "properties": {
    "end": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "End of the range (cannot be combined with span)."
    },
    "span": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Hours of history to return (narrower than `limit` wins)."
    },
    "limit": {
      "type": "integer",
      "maximum": 5000,
      "minimum": 1,
      "description": "Number of results (default 50, max 5000)."
    },
    "start": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "Start of the range."
    },
    "check_id": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks)."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_get_check_summary

Hourly summary of a check's results: count, min, max and average run time per UTC hour. GET /results/summary/{id}.

read-only

Argument	Type	Description
check_id*	string	NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks).
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "check_id"
  ],
  "properties": {
    "check_id": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks)."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_get_check_uptime

Uptime percentage of a check per day or month (enabled and down milliseconds plus uptime %), with a total. GET /results/uptime/{id}.

read-only

Argument	Type	Description
end	string	End date, exclusive (default now).
start	string	Start date, e.g. 2026-09-01 (default: earliest data).
offset	integer	UTC offset in hours for the day/month boundaries.
check_id*	string	NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks).
interval	string	Bucket size (default months).
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "check_id"
  ],
  "properties": {
    "end": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "End date, exclusive (default now)."
    },
    "start": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1,
      "description": "Start date, e.g. 2026-09-01 (default: earliest data)."
    },
    "offset": {
      "type": "integer",
      "maximum": 24,
      "minimum": -24,
      "description": "UTC offset in hours for the day/month boundaries."
    },
    "check_id": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks)."
    },
    "interval": {
      "enum": [
        "days",
        "months"
      ],
      "type": "string",
      "description": "Bucket size (default months)."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_get_contact

One contact by id with its addresses (secret-like addresses masked). GET /contacts?id={id}.

read-only

Argument	Type	Description
contact_id*	string	Contact id, e.g. 201205050153W2Q4C-BKPGH.
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "contact_id"
  ],
  "properties": {
    "contact_id": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Contact id, e.g. 201205050153W2Q4C-BKPGH."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_get_current_events

Everything that is down or disabled right now across the account (type, label, since when). The quickest 'what is broken' view. GET /results/current.

read-only

Argument	Type	Description
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_get_maintenance

One maintenance entry by id. GET /maintenance/{id}.

read-only

Argument	Type	Description
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.
maintenance_id*	string	Maintenance id, e.g. NZT101.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "maintenance_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    },
    "maintenance_id": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Maintenance id, e.g. NZT101."
    }
  }
}

nodeping_get_probe_info

NodePing's probe servers (two-letter codes) or regions (nam, lam, eur, eao, wlw): the values a check's run locations use. GET /info/probe[/{code}] or /info/location[/{code}].

read-only

Argument	Type	Description
code	string	One probe or region code; omit to list all.
kind*	string	probe = individual probe servers, location = regions.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "kind"
  ],
  "properties": {
    "code": {
      "type": "string",
      "pattern": "^[A-Za-z0-9]{2,3}$",
      "description": "One probe or region code; omit to list all."
    },
    "kind": {
      "enum": [
        "probe",
        "location"
      ],
      "type": "string",
      "description": "probe = individual probe servers, location = regions."
    }
  }
}

nodeping_get_schedule

One notification schedule by name (for example Days or All) with its seven weekday entries. GET /schedules/{name}.

read-only

Argument	Type	Description
name*	string	Schedule name.
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Schedule name."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_list_checks

List monitoring checks with label, type, target, interval, enabled state and pass/fail (state 1 = passing, 0 = failing; firstdown = when the current outage began). Filter client-side by status, type or label text. Compact by default; set detail=true for the full (scrubbed) check objects. GET /checks.

read-only

Argument	Type	Description
type	string	Only this check type, e.g. HTTP, PING, SSL, DNS.
detail	boolean	Return full check objects (parameters, notifications) instead of the compact view.
status	string	Only passing, failing or disabled checks.
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.
label_contains	string	Only checks whose label contains this text (case-insensitive).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "type": {
      "type": "string",
      "maxLength": 30,
      "minLength": 1,
      "description": "Only this check type, e.g. HTTP, PING, SSL, DNS."
    },
    "detail": {
      "type": "boolean",
      "description": "Return full check objects (parameters, notifications) instead of the compact view."
    },
    "status": {
      "enum": [
        "passing",
        "failing",
        "disabled"
      ],
      "type": "string",
      "description": "Only passing, failing or disabled checks."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    },
    "label_contains": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only checks whose label contains this text (case-insensitive)."
    }
  }
}

nodeping_list_contact_groups

Contact groups (name and member address ids), keyed by group id. GET /contactgroups.

read-only

Argument	Type	Description
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_list_contacts

All notification contacts with their addresses (email, SMS, webhook, Slack, ...). Webhook/Slack/PagerDuty/Pushover addresses are masked. Address ids are what contact groups and checks reference. GET /contacts.

read-only

Argument	Type	Description
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_list_maintenance

Scheduled and ad-hoc maintenance entries (checks they disable, cron, duration, next run, last runs). GET /maintenance.

read-only

Argument	Type	Description
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_list_notification_profiles

Notification profiles: named sets of contacts/groups with delay and schedule, reusable across checks. GET /notificationprofiles.

read-only

Argument	Type	Description
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_list_notifications

The alert notifications NodePing sent (who, when, what), for one check or for the whole account, newest first. Contact addresses that are webhook URLs or keys are masked. GET /notifications[/{check_id}].

read-only

Argument	Type	Description
span	integer	Hours of history to return (narrower than `limit` wins).
limit	integer	Number of records (default 300, max 5000).
check_id	string	NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks).
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.
include_subaccounts	boolean	Also include notifications sent for SubAccounts.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "span": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Hours of history to return (narrower than `limit` wins)."
    },
    "limit": {
      "type": "integer",
      "maximum": 5000,
      "minimum": 1,
      "description": "Number of records (default 300, max 5000)."
    },
    "check_id": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks)."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    },
    "include_subaccounts": {
      "type": "boolean",
      "description": "Also include notifications sent for SubAccounts."
    }
  }
}

nodeping_list_schedules

Notification schedules (per-weekday time windows a contact is alerted in). GET /schedules.

read-only

Argument	Type	Description
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

nodeping_mute_check

WRITE: mute a check's notifications (the check keeps running and recording) until a time or indefinitely, or unmute it. mute_until is a future time in ms since the epoch; omit it with mute=true to mute until unmuted. PUT /checks/{id}.

destructive

Argument	Type	Description
mute*	boolean	true = mute, false = unmute.
check_id*	string	NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks).
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.
mute_until_ms	integer	Unmute automatically at this time (ms since epoch, must be in the future). Only with mute=true.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "check_id",
    "mute"
  ],
  "properties": {
    "mute": {
      "type": "boolean",
      "description": "true = mute, false = unmute."
    },
    "check_id": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks)."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    },
    "mute_until_ms": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Unmute automatically at this time (ms since epoch, must be in the future). Only with mute=true.",
      "exclusiveMinimum": 0
    }
  }
}

nodeping_put_schedule

WRITE: create or update a notification schedule. NodePing stores all seven weekdays at once, so for an existing schedule the weekdays you pass are merged into its current ones; a new schedule needs all seven. Per weekday: time1/time2 window (24h), exclude to invert it, disabled for no alerts, allday for always. GET then PUT /schedules/{name}.

destructive

Argument	Type	Description
name*	string	Schedule name.
friday	object
monday	object
sunday	object
tuesday	object
saturday	object
thursday	object
wednesday	object
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

nodeping_update_check

WRITE: change a check's label, description, tags, target, timeout (threshold seconds) or re-checks before alert (sens). Only the fields you pass change. It does not enable the check, create checks or touch billing. PUT /checks/{id}.

destructive

Argument	Type	Description
sens	integer	Re-checks before the state changes.
tags	array	Replaces the check's tags.
label	string
target	string	New target (HTTP-family checks need an http:// or https:// URL).
check_id*	string	NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks).
threshold	integer	Timeout in seconds.
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.
description	string	Up to 1000 characters.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "check_id"
  ],
  "properties": {
    "sens": {
      "type": "integer",
      "maximum": 20,
      "minimum": 0,
      "description": "Re-checks before the state changes."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 50,
      "description": "Replaces the check's tags."
    },
    "label": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "target": {
      "type": "string",
      "maxLength": 2000,
      "minLength": 1,
      "description": "New target (HTTP-family checks need an http:// or https:// URL)."
    },
    "check_id": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "NodePing check id, e.g. 201205050153W2Q4C-0J2HSIRF (from nodeping_list_checks)."
    },
    "threshold": {
      "type": "integer",
      "maximum": 300,
      "minimum": 1,
      "description": "Timeout in seconds."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    },
    "description": {
      "type": "string",
      "maxLength": 1000,
      "description": "Up to 1000 characters."
    }
  }
}

nodeping_update_contact_group

WRITE: rename a contact group and/or replace its member list (send the FULL list; omitted members are removed). PUT /contactgroups/{id}.

destructive

Argument	Type	Description
name	string
members	array	Contact ADDRESS ids (from nodeping_list_contacts), not contact ids.
group_id*	string	Contact group id, e.g. 201205050153W2Q4C-G-3QJWG.
customer_id	string	SubAccount customer id (MSP accounts). Omit for your own account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "group_id"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "members": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 64,
        "minLength": 1
      },
      "maxItems": 200,
      "description": "Contact ADDRESS ids (from nodeping_list_contacts), not contact ids."
    },
    "group_id": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Contact group id, e.g. 201205050153W2Q4C-G-3QJWG."
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Schedule name."
    },
    "friday": {
      "type": "object",
      "properties": {
        "time1": {
          "type": "string",
          "pattern": "^\\d{1,2}:\\d{2}$",
          "description": "Start of the span, 24h, e.g. 6:00."
        },
        "time2": {
          "type": "string",
          "pattern": "^\\d{1,2}:\\d{2}$",
          "description": "End of the span, e.g. 18:00."
        },
        "allday": {
          "type": "boolean",
          "description": "Notify all day."
        },
        "exclude": {
          "type": "boolean",
          "description": "Invert the span: notify all day except between time1 and time2."
        },
        "disabled": {
          "type": "boolean",
          "description": "No notifications that day."
        }
      },
      "additionalProperties": false
    },
    "monday": {
      "type": "object",
      "properties": {
        "time1": {
          "type": "string",
          "pattern": "^\\d{1,2}:\\d{2}$",
          "description": "Start of the span, 24h, e.g. 6:00."
        },
        "time2": {
          "type": "string",
          "pattern": "^\\d{1,2}:\\d{2}$",
          "description": "End of the span, e.g. 18:00."
        },
        "allday": {
          "type": "boolean",
          "description": "Notify all day."
        },
        "exclude": {
          "type": "boolean",
          "description": "Invert the span: notify all day except between time1 and time2."
        },
        "disabled": {
          "type": "boolean",
          "description": "No notifications that day."
        }
      },
      "additionalProperties": false
    },
    "sunday": {
      "type": "object",
      "properties": {
        "time1": {
          "type": "string",
          "pattern": "^\\d{1,2}:\\d{2}$",
          "description": "Start of the span, 24h, e.g. 6:00."
        },
        "time2": {
          "type": "string",
          "pattern": "^\\d{1,2}:\\d{2}$",
          "description": "End of the span, e.g. 18:00."
        },
        "allday": {
          "type": "boolean",
          "description": "Notify all day."
        },
        "exclude": {
          "type": "boolean",
          "description": "Invert the span: notify all day except between time1 and time2."
        },
        "disabled": {
          "type": "boolean",
          "description": "No notifications that day."
        }
      },
      "additionalProperties": false
    },
    "tuesday": {
      "type": "object",
      "properties": {
        "time1": {
          "type": "string",
          "pattern": "^\\d{1,2}:\\d{2}$",
          "description": "Start of the span, 24h, e.g. 6:00."
        },
        "time2": {
          "type": "string",
          "pattern": "^\\d{1,2}:\\d{2}$",
          "description": "End of the span, e.g. 18:00."
        },
        "allday": {
          "type": "boolean",
          "description": "Notify all day."
        },
        "exclude": {
          "type": "boolean",
          "description": "Invert the span: notify all day except between time1 and time2."
        },
        "disabled": {
          "type": "boolean",
          "description": "No notifications that day."
        }
      },
      "additionalProperties": false
    },
    "saturday": {
      "type": "object",
      "properties": {
        "time1": {
          "type": "string",
          "pattern": "^\\d{1,2}:\\d{2}$",
          "description": "Start of the span, 24h, e.g. 6:00."
        },
        "time2": {
          "type": "string",
          "pattern": "^\\d{1,2}:\\d{2}$",
          "description": "End of the span, e.g. 18:00."
        },
        "allday": {
          "type": "boolean",
          "description": "Notify all day."
        },
        "exclude": {
          "type": "boolean",
          "description": "Invert the span: notify all day except between time1 and time2."
        },
        "disabled": {
          "type": "boolean",
          "description": "No notifications that day."
        }
      },
      "additionalProperties": false
    },
    "thursday": {
      "type": "object",
      "properties": {
        "time1": {
          "type": "string",
          "pattern": "^\\d{1,2}:\\d{2}$",
          "description": "Start of the span, 24h, e.g. 6:00."
        },
        "time2": {
          "type": "string",
          "pattern": "^\\d{1,2}:\\d{2}$",
          "description": "End of the span, e.g. 18:00."
        },
        "allday": {
          "type": "boolean",
          "description": "Notify all day."
        },
        "exclude": {
          "type": "boolean",
          "description": "Invert the span: notify all day except between time1 and time2."
        },
        "disabled": {
          "type": "boolean",
          "description": "No notifications that day."
        }
      },
      "additionalProperties": false
    },
    "wednesday": {
      "type": "object",
      "properties": {
        "time1": {
          "type": "string",
          "pattern": "^\\d{1,2}:\\d{2}$",
          "description": "Start of the span, 24h, e.g. 6:00."
        },
        "time2": {
          "type": "string",
          "pattern": "^\\d{1,2}:\\d{2}$",
          "description": "End of the span, e.g. 18:00."
        },
        "allday": {
          "type": "boolean",
          "description": "Notify all day."
        },
        "exclude": {
          "type": "boolean",
          "description": "Invert the span: notify all day except between time1 and time2."
        },
        "disabled": {
          "type": "boolean",
          "description": "No notifications that day."
        }
      },
      "additionalProperties": false
    },
    "customer_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "SubAccount customer id (MSP accounts). Omit for your own account."
    }
  }
}