IBM WebSphere Notifications API

Alert and notification management

Operations 5

GET /notifications List Notifications #
POST /notifications Create a Notification Subscription #
POST /notifications/{notificationId}/read Mark Notification as Read #
GET /notifications/{subscriptionId} Get Pending Notifications #
DELETE /notifications/{subscriptionId} Delete a Notification Subscription #

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-notifications-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-notifications-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Websphere Notifications API
  contact:
    name: IBM Support
    url: https://www.ibm.com/mysupport
  license:
    name: IBM International License Agreement
    url: https://www.ibm.com/legal/terms
  version: '1.0'
  description: 'Operations tagged Notifications across 2 of this provider''s published API definitions: websphere-automation-rest-api.yml, websphere-liberty-rest-connector-api.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://automation-api.example.com/v1
  description: WebSphere Automation API Server
- url: https://localhost:9443/IBMJMXConnectorREST/api
  description: Default Liberty JMX REST Connector
tags:
- name: Notifications
  description: Alert and notification management
paths:
  /notifications:
    get:
      operationId: listNotifications
      summary: List Notifications
      description: Returns a list of notifications and alerts.
      tags:
      - Notifications
      parameters:
      - name: type
        in: query
        description: Filter by notification type
        schema:
          type: string
          enum:
          - vulnerability
          - health
          - compliance
          - fix
        example: vulnerability
      - name: read
        in: query
        description: Filter by read status
        schema:
          type: boolean
        example: true
      responses:
        '200':
          description: List of notifications
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Notification'
              examples:
                Listnotifications200Example:
                  summary: Default listNotifications 200 response
                  x-microcks-default: true
                  value:
                  - id: abc123
                    type: vulnerability
                    severity: info
                    title: Example Title
                    message: example_value
                    read: true
                    createdDate: '2026-01-15T10:30:00Z'
                    relatedResourceId: '500123'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - bearerAuth: []
    post:
      operationId: createNotificationSubscription
      summary: Create a Notification Subscription
      description: Subscribes to notifications from a specific MBean.
      tags:
      - Notifications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - objectName
              properties:
                objectName:
                  type: string
                  description: ObjectName of the MBean to subscribe to
                filters:
                  type: array
                  items:
                    type: string
                  description: Notification type filters
            examples:
              CreatenotificationsubscriptionRequestExample:
                summary: Default createNotificationSubscription request
                x-microcks-default: true
                value:
                  objectName: example_value
                  filters:
                  - example_value
      responses:
        '201':
          description: Notification subscription created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSubscription'
              examples:
                Createnotificationsubscription201Example:
                  summary: Default createNotificationSubscription 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    objectName: example_value
                    filters:
                    - example_value
                    created: '2026-01-15T10:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - bearerAuth: []
    servers:
    - url: https://automation-api.example.com/v1
      description: WebSphere Automation API Server
  /notifications/{notificationId}/read:
    post:
      operationId: markNotificationRead
      summary: Mark Notification as Read
      description: Marks a notification as read.
      tags:
      - Notifications
      parameters:
      - name: notificationId
        in: path
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: Notification marked as read
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - bearerAuth: []
    servers:
    - url: https://automation-api.example.com/v1
      description: WebSphere Automation API Server
  /notifications/{subscriptionId}:
    get:
      operationId: getNotifications
      summary: Get Pending Notifications
      description: Returns pending notifications for a subscription.
      tags:
      - Notifications
      parameters:
      - name: subscriptionId
        in: path
        required: true
        description: Subscription identifier
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: Pending notifications
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Notification_2'
              examples:
                Getnotifications200Example:
                  summary: Default getNotifications 200 response
                  x-microcks-default: true
                  value:
                  - type: example_value
                    source: example_value
                    message: example_value
                    sequenceNumber: 10
                    timestamp: 10
                    userData: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    delete:
      operationId: deleteNotificationSubscription
      summary: Delete a Notification Subscription
      description: Unsubscribes from notifications.
      tags:
      - Notifications
      parameters:
      - name: subscriptionId
        in: path
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '204':
          description: Subscription deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    servers:
    - url: https://localhost:9443/IBMJMXConnectorREST/api
      description: Default Liberty JMX REST Connector
components:
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request
      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
    Notification:
      type: object
      properties:
        id:
          type: string
          example: abc123
        type:
          type: string
          enum:
          - vulnerability
          - health
          - compliance
          - fix
          example: vulnerability
        severity:
          type: string
          enum:
          - info
          - warning
          - critical
          example: info
        title:
          type: string
          example: Example Title
        message:
          type: string
          example: example_value
        read:
          type: boolean
          example: true
        createdDate:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        relatedResourceId:
          type: string
          example: '500123'
    Notification_2:
      type: object
      properties:
        type:
          type: string
          example: example_value
        source:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
        sequenceNumber:
          type: integer
          example: 10
        timestamp:
          type: integer
          example: 10
        userData:
          type: object
          additionalProperties: true
          example: example_value
    NotificationSubscription:
      type: object
      properties:
        id:
          type: string
          example: abc123
        objectName:
          type: string
          example: example_value
        filters:
          type: array
          items:
            type: string
          example: []
        created:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT Bearer token authentication
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with administrator role
x-refined-from:
- websphere-automation-rest-api.yml
- websphere-liberty-rest-connector-api.yml