Generated by API Evangelist
Written by API Evangelist tooling for RELEX Solutions's API. It is a proposal applied on top of the contract, not a document RELEX Solutions publishes.
overlay: 1.0.0
info:
title: API Evangelist enrichment overlay — RELEX Monitoring API
version: 1.0.0
extends: ../openapi/relex-monitoring-api-openapi.json
x-generated: '2026-08-26'
x-method: generated
x-source: Generated by the API Evangelist enrichment pipeline from this repo's artifacts and the
first-party demo client at github.com/relex/monitoring-api-demo.
actions:
- target: $.info
description: Record contract provenance and the first-party reference client.
update:
x-apievangelist-source: https://www.relexsolutions.com/api/monitoring-api-example-customer.html
x-apievangelist-extraction: 'embedded __redoc_state (ReDoc 2.1.5) — no .json/.yaml is served'
x-apievangelist-reference-client: https://github.com/relex/monitoring-api-demo
x-apievangelist-reference-client-note: >-
Python code sample (file_events.py, job_events.py), not a packaged SDK. RELEX's own README
says it "is not expected to be run as-is".
x-apievangelist-purpose: >-
Read-only operational observability over a customer's own RELEX environments — file
ingestion events, planning job events, environment inventory, platform metrics.
- target: $.info
description: Record runtime semantics.
update:
x-rate-limit:
documented: false
note: RELEX publishes no limits for the Monitoring API.
x-reversibility:
grade: na
reason: read-only surface — no write operations
x-idempotency:
grade: na
reason: read-only surface
x-anonymous-liveness:
url: https://us.monitor.relexsolutions.com/
status: 200
body_shape: '{"agents":{},"now":"<timestamp>","status":"ok"}'
note: The service root answers without authentication and is the only anonymous availability
signal RELEX exposes on any host.
- target: $.components.securitySchemes.oauth2
description: Point the oauth2 scheme at the live OpenID Connect discovery documents.
update:
x-openid-configuration-eu: https://identity.prod-eu.prod.cc.relexsolutions.com/monitoring_api_prod/.well-known/openid-configuration
x-openid-configuration-us: https://identity.prod-us.prod.cc.relexsolutions.com/monitoring_api_prod/.well-known/openid-configuration
x-scopes-declared: 0
x-scopes-note: >-
The scheme declares an EMPTY scopes map. RELEX Identity's own discovery document advertises
restapi_prod_monitoring, restapi_uat_monitoring, restapi_test_monitoring and
restapi_dev_monitoring, which are the environment-scoped monitoring scopes the contract omits.
See scopes/relex-scopes.yml.
- target: $.servers
description: Record region routing.
update:
x-apievangelist-regions:
eu: https://eu.monitor.relexsolutions.com
us: https://us.monitor.relexsolutions.com
x-apievangelist-region-note: Region selection also changes the RELEX Identity token host.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.