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 Contacts API

The Contacts API from NodePing — 1 operation(s) for contacts.

NodePing Contacts 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 Contacts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 4 operations across 1 path. 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.

4 operations 1 paths 0 schemas 1 DELETE1 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 Contacts 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 4

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

Contacts 4
GET
/contacts
List contacts
listContacts → 200
POST
/contacts
Create a contact
createContact → 200
PUT
/contacts
Update a contact
updateContact → 200
DELETE
/contacts
Delete a contact
deleteContact → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nodeping-contacts-api-openapi.yml Raw ↑

Other APIs NodePing publishes across the network.

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