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

APIIDA Monitoring API

Metrics and monitoring operations

APIIDA Monitoring API is one of 6 APIs that APIIDA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Monitoring. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://{tenant}.backend.apiida.io.

1 operations 1 paths 1 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.apiida.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

APIIDA Monitoring API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Monitoring 1

Metrics and monitoring operations

GET
/gateways/{gatewayId}/metrics
APIIDA Get Gateway Metrics
getGatewayMetrics 3 params → 200401404

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Metrics (6 properties). Each schema is shown below with its type and property counts.

Metrics
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apiida-monitoring-api-openapi.yml Raw ↑

Other APIs APIIDA publishes across the network.

APIIDA Alarms API
APIIDA Apis API
APIIDA Deployments API
APIIDA Gateways API
APIIDA Versions API