IBM WebSphere Metrics API

MicroProfile Metrics API

Operations 4

GET /metrics Get All Metrics #
GET /metrics/base Get Base Metrics #
GET /metrics/vendor Get Vendor Metrics #
GET /metrics/application Get Application Metrics #

Documentation

📖
Documentation
https://www.ibm.com/docs/en/was/9.0.5?topic=overview-administrative-rest-api
📖
Authentication
https://www.ibm.com/docs/en/was/9.0.5?topic=api-authentication-authorization
📖
GettingStarted
https://www.ibm.com/docs/en/was-nd/9.0.5?topic=specifications-discovering-rest-api-documentation
📖
APIReference
https://www.ibm.com/docs/en/was/9.0.5?topic=javadoc-apis-application-programming-interfaces
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-admin-rest-api
📖
GettingStarted
https://www.ibm.com/docs/en/was-liberty/base?topic=api-getting-started
📖
APIReference
https://openliberty.io/docs/latest/reference/feature/restConnector-2.0.html
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/base?topic=center-setting-up-admin
📖
Documentation
https://openliberty.io/docs/latest/reference/feature/restConnector-2.0.html
📖
APIReference
https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html
📖
Documentation
https://openliberty.io/docs/latest/configuring-jmx-connection.html
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/core?topic=features-admin-rest-connector-20
📖
Documentation
https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-introduction
📖
APIReference
https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-reference
📖
Authentication
https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-authentication
📖
GettingStarted
https://developer.ibm.com/tutorials/mq-develop-mq-rest-api/
📖
Documentation
https://www.ibm.com/docs/en/ibm-mq/9.3?topic=mq-messaging-using-rest-api
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-collective-rest-api
📖
APIReference
https://www.ibm.com/docs/en/was-liberty/base?topic=api-collective-reference
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/base?topic=deploying-applications-in-liberty
📖
Documentation
https://www.ibm.com/docs/en/ws-automation?topic=apis
📖
APIReference
https://www.ibm.com/docs/en/ws-automation?topic=reference-rest-api
📖
Documentation
https://www.ibm.com/docs/en/ws-automation?topic=viewing-rest-api
📖
Documentation
https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html
📖
APIReference
https://openliberty.io/docs/latest/documentation-openapi.html
📖
GettingStarted
https://openliberty.io/guides/rest-intro.html
📖
Documentation
https://openliberty.io/docs/latest/microprofile.html

Specifications

Schemas & Data

Other Resources

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/websphere-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.

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

OpenAPI Specification

websphere-metrics-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Open Liberty Metrics API
  description: Open Liberty provides application programming interfaces that extend and complement Jakarta EE and MicroProfile APIs. Includes APIs for security, admin connectors, batch processing, messaging, health checking, metrics, OpenAPI documentation, and more. Open Liberty is the open-source foundation for WebSphere Liberty.
  version: 24.0.0
  license:
    name: Eclipse Public License 1.0
    url: https://www.eclipse.org/legal/epl-v10.html
  contact:
    name: Open Liberty Community
    url: https://openliberty.io/
servers:
- url: https://localhost:9443
  description: Default Open Liberty Server
security:
- basicAuth: []
tags:
- name: Metrics
  description: MicroProfile Metrics API
paths:
  /metrics:
    get:
      operationId: getAllMetrics
      summary: Get All Metrics
      description: Returns all available metrics in Prometheus or JSON format.
      tags:
      - Metrics
      parameters:
      - name: Accept
        in: header
        description: Response format
        schema:
          type: string
          enum:
          - application/json
          - text/plain
          default: text/plain
        example: application/json
      - name: scope
        in: query
        description: Metrics scope filter
        schema:
          type: string
          enum:
          - base
          - vendor
          - application
        example: base
      responses:
        '200':
          description: Metrics data
          content:
            text/plain:
              schema:
                type: string
                description: Prometheus format metrics
              examples:
                Getallmetrics200Example:
                  summary: Default getAllMetrics 200 response
                  x-microcks-default: true
                  value: example_value
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsResponse'
              examples:
                Getallmetrics200Example:
                  summary: Default getAllMetrics 200 response
                  x-microcks-default: true
                  value: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /metrics/base:
    get:
      operationId: getBaseMetrics
      summary: Get Base Metrics
      description: Returns base metrics defined by the MicroProfile Metrics specification.
      tags:
      - Metrics
      responses:
        '200':
          description: Base metrics data
          content:
            text/plain:
              schema:
                type: string
              examples:
                Getbasemetrics200Example:
                  summary: Default getBaseMetrics 200 response
                  x-microcks-default: true
                  value: example_value
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsResponse'
              examples:
                Getbasemetrics200Example:
                  summary: Default getBaseMetrics 200 response
                  x-microcks-default: true
                  value: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /metrics/vendor:
    get:
      operationId: getVendorMetrics
      summary: Get Vendor Metrics
      description: Returns Liberty-specific vendor metrics.
      tags:
      - Metrics
      responses:
        '200':
          description: Vendor metrics data
          content:
            text/plain:
              schema:
                type: string
              examples:
                Getvendormetrics200Example:
                  summary: Default getVendorMetrics 200 response
                  x-microcks-default: true
                  value: example_value
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsResponse'
              examples:
                Getvendormetrics200Example:
                  summary: Default getVendorMetrics 200 response
                  x-microcks-default: true
                  value: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /metrics/application:
    get:
      operationId: getApplicationMetrics
      summary: Get Application Metrics
      description: Returns application-defined custom metrics.
      tags:
      - Metrics
      responses:
        '200':
          description: Application metrics data
          content:
            text/plain:
              schema:
                type: string
              examples:
                Getapplicationmetrics200Example:
                  summary: Default getApplicationMetrics 200 response
                  x-microcks-default: true
                  value: example_value
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsResponse'
              examples:
                Getapplicationmetrics200Example:
                  summary: Default getApplicationMetrics 200 response
                  x-microcks-default: true
                  value: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
      required:
      - code
      - message
    MetricsResponse:
      type: object
      additionalProperties:
        type: object
        properties:
          displayName:
            type: string
          description:
            type: string
          unit:
            type: string
          type:
            type: string
            enum:
            - counter
            - gauge
            - timer
            - histogram
            - simple_timer
            - concurrent_gauge
          value:
            type: number
          tags:
            type: object
            additionalProperties:
              type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: MicroProfile JWT authentication
externalDocs:
  description: Open Liberty API Reference
  url: https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html