EXexa
Monitors

Update a monitor

Changed on

Updates an existing monitor. All fields are optional. For search, you can send a partial object containing only the fields you want to change. Set trigger to null to remove the schedule.

patch/monitors/{id}

Request

  • Base URL
    https://api.exa.ai
  • URL
    https://api.exa.ai/monitors/{id}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

idstring required

The monitor ID

Request body

namestring nullable

Update the monitor name

status'active' | 'paused'

Update the monitor status (can only set to active or paused)

metadataobject nullable

Caller-provided key-value metadata for your own tracking.

Response

The updated monitor

idstring required

The unique identifier for the monitor

namestring nullable required

An optional display name

status'active' | 'paused' | 'disabled' required

The status of the monitor. active monitors run on schedule and can be triggered manually. paused monitors can only be triggered manually. disabled monitors are auto-disabled after 10 consecutive authentication failures.

metadataobject nullable required

Caller-provided key-value metadata for your own tracking.

nextRunAtstring date-time nullable required

When the next scheduled run will occur. Null if no trigger is set.

createdAtstring date-time required

When the monitor was created

updatedAtstring date-time required

When the monitor was last updated

Changes

  • 69325a6257a1Revision changes
    • info

      request property // deprecated

    • info

      response property search/contents/livecrawl deprecated

  • bdc8cb31dce4Revision changes
    • info

      request property //// deprecated

    • info

      request property //// deprecated

    • info

      request property /////// deprecated

    • info

      response property search/contents/extras/codeBlocks/anyOf[subschema #1]/ deprecated

    • info

      response property search/contents/extras/richLinks/anyOf[subschema #1]/ deprecated

    • info

      response property search/contents/summary/oneOf[SummaryWithMaxTokensOptionsOutput]/maxTokens deprecated