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

> ## Agent Instructions
> Keenable search and fetch work without an API key. To add them to code, use the official SDK for the project's language: https://docs.keenable.ai/sdks.md
> Read an API key from the KEENABLE_API_KEY environment variable. Never ask a user to paste a key into chat; send them to https://docs.keenable.ai/api-keys.md
> On 402 with an API key (code insufficient_credits), stop and ask a human to add credits; don't retry. On 429, wait the number of seconds in Retry-After, then retry.
> Every error, with its cause and fix: https://docs.keenable.ai/errors.md

# Bulk actions

> Pause, resume or delete many monitors at once with POST /v1/monitors/bulk, chosen by ID or by filter, with a dry run by default.

Pause, resume or delete many monitors at once, chosen by `ids`, by `filter`, or both. `dry_run` defaults to `true`, so the first call only lists what would change. Send `"dry_run": false` to apply the action.


## OpenAPI

````yaml POST /v1/monitors/bulk
openapi: 3.0.3
info:
  title: Keenable API
  version: 1.0.0
  description: Web search, page fetching and monitors API.
servers:
  - url: https://api.keenable.ai
    description: Production
security:
  - apiKey: []
  - bearerAuth: []
paths:
  /v1/monitors/bulk:
    post:
      tags:
        - Monitors
      summary: Pause, resume or delete monitors
      description: >-
        Act on many monitors at once, chosen by `ids` or by `filter`. `dry_run`
        defaults to `true`: the response lists what would change and nothing
        changes until you send `dry_run: false`. Deleting can't be undone.
      operationId: monitors.bulk
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitorBulkRequest'
      responses:
        '200':
          description: What changed, or would change
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitorBulkResult'
        '400':
          $ref: '#/components/responses/MonitorBadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/MonitorForbidden'
        '429':
          $ref: '#/components/responses/MonitorRateLimited'
        '503':
          $ref: '#/components/responses/MonitorsUnavailable'
components:
  schemas:
    MonitorBulkRequest:
      type: object
      additionalProperties: false
      required:
        - action
      anyOf:
        - required:
            - ids
        - required:
            - filter
      description: >-
        Send `ids`, a `filter`, or both. `ids` must list at least one monitor,
        and `filter` must set at least one of `status`, `name` and `metadata`.
        Otherwise the API returns `400`.
      properties:
        action:
          type: string
          enum:
            - pause
            - resume
            - delete
        ids:
          type: array
          items:
            type: string
          maxItems: 500
          minItems: 1
        filter:
          type: object
          additionalProperties: false
          properties:
            status:
              type: string
              enum:
                - active
                - paused
                - disabled
                - completed
            name:
              type: string
              description: Part of a name.
            metadata:
              type: object
              additionalProperties:
                type: string
          minProperties: 1
        limit:
          type: integer
          minimum: 1
          maximum: 500
          default: 50
          description: The most monitors to act on.
        dry_run:
          type: boolean
          default: true
          description: >-
            `true` (the default) only reports what would change. Send `false` to
            apply the action.
    MonitorBulkResult:
      type: object
      required:
        - action
        - affected
        - ids
        - dry_run
        - has_more
        - not_found
      properties:
        action:
          type: string
        affected:
          type: integer
          description: >-
            Monitors the action applied to, or would apply to, including those
            already in that state.
        ids:
          type: array
          items:
            type: string
        dry_run:
          type: boolean
        has_more:
          type: boolean
          description: '`true` if more monitors matched than `limit`.'
        not_found:
          type: array
          items:
            type: string
          description: The `ids` that aren't your organization's monitors.
    ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Short error title, such as `Invalid parameter` or `Not found`.
          example: Invalid parameter
        message:
          type: string
          description: What went wrong and what to change. Sometimes absent.
          example: '"max_results": must be an integer between 1 and 50'
        details:
          description: Structured details, when the error has any.
        retryAfter:
          type: integer
          description: >-
            Seconds to wait before retrying. Present on `429` responses from
            Keenable's own rate limits, matching the `Retry-After` header.
  headers:
    XRequestId:
      description: ID of this request. Include it when you report a problem.
      schema:
        type: string
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
      example: 1
  responses:
    MonitorBadRequest:
      description: >-
        The request is invalid. `code` is `invalid_request` for a missing or
        wrong field or a schedule that breaks a rule, and
        `monitor_option_not_supported` for a field Monitors doesn't have or
        doesn't offer yet. `message` names the field. Correct the request;
        retrying unchanged returns the same error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: >-
        No key was sent (`Missing authentication`), or the key is malformed,
        unknown or has the wrong prefix (`Authentication failed`, with
        `Malformed API key` or `Invalid API key` in `message`). Send a valid key
        in `X-API-Key` or `Authorization: Bearer`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    MonitorForbidden:
      description: >-
        Your key is valid but can't do this. `monitors_not_enabled`: Monitors is
        turned off for your organization; contact support@keenable.ai.
        `monitor_limit_reached`: your organization already has 100 active
        monitors; pause or delete one, then retry.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    MonitorRateLimited:
      description: >-
        Your organization sent more than 120 Monitors requests, or more than 10
        creates, in the last minute (`rate_limited`). Wait, then retry.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
    MonitorsUnavailable:
      description: >-
        The Monitors service didn't answer (`monitors_unavailable`). The request
        may not have been applied. Retry after a few seconds; retry a create
        with the same `Idempotency-Key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Your API key, such as `keen_...`. Create one in the Keenable console. If
        you send both this header and `Authorization`, the API uses this one.
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your API key sent as `Authorization: Bearer keen_...`, for clients that
        only support bearer tokens.

````

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