Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NodePing Checks API

The Checks API from NodePing — 2 operation(s) for checks.

NodePing Checks API is one of 8 APIs that NodePing publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Checks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 5 operations across 2 paths. It is described by OpenAPI 3.1.0, at version 1.

Requests are made against a single base URL, https://api.nodeping.com/api/1.

5 operations 2 paths 0 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1
Base URL
https://api.nodeping.com/api/1
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

NodePing Checks API declares 2 security schemes for authenticating requests. An API key is passed in the query as token (ApiTokenQuery). It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • ApiTokenQuery — API token passed as the token query parameter
  • BasicAuth — API token used as the username in HTTP Basic Auth

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Checks 5
GET
/checks
List checks
listChecks → 200
POST
/checks
Create a check
createCheck body → 200
GET
/checks/{checkid}
Get a single check
getCheck 1 param → 200
PUT
/checks/{checkid}
Update a check
updateCheck 1 param → 200
DELETE
/checks/{checkid}
Delete a check
deleteCheck 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nodeping-checks-api-openapi.yml Raw ↑

Other APIs NodePing publishes across the network.

NodePing Accounts API
NodePing Contactgroups API
NodePing Contacts API
NodePing Info API
NodePing Notifications API
NodePing Results API
NodePing Schedules API