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

APIs.io Engineering Platform Monitors API

The **Monitors** endpoints enable you to manage your [monitors](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/).

This API exposes 6 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

6 operations 3 paths 7 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Monitors API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 6

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

Monitors 6

The Monitors endpoints enable you to manage your [monitors](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/).

GET
/monitors
APIs.io Engineering Platform Get all monitors
getMonitors 1 param → 200401403500
POST
/monitors
APIs.io Engineering Platform Create a monitor
createMonitor 1 param body → 200400401403500
GET
/monitors/{monitorId}
APIs.io Engineering Platform Get a monitor
getMonitor 1 param → 200401403404500
PUT
/monitors/{monitorId}
APIs.io Engineering Platform Update a monitor
updateMonitor 1 param body → 200400401403404500
DELETE
/monitors/{monitorId}
APIs.io Engineering Platform Delete a monitor
deleteMonitor 1 param → 200401403500
POST
/monitors/{monitorId}/run
APIs.io Engineering Platform Run a monitor
runMonitor 2 params → 200401403500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are common403Error (4 properties), featureUnavailable403Error (4 properties), monitors400ErrorInvalidCronPattern (1 property), monitors400ErrorInvalidTimezone (1 property). Each schema is shown below with its type and property counts.

monitors400ParamMissing
object
1 property
monitors400ErrorInvalidUid
object
1 property
workspaceId
string
featureUnavailable403Error
object
4 properties
monitors400ErrorInvalidTimezone
object
1 property
common403Error
object
4 properties
monitors400ErrorInvalidCronPattern
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-monitors-api-openapi.yml Raw ↑