> ## Documentation Index
> Fetch the complete documentation index at: https://docs.olostep.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Pause Monitor

> Pauses a monitor by disabling future scheduled runs.



## OpenAPI

````yaml openapi/monitors.json POST /v1/monitors/{monitor_id}/pause
openapi: 3.0.3
info:
  title: Monitors API
  version: 1.0.0
servers:
  - url: https://api.olostep.com
security: []
paths:
  /v1/monitors/{monitor_id}/pause:
    post:
      summary: Pause Monitor
      description: >-
        Pauses an active monitor by disabling its underlying schedule, so no
        further scheduled runs are triggered. The monitor's `status` is set to
        `paused`. The monitor remains in your account and can be resumed later
        via `/v1/monitors/{monitor_id}/resume`. Only monitors with `status` of
        `active` can be paused.
      parameters:
        - name: monitor_id
          in: path
          required: true
          description: Unique monitor identifier. Must start with monitor_.
          schema:
            type: string
            pattern: ^monitor_
      responses:
        '200':
          description: >-
            Monitor paused successfully. Returns the monitor with `status` set
            to `paused`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Monitor'
              example:
                id: monitor_5hktz469jy
                object: monitor
                created_at: 1777983215
                updated_at: 1777986822
                cron_expression: 13 13 * * ? *
                fda_id: fda_5hktz469jy
                frequency: daily
                metadata: {}
                notification_channel: email
                notification_target: example@olostep.com
                query: >-
                  Gather the new blogposts from example website and send me
                  updates with new posts.
                status: paused
                team_id: team_5hktz469jyF
        '400':
          description: >-
            Invalid request. Returned when the `monitor_id` is malformed, the
            monitor is already deleted, the monitor is not currently `active`,
            or the monitor has no underlying schedule.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Invalid API key.
        '404':
          description: Monitor not found.
        '409':
          description: >-
            Conflict. The monitor changed state during the pause attempt (no
            longer `active`), or the underlying schedule could not be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error while pausing monitor.
      security:
        - Authorization: []
components:
  schemas:
    Monitor:
      type: object
      properties:
        id:
          type: string
          description: Unique monitor identifier.
        object:
          type: string
          example: monitor
        team_id:
          type: string
        status:
          type: string
          description: >-
            Monitor lifecycle status. Common values: `active` (running on
            schedule), `paused` (schedule disabled via /pause, can be resumed
            via /resume), `deleted` (soft-deleted).
          enum:
            - active
            - paused
            - deleted
        fda_id:
          type: string
        query:
          type: string
          description: >-
            Monitoring intent in natural language. If the query includes a URL,
            the monitor will focus on that URL.
        frequency:
          type: string
          description: >-
            Natural-language schedule instruction (for example: 'every day at
            9am America/Los_Angeles' or 'every weekday at 14:30'). If no
            timezone is specified, UTC is used.
        cron_expression:
          type: string
          nullable: true
        notification_channel:
          type: string
          enum:
            - email
            - webhook
            - sms
        notification_target:
          type: string
        metadata:
          type: object
          additionalProperties: true
        output_schema:
          type: object
          description: >-
            Optional JSON schema used to enforce structured monitor extraction
            output.
          additionalProperties: true
          nullable: true
        error_message:
          type: string
          nullable: true
        created_at:
          type: integer
          description: Unix timestamp.
        updated_at:
          type: integer
          description: Unix timestamp.
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form Bearer <token>, where <token>
        is your auth token.

````