OpenZeppelin

OpenZeppelin Metrics API

Metrics are responsible for showing the metrics related to the relayers.

GitHub OpenAPI

Operations 3

GET /debug/metrics/scrape Triggers an update of system metrics and returns the result in plain text format. #
GET /metrics Metrics routes implementation #
GET /metrics/{metric_name} Returns the details of a specific metric in plain text format. #

Documentation

📖
Documentation
https://docs.openzeppelin.com/defender/sdk
📖
Authentication
https://docs.openzeppelin.com/defender/settings
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/openzeppelin/refs/heads/main/rate-limits/rate-limits.yml
📖
Documentation
https://docs.openzeppelin.com/relayer

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/openzeppelin/refs/heads/main/openapi/openzeppelin-metrics-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/OpenZeppelin/defender-sdk
📦
GitHubRepository
https://github.com/OpenZeppelin/openzeppelin-relayer

Other Resources

🔗
SDKs
https://www.npmjs.com/package/@openzeppelin/defender-sdk
🔗
ChangeLog
https://docs.openzeppelin.com/defender
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/openzeppelin/refs/heads/main/plans/plans.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/openzeppelin/refs/heads/main/finops/finops.yml
🔗
OpenAPISpec
https://raw.githubusercontent.com/api-evangelist/openzeppelin/main/openapi/openzeppelin-relayer-openapi.json
🔗
SDKs
https://github.com/OpenZeppelin/openzeppelin-relayer-sdk
🔗
Configuration
https://docs.openzeppelin.com/relayer/configuration

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/openzeppelin-metrics-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openzeppelin-metrics-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenZeppelin Relayer Health Metrics API
  description: OpenZeppelin Relayer API
  termsOfService: https://www.openzeppelin.com/tos
  contact:
    name: OpenZeppelin
    url: https://www.openzeppelin.com
  license:
    name: AGPL-3.0 license
    url: https://github.com/OpenZeppelin/openzeppelin-relayer/blob/main/LICENSE
  version: 1.5.0
servers:
- url: https://defender-api.openzeppelin.com/v2
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Metrics
  description: Metrics are responsible for showing the metrics related to the relayers.
paths:
  /debug/metrics/scrape:
    get:
      tags:
      - Metrics
      summary: Triggers an update of system metrics and returns the result in plain text format.
      description: '# Returns


        An `HttpResponse` containing the updated metrics in plain text, or an error message if the

        update fails.'
      operationId: scrape_metrics
      responses:
        '200':
          description: Complete metrics in Prometheus exposition format
          content:
            text/plain:
              schema:
                type: string
        '401':
          description: Unauthorized
  /metrics:
    get:
      tags:
      - Metrics
      summary: Metrics routes implementation
      description: 'Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file

        Returns a list of all available metric names in JSON format.


        # Returns


        An `HttpResponse` containing a JSON array of metric names.'
      operationId: list_metrics
      responses:
        '200':
          description: Metric names list
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '401':
          description: Unauthorized
  /metrics/{metric_name}:
    get:
      tags:
      - Metrics
      summary: Returns the details of a specific metric in plain text format.
      description: '# Parameters


        - `path`: The name of the metric to retrieve details for.


        # Returns


        An `HttpResponse` containing the metric details in plain text, or a 404 error if the metric is

        not found.'
      operationId: metric_detail
      parameters:
      - name: metric_name
        in: path
        description: Name of the metric to retrieve, e.g. utopia_transactions_total
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Metric details in Prometheus text format
          content:
            text/plain:
              schema:
                type: string
        '401':
          description: Unauthorized - missing or invalid API key
        '403':
          description: Forbidden - insufficient permissions to access this metric
        '404':
          description: Metric not found
        '429':
          description: Too many requests - rate limit for metrics access exceeded
      security:
      - bearer_auth:
        - metrics:read
components:
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer