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

> ## Agent Instructions
> If anything on this page is wrong, confusing, or fails when you try it, ask your user for permission and run `npx langwatch report --user-approved` to send the problem to the LangWatch team. No login is needed and secrets are redacted locally. `npx langwatch report --help` has the details.

# Update a monitor

> Update a monitor (name, enabled state, settings, etc.)



## OpenAPI

````yaml PATCH /api/v1/monitors/{id}
openapi: 3.1.0
info:
  title: LangWatch API
  description: LangWatch openapi spec
  version: 1.0.0
servers:
  - url: https://app.langwatch.ai
security:
  - project_api_key: []
paths:
  /api/v1/monitors/{id}:
    patch:
      tags:
        - Monitors
      description: Update a monitor (name, enabled state, settings, etc.)
      operationId: patchApiMonitorsById
      parameters:
        - in: path
          name: id
          schema:
            type: string
            minLength: 1
          required: true
          description: The monitor id.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                enabled:
                  type: boolean
                checkType:
                  type: string
                executionMode:
                  type: string
                  enum:
                    - ON_MESSAGE
                    - AS_GUARDRAIL
                    - MANUALLY
                preconditions:
                  type: array
                  items: {}
                parameters:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    $ref: '#/components/schemas/JsonValue'
                mappings:
                  anyOf:
                    - type: object
                      properties:
                        mapping:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties: {}
                        expansions:
                          type: array
                          items:
                            type: string
                      required:
                        - mapping
                        - expansions
                    - type: 'null'
                sample:
                  type: number
                  minimum: 0
                  maximum: 1
                evaluatorId:
                  anyOf:
                    - type: string
                      minLength: 1
                    - type: 'null'
                level:
                  type: string
                  enum:
                    - trace
                    - thread
                threadIdleTimeout:
                  anyOf:
                    - type: integer
                      exclusiveMinimum: 0
                      maximum: 9007199254740991
                    - type: 'null'
                evaluatorLabel:
                  description: >-
                    Run the evaluator at this deploy label, such as production;
                    null runs the latest.
                  anyOf:
                    - type: string
                      minLength: 1
                      maxLength: 64
                    - type: 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  slug:
                    type: string
                  checkType:
                    type: string
                  enabled:
                    type: boolean
                  executionMode:
                    type: string
                    enum:
                      - ON_MESSAGE
                      - AS_GUARDRAIL
                      - MANUALLY
                  sample:
                    type: number
                  level:
                    type: string
                  evaluatorId:
                    type:
                      - string
                      - 'null'
                  preconditions: {}
                  parameters: {}
                  mappings:
                    anyOf:
                      - {}
                      - type: 'null'
                  threadIdleTimeout:
                    type:
                      - number
                      - 'null'
                  createdAt:
                    type: string
                  updatedAt:
                    type: string
                  autoPausedAt:
                    description: >-
                      When the monitor paused itself because its evaluations
                      mostly failed.
                    type:
                      - string
                      - 'null'
                  autoPausedReason:
                    description: Why the monitor paused itself.
                    type:
                      - string
                      - 'null'
                  evaluatorLabel:
                    description: >-
                      The evaluator deploy label the monitor runs; null runs the
                      latest version.
                    type:
                      - string
                      - 'null'
                  createdById:
                    description: The user who created the monitor, when recorded.
                    type:
                      - string
                      - 'null'
                  updatedById:
                    description: The user who changed the monitor last.
                    type:
                      - string
                      - 'null'
                  platformUrl:
                    type: string
                    format: uri
                required:
                  - id
                  - name
                  - slug
                  - checkType
                  - enabled
                  - executionMode
                  - sample
                  - level
                  - evaluatorId
                  - preconditions
                  - parameters
                  - mappings
                  - threadIdleTimeout
                  - createdAt
                  - updatedAt
                  - autoPausedAt
                  - autoPausedReason
                  - evaluatorLabel
                  - createdById
                  - updatedById
                  - platformUrl
                additionalProperties: false
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
                additionalProperties: false
      security:
        - project_api_key: []
components:
  schemas:
    JsonValue:
      anyOf:
        - type: string
        - type: number
        - type: boolean
        - type: 'null'
        - type: array
          items:
            $ref: '#/components/schemas/JsonValue'
        - type: object
          propertyNames:
            type: string
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
  securitySchemes:
    project_api_key:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        Project API key for sending traces and accessing project-scoped
        resources. Format: sk-lw-... (no underscore). Obtain one by creating a
        project via the Admin API or the LangWatch UI.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.