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

The Hog Monitors API

The Monitors API from The Hog — 4 operation(s) for monitors.

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

Tagged areas include Monitors. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 4 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://developer.thehog.ai.

7 operations 4 paths 9 schemas 1 DELETE3 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://developer.thehog.ai
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

The Hog Monitors API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Access-Key (AccessKey). An API key is passed in the header as X-Secret-Key (SecretKey).

  • AccessKey — The public API key from the Credentials page.
  • SecretKey — The API secret shown when the credential is created.

Paths & Operations 7

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

Monitors 7
POST
/api/v1/monitors
Create monitor
createMonitor body → 201400401404500
GET
/api/v1/monitors
List monitors
listMonitors 3 params → 200401404500
PATCH
/api/v1/monitors/{id}
Update monitor
updateMonitor 1 param body → 200400401404500
DELETE
/api/v1/monitors/{id}
Delete monitor
deleteMonitor 1 param → 204401404500
GET
/api/v1/monitors/{id}
Get monitor
getMonitor 1 param → 200401404500
POST
/api/v1/monitors/{id}/run-now
Run monitor now
runMonitorNow 1 param body → 202400401404500
GET
/api/v1/monitors/{id}/events
List monitor events
listMonitorEvents 4 params → 200401404500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are MonitorResponseDto (11 properties), CreateMonitorDto (8 properties), MonitorEventDto (8 properties), UpdateMonitorDto (7 properties). Each schema is shown below with its type and property counts.

MonitorResponseDto
object
11 properties 11 required
PublicValidationErrorItemDto
object
3 properties 2 required
RunNowBodyDto
object
1 property
MonitorEventListResponseDto
object
2 properties 2 required
UpdateMonitorDto
object
7 properties
MonitorListResponseDto
object
2 properties 2 required
CreateMonitorDto
object
8 properties 3 required
PublicErrorResponseDto
object
7 properties 5 required
MonitorEventDto
object
8 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-hog-monitors-api-openapi.yml Raw ↑

Other APIs The Hog publishes across the network.

The Hog Company Search API
The Hog Deep Research API
The Hog Enrichments API
The Hog Operations API
The Hog People Search API
The Hog Scrapers API
The Hog Search API