openapi: 3.0.3      
info:      
  title: MongoDB Atlas Status API      
  description: |      
    The MongoDB Atlas Status API provides programmatic access to the current and historical status of MongoDB Atlas services.       
    This API is powered by Statuspage.io and allows you to retrieve summaries, component statuses, incidents, and scheduled maintenances.       
    It is useful for integrating status information into your applications, dashboards, or monitoring tools.      
          
    The status page is available at [https://status.mongodb.com/](https://status.mongodb.com/).      
  version: "2"      
  contact:      
    name: MongoDB Support      
    url: https://www.mongodb.com/support       
      
servers:      
  - url: https://status.mongodb.com/api/v2      
    description: MongoDB Atlas Status API      
      
paths:      
  /summary.json:      
    get:      
      tags: ["Status"]  
      summary: Get Status Summary      
      description: |      
        Retrieves a summary of the status page, including the overall status indicator,       
        component statuses, unresolved incidents, and upcoming or in-progress scheduled maintenances.      
      operationId: getStatusSummary      
      responses:      
        '200':      
          description: Status summary retrieved successfully      
          content:      
            application/json:      
              schema:      
                $ref: '#/components/schemas/StatusSummaryResponse'      
              example:      
                page:      
                  id: "y2j98763l56x"      
                  name: "MongoDB Cloud Status"      
                  url: "https://status.mongodb.com"      
                  updated_at: "2025-03-11T00:52:20-07:00"      
                components:      
                  - created_at: "2014-05-14T14:22:39.441-06:00"      
                    description: null      
                    id: "cp306tmzcl0y"      
                    name: "Atlas API"      
                    only_show_if_degraded: false      
                    page_id: "y2j98763l56x"      
                    position: 1      
                    status: "operational"      
                    updated_at: "2014-05-14T14:22:39.441-06:00"      
                incidents: []      
                scheduled_maintenances: []      
                status:      
                  description: "All Systems Operational"      
                  indicator: "none"      
        '404':      
          $ref: '#/components/responses/NotFound'      
        '500':      
          $ref: '#/components/responses/InternalServerError'      
      
  /status.json:      
    get:      
      tags: ["Status"]  
      summary: Get Overall Status      
      description: Retrieves the overall status rollup for the entire page.      
      operationId: getOverallStatus      
      responses:      
        '200':      
          description: Overall status retrieved successfully      
          content:      
            application/json:      
              schema:      
                $ref: '#/components/schemas/OverallStatusResponse'      
              example:      
                page:      
                  id: "y2j98763l56x"      
                  name: "MongoDB Cloud Status"      
                  url: "https://status.mongodb.com"      
                  updated_at: "2025-03-11T00:52:20-07:00"      
                status:      
                  description: "All Systems Operational"      
                  indicator: "none"      
        '404':      
          $ref: '#/components/responses/NotFound'      
        '500':      
          $ref: '#/components/responses/InternalServerError'      
      
  /components.json:      
    get:      
      tags: ["Components"]  
      summary: Get Components      
      description: Retrieves a list of components and their current statuses.      
      operationId: getComponents      
      responses:      
        '200':      
          description: Components retrieved successfully      
          content:      
            application/json:      
              schema:      
                $ref: '#/components/schemas/ComponentsResponse'      
        '404':      
          $ref: '#/components/responses/NotFound'      
        '500':      
          $ref: '#/components/responses/InternalServerError'      
      
  /incidents/unresolved.json:      
    get:      
      tags: ["Incidents"]  
      summary: Get Unresolved Incidents      
      description: "Retrieves a list of unresolved incidents (in states: Investigating, Identified, or Monitoring)."    
      operationId: getUnresolvedIncidents      
      responses:      
        '200':      
          description: Unresolved incidents retrieved successfully      
          content:      
            application/json:      
              schema:      
                $ref: '#/components/schemas/IncidentsResponse'      
        '404':      
          $ref: '#/components/responses/NotFound'      
        '500':      
          $ref: '#/components/responses/InternalServerError'      
      
  /incidents.json:      
    get:      
      tags: ["Incidents"]  
      summary: Get All Incidents      
      description: Retrieves the 50 most recent incidents, including unresolved and resolved/postmortem states.      
      operationId: getAllIncidents      
      responses:      
        '200':      
          description: All incidents retrieved successfully      
          content:      
            application/json:      
              schema:      
                $ref: '#/components/schemas/IncidentsResponse'      
        '404':      
          $ref: '#/components/responses/NotFound'      
        '500':      
          $ref: '#/components/responses/InternalServerError'      
      
  /scheduled-maintenances/upcoming.json:      
    get:      
      tags: ["Maintenance"]  
      summary: Get Upcoming Scheduled Maintenances      
      description: Retrieves a list of upcoming scheduled maintenances (in the Scheduled state).      
      operationId: getUpcomingScheduledMaintenances      
      responses:      
        '200':      
          description: Upcoming scheduled maintenances retrieved successfully      
          content:      
            application/json:      
              schema:      
                $ref: '#/components/schemas/ScheduledMaintenancesResponse'      
        '404':      
          $ref: '#/components/responses/NotFound'      
        '500':      
          $ref: '#/components/responses/InternalServerError'      
      
  /scheduled-maintenances/active.json:      
    get:      
      tags: ["Maintenance"]  
      summary: Get Active Scheduled Maintenances      
      description: Retrieves a list of active scheduled maintenances (in the In Progress or Verifying states).      
      operationId: getActiveScheduledMaintenances      
      responses:      
        '200':      
          description: Active scheduled maintenances retrieved successfully      
          content:      
            application/json:      
              schema:      
                $ref: '#/components/schemas/ScheduledMaintenancesResponse'      
        '404':      
          $ref: '#/components/responses/NotFound'      
        '500':      
          $ref: '#/components/responses/InternalServerError'      
      
  /scheduled-maintenances.json:      
    get:      
      tags: ["Maintenance"]  
      summary: Get All Scheduled Maintenances      
      description: Retrieves the 50 most recent scheduled maintenances, including all states (Scheduled, In Progress, Verifying, Completed).      
      operationId: getAllScheduledMaintenances      
      responses:      
        '200':      
          description: All scheduled maintenances retrieved successfully      
          content:      
            application/json:      
              schema:      
                $ref: '#/components/schemas/ScheduledMaintenancesResponse'      
        '404':      
          $ref: '#/components/responses/NotFound'      
        '500':      
          $ref: '#/components/responses/InternalServerError'      
      
components:      
  schemas:      
    PageInfo:      
      type: object      
      properties:      
        id:      
          type: string      
          description: Unique identifier for the page      
          example: "y2j98763l56x"      
        name:      
          type: string      
          description: Name of the status page      
          example: "MongoDB Cloud Status"      
        url:      
          type: string      
          format: uri      
          description: URL of the status page      
          example: "https://status.mongodb.com"      
        updated_at:      
          type: string      
          format: date-time      
          description: Timestamp when the page was last updated (ISO 8601)      
          example: "2025-03-11T00:52:20-07:00"      
      required:      
        - id      
        - name      
        - url      
        - updated_at      
      
    StatusIndicator:      
      type: object      
      properties:      
        description:      
          type: string      
          description: Human-readable description      
          example: "All Systems Operational"      
        indicator:      
          type: string      
          enum: ["none", "minor", "major", "critical"]      
          description: Status indicator level      
          example: "none"      
      required:      
        - description      
        - indicator      
      
    Component:      
      type: object      
      properties:      
        created_at:      
          type: string      
          format: date-time      
          description: Timestamp when the component was created (ISO 8601)      
        description:      
          type: string      
          nullable: true      
          description: Description of the component      
        id:      
          type: string      
          description: Unique identifier for the component      
        name:      
          type: string      
          description: Name of the component      
        only_show_if_degraded:      
          type: boolean      
          description: Whether to show only if degraded      
        page_id:      
          type: string      
          description: Unique page identifier      
        position:      
          type: integer      
          description: Display position      
        status:      
          type: string      
          enum: ["operational", "degraded_performance", "partial_outage", "major_outage"]      
          description: Current status of the component      
        updated_at:      
          type: string      
          format: date-time      
          description: Timestamp when the component was last updated (ISO 8601)      
      required:      
        - created_at      
        - id      
        - name      
        - only_show_if_degraded      
        - page_id      
        - position      
        - status      
        - updated_at      
      
    IncidentUpdate:      
      type: object      
      properties:      
        body:      
          type: string      
          description: Update message      
        created_at:      
          type: string      
          format: date-time      
          description: Timestamp when the update was created (ISO 8601)      
        display_at:      
          type: string      
          format: date-time
          nullable: true      
          description: Timestamp for display (ISO 8601)      
        id:      
          type: string      
          description: Unique update identifier      
        incident_id:      
          type: string      
          description: Unique incident identifier      
        status:      
          type: string      
          enum: ["investigating", "identified", "monitoring", "resolved", "postmortem", "scheduled", "in_progress", "verifying", "completed"]      
          description: Update status      
        updated_at:      
          type: string      
          format: date-time      
          description: Timestamp when the update was last modified (ISO 8601)      
      required:      
        - body      
        - created_at      
        - display_at      
        - id      
        - incident_id      
        - status      
        - updated_at      
      
    Incident:      
      type: object      
      properties:      
        created_at:      
          type: string      
          format: date-time      
          description: Timestamp when the incident was created (ISO 8601)      
        id:      
          type: string      
          description: Unique identifier for the incident      
        impact:      
          type: string      
          enum: ["none", "minor", "major", "critical", "maintenance"]      
          description: Impact level      
        incident_updates:      
          type: array      
          items:      
            $ref: '#/components/schemas/IncidentUpdate'      
          description: List of updates for the incident      
        monitoring_at:      
          type: string      
          format: date-time      
          nullable: true      
          description: Timestamp when monitoring started (ISO 8601)      
        name:      
          type: string      
          description: Incident name      
        page_id:      
          type: string      
          description: Unique page identifier      
        postmortem_body:      
          type: string      
          nullable: true      
          description: Postmortem analysis body      
        postmortem_body_last_updated_at:      
          type: string      
          format: date-time      
          nullable: true      
          description: Timestamp when postmortem was last updated (ISO 8601)      
        postmortem_ignored:      
          type: boolean      
          description: Whether postmortem is ignored      
        postmortem_notified_subscribers:      
          type: boolean      
          description: Whether subscribers were notified of postmortem      
        postmortem_published_at:      
          type: string      
          format: date-time      
          nullable: true      
          description: Timestamp when postmortem was published (ISO 8601)      
        resolved_at:      
          type: string      
          format: date-time      
          nullable: true      
          description: Timestamp when the incident was resolved (ISO 8601)      
        scheduled_for:      
          type: string      
          format: date-time      
          nullable: true      
          description: Scheduled start time (for maintenances) (ISO 8601)      
        scheduled_remind_prior:      
          type: boolean      
          description: Whether to send reminders prior to the scheduled time      
        scheduled_reminded_at:      
          type: string      
          format: date-time      
          nullable: true      
          description: Timestamp when reminders were sent (ISO 8601)      
        scheduled_until:      
          type: string      
          format: date-time      
          nullable: true      
          description: Scheduled end time (ISO 8601)      
        shortlink:      
          type: string      
          format: uri      
          description: Short URL for the incident      
        status:      
          type: string      
          enum: ["investigating", "identified", "monitoring", "resolved", "postmortem"]      
          description: Current incident status      
        updated_at:      
          type: string      
          format: date-time      
          description: Timestamp when the incident was last updated (ISO 8601)      
      required:      
        - created_at      
        - id      
        - impact      
        - incident_updates      
        - name      
        - page_id    
        - shortlink      
        - status      
        - updated_at      
      
    ScheduledMaintenance:      
      type: object      
      properties:      
        created_at:      
          type: string      
          format: date-time      
          description: Timestamp when created (ISO 8601)      
        id:      
          type: string      
          description: Unique maintenance identifier      
        impact:      
          type: string      
          enum: ["none", "minor", "major", "critical", "maintenance"]      
          description: Impact level      
        incident_updates:      
          type: array      
          items:      
            $ref: '#/components/schemas/IncidentUpdate'      
          description: List of updates      
        monitoring_at:      
          type: string      
          format: date-time      
          nullable: true      
          description: Timestamp when monitoring started (ISO 8601)      
        name:      
          type: string      
          description: Maintenance name      
        page_id:      
          type: string      
          description: Unique page identifier      
        postmortem_body:      
          type: string      
          nullable: true      
          description: Postmortem body      
        postmortem_body_last_updated_at:      
          type: string      
          format: date-time      
          nullable: true      
          description: Timestamp when the postmortem was last updated (ISO 8601)      
        postmortem_ignored:      
          type: boolean      
          description: Whether the postmortem is ignored      
        postmortem_notified_subscribers:      
          type: boolean      
          description: Whether subscribers were notified of the postmortem      
        postmortem_published_at:      
          type: string      
          format: date-time      
          nullable: true      
          description: Timestamp when the postmortem was published (ISO 8601)      
        resolved_at:      
          type: string      
          format: date-time      
          nullable: true      
          description: Timestamp when the maintenance was resolved (ISO 8601)      
        scheduled_for:      
          type: string      
          format: date-time      
          description: Scheduled start (ISO 8601)      
        scheduled_remind_prior:      
          type: boolean      
          description: Whether to send reminders prior to the scheduled maintenance      
        scheduled_reminded_at:      
          type: string      
          format: date-time      
          nullable: true      
          description: Timestamp when reminders were sent (ISO 8601)      
        scheduled_until:      
          type: string      
          format: date-time      
          description: Scheduled end time (ISO 8601)      
        shortlink:      
          type: string      
          format: uri      
          description: Short URL for the maintenance      
        status:      
          type: string      
          enum: ["scheduled", "in_progress", "verifying", "completed"]      
          description: Current maintenance status      
        updated_at:      
          type: string      
          format: date-time      
          description: Timestamp when the maintenance was last updated (ISO 8601)      
      required:      
        - created_at      
        - id      
        - impact      
        - incident_updates      
        - name      
        - page_id         
        - scheduled_for           
        - scheduled_until      
        - shortlink      
        - status      
        - updated_at      
      
    StatusSummaryResponse:      
      type: object      
      properties:      
        page:      
          $ref: '#/components/schemas/PageInfo'      
        components:      
          type: array      
          items:      
            $ref: '#/components/schemas/Component'      
          description: List of component statuses      
        incidents:      
          type: array      
          items:      
            $ref: '#/components/schemas/Incident'      
          description: List of unresolved incidents      
        scheduled_maintenances:      
          type: array      
          items:      
            $ref: '#/components/schemas/ScheduledMaintenance'      
          description: List of upcoming or active scheduled maintenances      
        status:      
          $ref: '#/components/schemas/StatusIndicator'      
      required:      
        - page      
        - components      
        - incidents      
        - scheduled_maintenances      
        - status      
      
    OverallStatusResponse:      
      type: object      
      properties:      
        page:      
          $ref: '#/components/schemas/PageInfo'      
        status:      
          $ref: '#/components/schemas/StatusIndicator'      
      required:      
        - page      
        - status      
      
    ComponentsResponse:      
      type: object      
      properties:      
        page:      
          $ref: '#/components/schemas/PageInfo'      
        components:      
          type: array      
          items:      
            $ref: '#/components/schemas/Component'      
          description: List of components      
      required:      
        - page      
        - components      
      
    IncidentsResponse:      
      type: object      
      properties:      
        page:      
          $ref: '#/components/schemas/PageInfo'      
        incidents:      
          type: array      
          items:      
            $ref: '#/components/schemas/Incident'      
          description: List of incidents      
      required:      
        - page      
        - incidents      
      
    ScheduledMaintenancesResponse:      
      type: object      
      properties:      
        page:      
          $ref: '#/components/schemas/PageInfo'      
        scheduled_maintenances:      
          type: array      
          items:      
            $ref: '#/components/schemas/ScheduledMaintenance'      
          description: List of scheduled maintenances      
      required:      
        - page      
        - scheduled_maintenances      
      
    Error:      
      type: object      
      properties:      
        message:      
          type: string      
          description: Error message      
        code:      
          type: integer      
          description: Error code      
      required:      
        - message      
      
  responses:      
    NotFound:      
      description: The requested resource was not found      
      content:      
        application/json:      
          schema:      
            $ref: '#/components/schemas/Error'      
          example:      
            message: "Resource not found"      
            code: 404      
      
    InternalServerError:      
      description: Internal server error      
      content:      
        application/json:      
          schema:      
            $ref: '#/components/schemas/Error'      
          example:      
            message: "Internal server error"      
            code: 500      
      
  securitySchemes: {}      
      
security: []      
      
tags:      
  - name: Status      
    description: MongoDB Atlas status operations including overall status, components, incidents, and scheduled maintenance