xMatters Events API

openapi: 3.1.0
info:
  title: xMatters REST Devices Events API
  version: '1.0'
  description: 'The xMatters REST API provides programmatic access to people, groups, on-call

    schedules, events, scenarios, and integrations on the xMatters service

    reliability platform. Endpoints derived from the public xMatters REST API

    documentation at help.xmatters.com/xmapi/.

    '
  contact:
    name: xMatters Documentation
    url: https://help.xmatters.com/xmapi/
servers:
- url: https://{company}.{deployment}.xmatters.com/api/xm/1
  description: xMatters tenant deployment
  variables:
    company:
      default: acme
      description: The customer's xMatters subdomain
    deployment:
      default: hosted
      description: Deployment cluster identifier
security:
- BasicAuth: []
- OAuth2: []
tags:
- name: Events
paths:
  /events:
    get:
      tags:
      - Events
      summary: Retrieve a list of events
      operationId: listEvents
      responses:
        '200':
          description: A list of events
    post:
      tags:
      - Events
      summary: Trigger a new event
      operationId: createEvent
      responses:
        '201':
          description: Event created
  /events/{eventId}:
    get:
      tags:
      - Events
      summary: Retrieve a specific event
      operationId: getEvent
      parameters:
      - name: eventId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: An event
    put:
      tags:
      - Events
      summary: Change the status of an event
      operationId: updateEvent
      parameters:
      - name: eventId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Updated event
  /events/{eventId}/annotations:
    get:
      tags:
      - Events
      summary: Retrieve annotations on an event
      operationId: listEventAnnotations
      parameters:
      - name: eventId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Annotations
    post:
      tags:
      - Events
      summary: Add a comment to an event
      operationId: createEventAnnotation
      parameters:
      - name: eventId
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Annotation created
components:
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using a username and password or API key.
    OAuth2:
      type: oauth2
      flows:
        password:
          tokenUrl: https://{company}.{deployment}.xmatters.com/api/xm/1/oauth2/token
          scopes: {}