Servers Playground How we check Add a server Log in

OneUptime

Working · 1.8 s

com.oneuptime/mcpv14.0.88 Domain verified

Manage incidents, alerts, monitors, status pages, on-call and telemetry in OneUptime.

Cloud & DevOps

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://oneuptime.com/mcp

x-api-key (optional)

Optional. A OneUptime project API key, for agents that run unattended. Leave it empty to sign in with your OneUptime account instead.

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

acknowledge_alert Destructive

Acknowledge an alert: marks it as being worked on by moving it to the project's 'Acknowledged' state. An alert that is already acknowledged - in the Acknowledged state, a state placed after it, or resolved - is left as it is.

alertIdstring, required

UUID of the alert to acknowledge. Use list_alerts to find it.

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

OneUptime MCP server | mcptry

OneUptime

Working · 1.8 s

com.oneuptime/mcpv14.0.88 Domain verified

Manage incidents, alerts, monitors, status pages, on-call and telemetry in OneUptime.

Cloud & DevOps

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://oneuptime.com/mcp

x-api-key (optional)

Optional. A OneUptime project API key, for agents that run unattended. Leave it empty to sign in with your OneUptime account instead.

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

acknowledge_alert Destructive

alertIdstring, required

UUID of the alert to acknowledge. Use list_alerts to find it.

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

Tools (199)

Tool list last changed Oct 25, 2026.

acknowledge_alert

destructive

Argument	Type	Description
alertId*	string	UUID of the alert to acknowledge. Use list_alerts to find it.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "alertId"
  ],
  "properties": {
    "alertId": {
      "type": "string",
      "description": "UUID of the alert to acknowledge. Use list_alerts to find it."
    }
  },
  "additionalProperties": false
}

acknowledge_incident

Acknowledge an incident: marks it as being worked on by moving it to the project's 'Acknowledged' state. Equivalent to pressing 'Acknowledge' in the OneUptime dashboard. An incident that is already acknowledged - in the Acknowledged state, a state placed after it, or resolved - is left as it is.

destructive

Argument	Type	Description
incidentId*	string	UUID of the incident to acknowledge. Use list_incidents to find it.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "incidentId"
  ],
  "properties": {
    "incidentId": {
      "type": "string",
      "description": "UUID of the incident to acknowledge. Use list_incidents to find it."
    }
  },
  "additionalProperties": false
}

add_alert_note

Add an internal note to an alert, visible to your team. Markdown is supported.

destructive

Argument	Type	Description
note*	string	The note content (Markdown supported).
alertId*	string	UUID of the alert to annotate.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "alertId",
    "note"
  ],
  "properties": {
    "note": {
      "type": "string",
      "description": "The note content (Markdown supported)."
    },
    "alertId": {
      "type": "string",
      "description": "UUID of the alert to annotate."
    }
  },
  "additionalProperties": false
}

add_incident_note

Add a note to an incident. Internal notes are visible to your team only; public notes are posted to the status page for subscribers/customers. Markdown is supported.

destructive

Argument	Type	Description
note*	string	The note content (Markdown supported).
incidentId*	string	UUID of the incident to annotate.
visibility	string	Where the note is visible: 'internal' (team only, default) or 'public' (posted to the status page).

Input schema (JSON)

{
  "type": "object",
  "required": [
    "incidentId",
    "note"
  ],
  "properties": {
    "note": {
      "type": "string",
      "description": "The note content (Markdown supported)."
    },
    "incidentId": {
      "type": "string",
      "description": "UUID of the incident to annotate."
    },
    "visibility": {
      "enum": [
        "internal",
        "public"
      ],
      "type": "string",
      "default": "internal",
      "description": "Where the note is visible: 'internal' (team only, default) or 'public' (posted to the status page)."
    }
  },
  "additionalProperties": false
}

count_alert_internal_notes

Count the total number of Alert Internal Notes in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Alert Internal Notes. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "note": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for note field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "alertId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for alertId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "postedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for postedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "attachments": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for attachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOwnerNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "savedFromChatMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for savedFromChatMessage field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "postedFromSlackMessageId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postedFromSlackMessageId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Alert Internal Notes. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_alert_severities

Count the total number of Alert Severities in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Alert Severities. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "color": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "order": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 10
          },
          "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Alert Severities. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_alert_state_timelines

Count the total number of Alert State Timelines in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Alert State Timelines. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "endsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "alertId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for alertId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "startsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "rootCause": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "alertStateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for alertStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "stateChangeLog": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for stateChangeLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOwnerNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Alert State Timelines. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_alert_states

Count the total number of Alert States in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Alert States. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "color": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "order": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 10
          },
          "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "isCreatedState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isCreatedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isResolvedState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isResolvedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isAcknowledgedState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isAcknowledgedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Alert States. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_alerts

Count the total number of Alerts in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Alerts. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "hosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for hosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "title": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for title field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "labels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "services": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for services field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "iotFleets": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for iotFleets field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "isPrivate": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isPrivate field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "monitorId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for monitorId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "rootCause": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "alertNumber": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for alertNumber field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "dockerHosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "podmanHosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for podmanHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "cephClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for cephClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "customFields": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "firstPagedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for firstPagedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "seriesLabels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for seriesLabels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "storageArrays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for storageArrays field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "alertEpisodeId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for alertEpisodeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "monitorSummary": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for monitorSummary field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "telemetryQuery": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for telemetryQuery field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "vmwareVCenters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for vmwareVCenters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "alertSeverityId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for alertSeverityId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "createdStateLog": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for createdStateLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "databaseServers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for databaseServers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "dockerResources": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "enableReminders": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableReminders field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "impactStartedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for impactStartedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "podmanResources": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for podmanResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "proxmoxClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for proxmoxClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByProbeId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByProbeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "remediationNotes": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for remediationNotes field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdCriteriaId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for createdCriteriaId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "seriesFingerprint": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for seriesFingerprint field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "kubernetesClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for kubernetesClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "onCallDutyPolicies": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for onCallDutyPolicies field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "currentAlertStateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for currentAlertStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "dockerSwarmClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerSwarmClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "kubernetesResources": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for kubernetesResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "kubernetesContainers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for kubernetesContainers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "alertNumberWithPrefix": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for alertNumberWithPrefix field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "isCreatedAutomatically": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isCreatedAutomatically field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "serviceLevelObjectives": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for serviceLevelObjectives field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "aiInvestigationDecision": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for aiInvestigationDecision field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "aiInvestigationWaitUntil": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for aiInvestigationWaitUntil field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "nextReminderNotificationAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for nextReminderNotificationAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "reminderNotificationSentCount": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for reminderNotificationSentCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isOwnerNotifiedOfAlertCreation": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotifiedOfAlertCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "postUpdatesToWorkspaceChannels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "monitorStatusWhenThisAlertWasCreatedId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for monitorStatusWhenThisAlertWasCreatedId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Alerts. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_change_events

Count Change Events telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.

read-only

Argument	Type	Description
query	object	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "time": {
          "type": "string",
          "description": "time field"
        },
        "title": {
          "type": "string",
          "description": "title field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "eventType": {
          "type": "string",
          "description": "eventType field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "attributes": {
          "type": "string",
          "description": "attributes field"
        },
        "description": {
          "type": "string",
          "description": "description field"
        },
        "attributeKeys": {
          "type": "string",
          "description": "attributeKeys field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        }
      },
      "description": "Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_exception_instances

Count Exception Instances telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.

read-only

Argument	Type	Description
query	object	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "time": {
          "type": "string",
          "description": "time field"
        },
        "spanId": {
          "type": "string",
          "description": "spanId field"
        },
        "escaped": {
          "type": "string",
          "description": "escaped field"
        },
        "message": {
          "type": "string",
          "description": "message field"
        },
        "release": {
          "type": "string",
          "description": "release field"
        },
        "traceId": {
          "type": "string",
          "description": "traceId field"
        },
        "spanName": {
          "type": "string",
          "description": "spanName field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "sessionId": {
          "type": "string",
          "description": "sessionId field"
        },
        "attributes": {
          "type": "string",
          "description": "attributes field"
        },
        "entityKeys": {
          "type": "string",
          "description": "entityKeys field"
        },
        "stackTrace": {
          "type": "string",
          "description": "stackTrace field"
        },
        "environment": {
          "type": "string",
          "description": "environment field"
        },
        "fingerprint": {
          "type": "string",
          "description": "fingerprint field"
        },
        "parsedFrames": {
          "type": "string",
          "description": "parsedFrames field"
        },
        "timeUnixNano": {
          "type": "string",
          "description": "timeUnixNano field"
        },
        "attributeKeys": {
          "type": "string",
          "description": "attributeKeys field"
        },
        "exceptionType": {
          "type": "string",
          "description": "exceptionType field"
        },
        "hostEntityKey": {
          "type": "string",
          "description": "hostEntityKey field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "spanStatusCode": {
          "type": "string",
          "description": "spanStatusCode field"
        },
        "k8sPodEntityKey": {
          "type": "string",
          "description": "k8sPodEntityKey field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "k8sNodeEntityKey": {
          "type": "string",
          "description": "k8sNodeEntityKey field"
        },
        "serviceEntityKey": {
          "type": "string",
          "description": "serviceEntityKey field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        },
        "containerEntityKey": {
          "type": "string",
          "description": "containerEntityKey field"
        },
        "k8sClusterEntityKey": {
          "type": "string",
          "description": "k8sClusterEntityKey field"
        }
      },
      "description": "Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_incident_alerts

Count the total number of Incident Alerts in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Incident Alerts. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "alertId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for alertId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "incidentId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Incident Alerts. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_incident_internal_notes

Count the total number of Incident Internal Notes in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Incident Internal Notes. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "note": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for note field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "postedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for postedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "incidentId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "attachments": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for attachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOwnerNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "savedFromChatMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for savedFromChatMessage field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "postedFromSlackMessageId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postedFromSlackMessageId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Incident Internal Notes. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_incident_public_notes

Count the total number of Incident Public Notes in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Incident Public Notes. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "note": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for note field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "postedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for postedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "incidentId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "attachments": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for attachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOwnerNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "savedFromChatMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for savedFromChatMessage field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "postedFromSlackMessageId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postedFromSlackMessageId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "postedWithIncidentStateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for postedWithIncidentStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "subscriberNotificationStatusMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationStatusOnNoteCreated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatusOnNoteCreated field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationStatusOnNoteUpdated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatusOnNoteUpdated field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationStatusMessageOnNoteUpdated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessageOnNoteUpdated field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "shouldStatusPageSubscribersBeNotifiedOnNoteCreated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldStatusPageSubscribersBeNotifiedOnNoteCreated field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Incident Public Notes. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_incident_severities

Count the total number of Incident Severities in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Incident Severities. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "color": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "order": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 10
          },
          "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Incident Severities. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_incident_state_timelines

Count the total number of Incident State Timelines in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Incident State Timelines. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "endsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "startsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "rootCause": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "incidentId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "stateChangeLog": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for stateChangeLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "incidentStateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incidentStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOwnerNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "subscriberNotificationStatus": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatus field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationStatusMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "shouldStatusPageSubscribersBeNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldStatusPageSubscribersBeNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Incident State Timelines. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_incident_states

Count the total number of Incident States in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Incident States. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "color": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "order": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 10
          },
          "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "isCreatedState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isCreatedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isResolvedState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isResolvedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isAcknowledgedState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isAcknowledgedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Incident States. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_incidents

Count the total number of Incidents in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Incidents. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "hosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for hosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "title": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for title field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "labels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "monitors": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for monitors field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "services": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for services field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "iotFleets": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for iotFleets field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "isPrivate": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isPrivate field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "rootCause": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "declaredAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for declaredAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "dockerHosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "podmanHosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for podmanHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "statusPages": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for statusPages field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "cephClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for cephClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "customFields": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "firstPagedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for firstPagedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "seriesLabels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for seriesLabels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "holdsMonitors": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for holdsMonitors field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "storageArrays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for storageArrays field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "incidentNumber": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for incidentNumber field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "monitorSummary": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for monitorSummary field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "postmortemNote": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postmortemNote field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "telemetryQuery": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for telemetryQuery field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "vmwareVCenters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for vmwareVCenters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "createdStateLog": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for createdStateLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "databaseServers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for databaseServers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "dockerResources": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "enableReminders": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableReminders field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "impactStartedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for impactStartedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "podmanResources": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for podmanResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "proxmoxClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for proxmoxClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByProbeId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByProbeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "remediationNotes": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for remediationNotes field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdCriteriaId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for createdCriteriaId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "incidentEpisodeId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incidentEpisodeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "seriesFingerprint": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for seriesFingerprint field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "incidentSeverityId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incidentSeverityId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "kubernetesClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for kubernetesClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "onCallDutyPolicies": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for onCallDutyPolicies field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "postmortemPostedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for postmortemPostedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "postmortemStatusId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for postmortemStatusId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "dockerSwarmClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerSwarmClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "kubernetesResources": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for kubernetesResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "kubernetesContainers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for kubernetesContainers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "isScopedToStatusPages": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isScopedToStatusPages field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "isVisibleOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isVisibleOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "postmortemAttachments": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postmortemAttachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "currentIncidentStateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for currentIncidentStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isCreatedAutomatically": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isCreatedAutomatically field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "serviceLevelObjectives": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for serviceLevelObjectives field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "aiInvestigationDecision": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for aiInvestigationDecision field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "changeMonitorStatusToId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for changeMonitorStatusToId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "aiInvestigationWaitUntil": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for aiInvestigationWaitUntil field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "incidentNumberWithPrefix": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for incidentNumberWithPrefix field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdIncidentTemplateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for createdIncidentTemplateId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "nextReminderNotificationAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for nextReminderNotificationAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "showPostmortemOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showPostmortemOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "postmortemDraftWaitingSince": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for postmortemDraftWaitingSince field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "reminderNotificationSentCount": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for reminderNotificationSentCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "statusPagesNotifiedOnCreation": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for statusPagesNotifiedOnCreation field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "postUpdatesToWorkspaceChannels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "isOwnerNotifiedOfResourceCreation": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotifiedOfResourceCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "subscriberNotificationStatusMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "notifySubscribersOnPostmortemPublished": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for notifySubscribersOnPostmortemPublished field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "subscriberNotificationStatusOnIncidentCreated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatusOnIncidentCreated field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationClaimedAtOnIncidentCreated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for subscriberNotificationClaimedAtOnIncidentCreated field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "subscriberNotificationStatusOnPostmortemPublished": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatusOnPostmortemPublished field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationClaimedAtOnPostmortemPublished": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for subscriberNotificationClaimedAtOnPostmortemPublished field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "shouldStatusPageSubscribersBeNotifiedOnIncidentCreated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldStatusPageSubscribersBeNotifiedOnIncidentCreated field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "subscriberNotificationStatusMessageOnPostmortemPublished": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessageOnPostmortemPublished field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Incidents. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_kubernetes_cost_allocations

Count Kubernetes Cost Allocations telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.

read-only

Argument	Type	Description
query	object	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "labels": {
          "type": "string",
          "description": "labels field"
        },
        "pvCost": {
          "type": "string",
          "description": "pvCost field"
        },
        "cpuCost": {
          "type": "string",
          "description": "cpuCost field"
        },
        "gpuCost": {
          "type": "string",
          "description": "gpuCost field"
        },
        "podName": {
          "type": "string",
          "description": "podName field"
        },
        "ramCost": {
          "type": "string",
          "description": "ramCost field"
        },
        "currency": {
          "type": "string",
          "description": "currency field"
        },
        "gpuHours": {
          "type": "string",
          "description": "gpuHours field"
        },
        "nodeName": {
          "type": "string",
          "description": "nodeName field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "labelKeys": {
          "type": "string",
          "description": "labelKeys field"
        },
        "namespace": {
          "type": "string",
          "description": "namespace field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "totalCost": {
          "type": "string",
          "description": "totalCost field"
        },
        "windowEnd": {
          "type": "string",
          "description": "windowEnd field"
        },
        "providerId": {
          "type": "string",
          "description": "providerId field"
        },
        "sharedCost": {
          "type": "string",
          "description": "sharedCost field"
        },
        "shipmentId": {
          "type": "string",
          "description": "shipmentId field"
        },
        "clusterName": {
          "type": "string",
          "description": "clusterName field"
        },
        "networkCost": {
          "type": "string",
          "description": "networkCost field"
        },
        "pvByteHours": {
          "type": "string",
          "description": "pvByteHours field"
        },
        "windowStart": {
          "type": "string",
          "description": "windowStart field"
        },
        "cpuCoreHours": {
          "type": "string",
          "description": "cpuCoreHours field"
        },
        "externalCost": {
          "type": "string",
          "description": "externalCost field"
        },
        "ramByteHours": {
          "type": "string",
          "description": "ramByteHours field"
        },
        "containerName": {
          "type": "string",
          "description": "containerName field"
        },
        "cpuEfficiency": {
          "type": "string",
          "description": "cpuEfficiency field"
        },
        "ramEfficiency": {
          "type": "string",
          "description": "ramEfficiency field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "shipmentChunk": {
          "type": "string",
          "description": "shipmentChunk field"
        },
        "controllerKind": {
          "type": "string",
          "description": "controllerKind field"
        },
        "controllerName": {
          "type": "string",
          "description": "controllerName field"
        },
        "totalEfficiency": {
          "type": "string",
          "description": "totalEfficiency field"
        },
        "loadBalancerCost": {
          "type": "string",
          "description": "loadBalancerCost field"
        },
        "ramBytesUsageMax": {
          "type": "string",
          "description": "ramBytesUsageMax field"
        },
        "cpuCoreLimitAverage": {
          "type": "string",
          "description": "cpuCoreLimitAverage field"
        },
        "cpuCoreUsageAverage": {
          "type": "string",
          "description": "cpuCoreUsageAverage field"
        },
        "k8sClusterEntityKey": {
          "type": "string",
          "description": "k8sClusterEntityKey field"
        },
        "kubernetesClusterId": {
          "type": "string",
          "description": "kubernetesClusterId field"
        },
        "ramBytesLimitAverage": {
          "type": "string",
          "description": "ramBytesLimitAverage field"
        },
        "ramBytesUsageAverage": {
          "type": "string",
          "description": "ramBytesUsageAverage field"
        },
        "cpuCoreRequestAverage": {
          "type": "string",
          "description": "cpuCoreRequestAverage field"
        },
        "ramBytesRequestAverage": {
          "type": "string",
          "description": "ramBytesRequestAverage field"
        }
      },
      "description": "Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_labels

Count the total number of Labels in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Labels. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "color": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "nameSortKey": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for nameSortKey field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Labels. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_logs

Count Logs telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.

read-only

Argument	Type	Description
query	object	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "body": {
          "type": "string",
          "description": "body field"
        },
        "time": {
          "type": "string",
          "description": "time field"
        },
        "flags": {
          "type": "string",
          "description": "flags field"
        },
        "spanId": {
          "type": "string",
          "description": "spanId field"
        },
        "traceId": {
          "type": "string",
          "description": "traceId field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "sessionId": {
          "type": "string",
          "description": "sessionId field"
        },
        "attributes": {
          "type": "string",
          "description": "attributes field"
        },
        "entityKeys": {
          "type": "string",
          "description": "entityKeys field"
        },
        "severityText": {
          "type": "string",
          "description": "severityText field"
        },
        "timeUnixNano": {
          "type": "string",
          "description": "timeUnixNano field"
        },
        "attributeKeys": {
          "type": "string",
          "description": "attributeKeys field"
        },
        "hostEntityKey": {
          "type": "string",
          "description": "hostEntityKey field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "severityNumber": {
          "type": "string",
          "description": "severityNumber field"
        },
        "k8sPodEntityKey": {
          "type": "string",
          "description": "k8sPodEntityKey field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "k8sNodeEntityKey": {
          "type": "string",
          "description": "k8sNodeEntityKey field"
        },
        "serviceEntityKey": {
          "type": "string",
          "description": "serviceEntityKey field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        },
        "containerEntityKey": {
          "type": "string",
          "description": "containerEntityKey field"
        },
        "k8sClusterEntityKey": {
          "type": "string",
          "description": "k8sClusterEntityKey field"
        },
        "observedTimeUnixNano": {
          "type": "string",
          "description": "observedTimeUnixNano field"
        },
        "droppedAttributesCount": {
          "type": "string",
          "description": "droppedAttributesCount field"
        }
      },
      "description": "Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_metrics

Count Metrics telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.

read-only

Argument	Type	Description
query	object	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "max": {
          "type": "string",
          "description": "max field"
        },
        "min": {
          "type": "string",
          "description": "min field"
        },
        "sum": {
          "type": "string",
          "description": "sum field"
        },
        "name": {
          "type": "string",
          "description": "name field"
        },
        "time": {
          "type": "string",
          "description": "time field"
        },
        "count": {
          "type": "string",
          "description": "count field"
        },
        "scale": {
          "type": "string",
          "description": "scale field"
        },
        "value": {
          "type": "string",
          "description": "value field"
        },
        "spanId": {
          "type": "string",
          "description": "spanId field"
        },
        "traceId": {
          "type": "string",
          "description": "traceId field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "startTime": {
          "type": "string",
          "description": "startTime field"
        },
        "zeroCount": {
          "type": "string",
          "description": "zeroCount field"
        },
        "attributes": {
          "type": "string",
          "description": "attributes field"
        },
        "entityKeys": {
          "type": "string",
          "description": "entityKeys field"
        },
        "isMonotonic": {
          "type": "string",
          "description": "isMonotonic field"
        },
        "bucketCounts": {
          "type": "string",
          "description": "bucketCounts field"
        },
        "timeUnixNano": {
          "type": "string",
          "description": "timeUnixNano field"
        },
        "attributeKeys": {
          "type": "string",
          "description": "attributeKeys field"
        },
        "hostEntityKey": {
          "type": "string",
          "description": "hostEntityKey field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "summaryValues": {
          "type": "string",
          "description": "summaryValues field"
        },
        "explicitBounds": {
          "type": "string",
          "description": "explicitBounds field"
        },
        "negativeOffset": {
          "type": "string",
          "description": "negativeOffset field"
        },
        "positiveOffset": {
          "type": "string",
          "description": "positiveOffset field"
        },
        "k8sPodEntityKey": {
          "type": "string",
          "description": "k8sPodEntityKey field"
        },
        "metricPointType": {
          "type": "string",
          "description": "metricPointType field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "k8sNodeEntityKey": {
          "type": "string",
          "description": "k8sNodeEntityKey field"
        },
        "serviceEntityKey": {
          "type": "string",
          "description": "serviceEntityKey field"
        },
        "summaryQuantiles": {
          "type": "string",
          "description": "summaryQuantiles field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        },
        "startTimeUnixNano": {
          "type": "string",
          "description": "startTimeUnixNano field"
        },
        "containerEntityKey": {
          "type": "string",
          "description": "containerEntityKey field"
        },
        "k8sClusterEntityKey": {
          "type": "string",
          "description": "k8sClusterEntityKey field"
        },
        "negativeBucketCounts": {
          "type": "string",
          "description": "negativeBucketCounts field"
        },
        "positiveBucketCounts": {
          "type": "string",
          "description": "positiveBucketCounts field"
        },
        "aggregationTemporality": {
          "type": "string",
          "description": "aggregationTemporality field"
        }
      },
      "description": "Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_monitor_logs

Count Monitor Logs telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.

read-only

Argument	Type	Description
query	object	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "time": {
          "type": "string",
          "description": "time field"
        },
        "logBody": {
          "type": "string",
          "description": "logBody field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "monitorId": {
          "type": "string",
          "description": "monitorId field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        }
      },
      "description": "Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_monitor_status_events

Count the total number of Monitor Status Events in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Monitor Status Events. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "endsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "startsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "monitorId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for monitorId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "rootCause": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOwnerNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "monitorStatusId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for monitorStatusId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "statusChangeLog": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for statusChangeLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Monitor Status Events. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_monitor_statuses

Count the total number of Monitor Statuses in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Monitor Statuses. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "color": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "priority": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for priority field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "isOfflineState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOfflineState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOperationalState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOperationalState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Monitor Statuses. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_monitors

Count the total number of Monitors in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Monitors. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "hosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for hosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "labels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "services": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for services field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "iotFleets": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for iotFleets field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "dockerHosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "monitorType": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for monitorType field of type Monitor Type. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "podmanHosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for podmanHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "cephClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for cephClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "customFields": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "monitorSteps": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for monitorSteps field of type Monitor Steps. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "storageArrays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for storageArrays field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "vmwareVCenters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for vmwareVCenters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "databaseServers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for databaseServers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "proxmoxClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for proxmoxClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "dependsOnMonitors": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dependsOnMonitors field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "monitorTemplateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for monitorTemplateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "kubernetesClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for kubernetesClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "monitoringInterval": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for monitoringInterval field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "dockerSwarmClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerSwarmClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "networkAlertPolicyId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for networkAlertPolicyId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "minimumProbeAgreement": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for minimumProbeAgreement field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "serverMonitorResponse": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for serverMonitorResponse field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "currentMonitorStatusId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for currentMonitorStatusId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "incomingEmailSecretKey": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incomingEmailSecretKey field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "incomingMonitorRequest": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for incomingMonitorRequest field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "serverMonitorSecretKey": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for serverMonitorSecretKey field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "disableActiveMonitoring": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for disableActiveMonitoring field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "incomingRequestSecretKey": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incomingRequestSecretKey field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "incomingEmailMonitorRequest": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for incomingEmailMonitorRequest field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "incomingEmailCustomLocalPart": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for incomingEmailCustomLocalPart field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "isNoProbeEnabledOnThisMonitor": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isNoProbeEnabledOnThisMonitor field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "telemetryMonitorLastMonitorAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for telemetryMonitorLastMonitorAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "telemetryMonitorNextMonitorAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for telemetryMonitorNextMonitorAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "autoProvisionedNetworkDeviceId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for autoProvisionedNetworkDeviceId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "postUpdatesToWorkspaceChannels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "serverMonitorRequestReceivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for serverMonitorRequestReceivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isOwnerNotifiedOfResourceCreation": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotifiedOfResourceCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "incomingEmailMonitorHeartbeatCheckedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for incomingEmailMonitorHeartbeatCheckedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isAllProbesDisconnectedFromThisMonitor": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isAllProbesDisconnectedFromThisMonitor field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "incomingEmailMonitorLastEmailReceivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for incomingEmailMonitorLastEmailReceivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "suppressAlertsWhenParentMonitorStatuses": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for suppressAlertsWhenParentMonitorStatuses field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "incomingRequestMonitorHeartbeatCheckedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for incomingRequestMonitorHeartbeatCheckedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "disableActiveMonitoringBecauseOfManualIncident": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for disableActiveMonitoringBecauseOfManualIncident field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "disableActiveMonitoringBecauseOfScheduledMaintenanceEvent": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for disableActiveMonitoringBecauseOfScheduledMaintenanceEvent field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Monitors. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_on_call_duty_policies

Count the total number of On-Call Duty Policies in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all On-Call Duty Policies. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "labels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "customFields": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "postUpdatesToWorkspaceChannels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "acknowledgementTimeoutInMinutes": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for acknowledgementTimeoutInMinutes field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "repeatPolicyIfNoOneAcknowledges": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for repeatPolicyIfNoOneAcknowledges field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "repeatPolicyIfNoOneAcknowledgesNoOfTimes": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for repeatPolicyIfNoOneAcknowledgesNoOfTimes field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all On-Call Duty Policies. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_postmortem_statuses

Count the total number of Postmortem Statuses in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Postmortem Statuses. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "color": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "order": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 10
          },
          "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "isDraftStatus": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isDraftStatus field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isCompletedStatus": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isCompletedStatus field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "isNotStartedStatus": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isNotStartedStatus field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Postmortem Statuses. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_scheduled_maintenance_events

Count the total number of Scheduled Maintenance Events in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Scheduled Maintenance Events. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "hosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for hosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "title": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for title field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "endsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "labels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "monitors": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for monitors field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "services": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for services field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "startsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "iotFleets": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for iotFleets field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "dockerHosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "podmanHosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for podmanHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "statusPages": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for statusPages field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "cephClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for cephClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "customFields": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "networkSites": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for networkSites field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "storageArrays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for storageArrays field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "vmwareVCenters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for vmwareVCenters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "databaseServers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for databaseServers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "enableReminders": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableReminders field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "proxmoxClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for proxmoxClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "kubernetesClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for kubernetesClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "dockerSwarmClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerSwarmClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "isVisibleOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isVisibleOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "changeMonitorStatusToId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for changeMonitorStatusToId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "nextReminderNotificationAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for nextReminderNotificationAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "scheduledMaintenanceNumber": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for scheduledMaintenanceNumber field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "reminderNotificationSentCount": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for reminderNotificationSentCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "postUpdatesToWorkspaceChannels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "isOwnerNotifiedOfResourceCreation": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotifiedOfResourceCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "currentScheduledMaintenanceStateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for currentScheduledMaintenanceStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "subscriberNotificationStatusMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "scheduledMaintenanceNumberWithPrefix": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for scheduledMaintenanceNumberWithPrefix field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "nextSubscriberNotificationBeforeTheEventAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for nextSubscriberNotificationBeforeTheEventAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "sendSubscriberNotificationsOnBeforeTheEvent": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for sendSubscriberNotificationsOnBeforeTheEvent field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "subscriberNotificationStatusOnEventScheduled": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatusOnEventScheduled field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "shouldStatusPageSubscribersBeNotifiedOnEventCreated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldStatusPageSubscribersBeNotifiedOnEventCreated field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Scheduled Maintenance Events. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_scheduled_maintenance_state_timelines

Count the total number of Scheduled Maintenance State Timelines in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Scheduled Maintenance State Timelines. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "endsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "startsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOwnerNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "scheduledMaintenanceId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for scheduledMaintenanceId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "scheduledMaintenanceStateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for scheduledMaintenanceStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "subscriberNotificationStatus": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatus field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationStatusMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "shouldStatusPageSubscribersBeNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldStatusPageSubscribersBeNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Scheduled Maintenance State Timelines. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_scheduled_maintenance_states

Count the total number of Scheduled Maintenance States in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Scheduled Maintenance States. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "color": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "order": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 10
          },
          "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "isEndedState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isEndedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "isOngoingState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOngoingState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isResolvedState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isResolvedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isScheduledState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isScheduledState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Scheduled Maintenance States. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_security_case_notes

Count the total number of Security Case Notes in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Security Case Notes. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "note": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for note field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "securityCaseId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for securityCaseId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Security Case Notes. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_security_cases

Count the total number of Security Cases in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Security Cases. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "title": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for title field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "labels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "source": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for source field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "status": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for status field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "verdict": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for verdict field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "closedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for closedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "entities": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for entities field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "priority": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for priority field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "aiVerdict": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for aiVerdict field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "caseNumber": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for caseNumber field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "incidentId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "aiTriagedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for aiTriagedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "closingNote": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for closingNote field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "containedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for containedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "groupingKey": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for groupingKey field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "mitreTactics": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for mitreTactics field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "acknowledgedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for acknowledgedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "aiTriageReport": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for aiTriageReport field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "closedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for closedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "detectionCount": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for detectionCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "lastDetectedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for lastDetectedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "firstDetectedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for firstDetectedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "mitreTechniques": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for mitreTechniques field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "assignedToTeamId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for assignedToTeamId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "assignedToUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for assignedToUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "notifiedPriority": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for notifiedPriority field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "aiSuggestedPriority": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for aiSuggestedPriority field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "caseNumberWithPrefix": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for caseNumberWithPrefix field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "aiSuggestedPlaybookId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for aiSuggestedPlaybookId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "aiTriagePromptInjectionSuspected": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for aiTriagePromptInjectionSuspected field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Security Cases. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_security_detections

Count the total number of Security Detections in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Security Detections. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "title": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for title field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "source": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for source field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "entities": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for entities field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "eventUid": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for eventUid field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "ruleName": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for ruleName field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "severity": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for severity field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "fireCount": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for fireCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "eventCount": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for eventCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "groupValue": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for groupValue field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "lastSeenAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for lastSeenAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "fingerprint": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for fingerprint field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "firstSeenAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for firstSeenAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "mitreTactics": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for mitreTactics field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "sampleMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for sampleMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "securityCaseId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for securityCaseId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "detectionRuleId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for detectionRuleId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "mitreTechniques": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for mitreTechniques field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "threatIntelFeedId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for threatIntelFeedId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "securityEventConnectionId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for securityEventConnectionId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Security Detections. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_security_events

Count Security Events telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.

read-only

Argument	Type	Description
query	object	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "time": {
          "type": "string",
          "description": "time field"
        },
        "ruleId": {
          "type": "string",
          "description": "ruleId field"
        },
        "message": {
          "type": "string",
          "description": "message field"
        },
        "classUid": {
          "type": "string",
          "description": "classUid field"
        },
        "eventUid": {
          "type": "string",
          "description": "eventUid field"
        },
        "ruleName": {
          "type": "string",
          "description": "ruleName field"
        },
        "targetIp": {
          "type": "string",
          "description": "targetIp field"
        },
        "className": {
          "type": "string",
          "description": "className field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "attributes": {
          "type": "string",
          "description": "attributes field"
        },
        "severityId": {
          "type": "string",
          "description": "severityId field"
        },
        "statusName": {
          "type": "string",
          "description": "statusName field"
        },
        "targetHost": {
          "type": "string",
          "description": "targetHost field"
        },
        "targetPort": {
          "type": "string",
          "description": "targetPort field"
        },
        "targetUser": {
          "type": "string",
          "description": "targetUser field"
        },
        "vendorName": {
          "type": "string",
          "description": "vendorName field"
        },
        "categoryUid": {
          "type": "string",
          "description": "categoryUid field"
        },
        "observables": {
          "type": "string",
          "description": "observables field"
        },
        "principalIp": {
          "type": "string",
          "description": "principalIp field"
        },
        "processName": {
          "type": "string",
          "description": "processName field"
        },
        "processPath": {
          "type": "string",
          "description": "processPath field"
        },
        "productName": {
          "type": "string",
          "description": "productName field"
        },
        "activityName": {
          "type": "string",
          "description": "activityName field"
        },
        "categoryName": {
          "type": "string",
          "description": "categoryName field"
        },
        "mitreTactics": {
          "type": "string",
          "description": "mitreTactics field"
        },
        "severityName": {
          "type": "string",
          "description": "severityName field"
        },
        "attributeKeys": {
          "type": "string",
          "description": "attributeKeys field"
        },
        "principalHost": {
          "type": "string",
          "description": "principalHost field"
        },
        "principalUser": {
          "type": "string",
          "description": "principalUser field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "targetResource": {
          "type": "string",
          "description": "targetResource field"
        },
        "mitreTechniques": {
          "type": "string",
          "description": "mitreTechniques field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "principalProcess": {
          "type": "string",
          "description": "principalProcess field"
        },
        "parentProcessName": {
          "type": "string",
          "description": "parentProcessName field"
        },
        "parentProcessPath": {
          "type": "string",
          "description": "parentProcessPath field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        },
        "processCommandLine": {
          "type": "string",
          "description": "processCommandLine field"
        },
        "parentProcessCommandLine": {
          "type": "string",
          "description": "parentProcessCommandLine field"
        }
      },
      "description": "Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_security_playbooks

Count the total number of Security Playbooks in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Security Playbooks. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Name. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "steps": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for steps field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "trigger": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for trigger field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "runCount": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for runCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isEnabled": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isEnabled field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "lastRunAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for lastRunAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "detectionSource": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for detectionSource field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "minimumPriority": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for minimumPriority field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "detectionRuleIds": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for detectionRuleIds field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Security Playbooks. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_spans

Count Spans telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.

read-only

Argument	Type	Description
query	object	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "kind": {
          "type": "string",
          "description": "kind field"
        },
        "name": {
          "type": "string",
          "description": "name field"
        },
        "links": {
          "type": "string",
          "description": "links field"
        },
        "events": {
          "type": "string",
          "description": "events field"
        },
        "spanId": {
          "type": "string",
          "description": "spanId field"
        },
        "endTime": {
          "type": "string",
          "description": "endTime field"
        },
        "llmCost": {
          "type": "string",
          "description": "llmCost field"
        },
        "llmTeam": {
          "type": "string",
          "description": "llmTeam field"
        },
        "traceId": {
          "type": "string",
          "description": "traceId field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "isLlmSpan": {
          "type": "string",
          "description": "isLlmSpan field"
        },
        "llmIssues": {
          "type": "string",
          "description": "llmIssues field"
        },
        "llmSystem": {
          "type": "string",
          "description": "llmSystem field"
        },
        "llmUserId": {
          "type": "string",
          "description": "llmUserId field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "sessionId": {
          "type": "string",
          "description": "sessionId field"
        },
        "startTime": {
          "type": "string",
          "description": "startTime field"
        },
        "attributes": {
          "type": "string",
          "description": "attributes field"
        },
        "entityKeys": {
          "type": "string",
          "description": "entityKeys field"
        },
        "isRootSpan": {
          "type": "string",
          "description": "isRootSpan field"
        },
        "statusCode": {
          "type": "string",
          "description": "statusCode field"
        },
        "traceState": {
          "type": "string",
          "description": "traceState field"
        },
        "llmCallKind": {
          "type": "string",
          "description": "llmCallKind field"
        },
        "llmToolName": {
          "type": "string",
          "description": "llmToolName field"
        },
        "hasException": {
          "type": "string",
          "description": "hasException field"
        },
        "llmAgentName": {
          "type": "string",
          "description": "llmAgentName field"
        },
        "llmOperation": {
          "type": "string",
          "description": "llmOperation field"
        },
        "llmUserEmail": {
          "type": "string",
          "description": "llmUserEmail field"
        },
        "parentSpanId": {
          "type": "string",
          "description": "parentSpanId field"
        },
        "attributeKeys": {
          "type": "string",
          "description": "attributeKeys field"
        },
        "hostEntityKey": {
          "type": "string",
          "description": "hostEntityKey field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "statusMessage": {
          "type": "string",
          "description": "statusMessage field"
        },
        "llmInputTokens": {
          "type": "string",
          "description": "llmInputTokens field"
        },
        "llmTotalTokens": {
          "type": "string",
          "description": "llmTotalTokens field"
        },
        "endTimeUnixNano": {
          "type": "string",
          "description": "endTimeUnixNano field"
        },
        "k8sPodEntityKey": {
          "type": "string",
          "description": "k8sPodEntityKey field"
        },
        "llmOutputTokens": {
          "type": "string",
          "description": "llmOutputTokens field"
        },
        "llmRequestModel": {
          "type": "string",
          "description": "llmRequestModel field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "durationUnixNano": {
          "type": "string",
          "description": "durationUnixNano field"
        },
        "k8sNodeEntityKey": {
          "type": "string",
          "description": "k8sNodeEntityKey field"
        },
        "llmResponseModel": {
          "type": "string",
          "description": "llmResponseModel field"
        },
        "serviceEntityKey": {
          "type": "string",
          "description": "serviceEntityKey field"
        },
        "llmConversationId": {
          "type": "string",
          "description": "llmConversationId field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        },
        "startTimeUnixNano": {
          "type": "string",
          "description": "startTimeUnixNano field"
        },
        "containerEntityKey": {
          "type": "string",
          "description": "containerEntityKey field"
        },
        "k8sClusterEntityKey": {
          "type": "string",
          "description": "k8sClusterEntityKey field"
        },
        "llmUserMessagePreview": {
          "type": "string",
          "description": "llmUserMessagePreview field"
        }
      },
      "description": "Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_status_page_announcements

Count the total number of Status Page Announcements in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Status Page Announcements. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "title": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for title field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "monitors": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for monitors field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "attachments": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for attachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "statusPages": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for statusPages field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOwnerNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "endAnnouncementAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for endAnnouncementAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "showAnnouncementAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for showAnnouncementAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "subscriberNotificationStatus": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatus field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationStatusMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "shouldStatusPageSubscribersBeNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldStatusPageSubscribersBeNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "subscriberNotificationStatusOnAnnouncementUpdated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatusOnAnnouncementUpdated field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationStatusMessageOnAnnouncementUpdated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessageOnAnnouncementUpdated field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Status Page Announcements. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_status_pages

Count the total number of Status Pages in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Status Pages. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "theme": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for theme field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "labels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "customCSS": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customCSS field of type CSS. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "pageTitle": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for pageTitle field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "footerHTML": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for footerHTML field of type HTML. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "headerHTML": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for headerHTML field of type HTML. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "logoFileId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for logoFileId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "ipWhitelist": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for ipWhitelist field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "logoAltText": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for logoAltText field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "customFields": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "smtpConfigId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for smtpConfigId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "copyrightText": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for copyrightText field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "faviconFileId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for faviconFileId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "masterPassword": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for masterPassword field of type Hashed String. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "reportTimezone": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for reportTimezone field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "callSmsConfigId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for callSmsConfigId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "defaultBarColor": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for defaultBarColor field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "defaultLanguage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for defaultLanguage field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "enableMcpServer": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableMcpServer field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "isReportEnabled": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isReportEnabled field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "pageDescription": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for pageDescription field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "coverImageFileId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for coverImageFileId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "customJavaScript": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customJavaScript field of type JavaSCript. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "enabledLanguages": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for enabledLanguages field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "reportDataInDays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for reportDataInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "reportPeriodType": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for reportPeriodType field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "sendNextReportBy": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for sendNextReportBy field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "coverImageAltText": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for coverImageAltText field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "isPublicStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isPublicStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "masterPasswordSalt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for masterPasswordSalt field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "requireSsoForLogin": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for requireSsoForLogin field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "reportStartDateTime": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for reportStartDateTime field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "subscriberTimezones": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberTimezones field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "enableMasterPassword": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableMasterPassword field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "enableSmsSubscribers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableSmsSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "enableEmailSubscribers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableEmailSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "enableSlackSubscribers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableSlackSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "downtimeMonitorStatuses": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for downtimeMonitorStatuses field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "onlyShowScopedIncidents": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for onlyShowScopedIncidents field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "overviewPageDescription": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for overviewPageDescription field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "reportRecurringInterval": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for reportRecurringInterval field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "showUptimeHistoryInDays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for showUptimeHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "enableWebhookSubscribers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableWebhookSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "showEpisodeHistoryInDays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for showEpisodeHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "showEpisodesOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showEpisodesOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "showIncidentHistoryInDays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for showIncidentHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "showIncidentsOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showIncidentsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "embeddedOverallStatusToken": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for embeddedOverallStatusToken field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "enableSearchEngineIndexing": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableSearchEngineIndexing field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "enableEmbeddedOverallStatus": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableEmbeddedOverallStatus field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "sendSubscriberNotifications": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for sendSubscriberNotifications field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "allowedSubscriberEmailDomains": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for allowedSubscriberEmailDomains field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "overallUptimePercentPrecision": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for overallUptimePercentPrecision field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "showAnnouncementHistoryInDays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for showAnnouncementHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "showAnnouncementsOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showAnnouncementsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "showEpisodeLabelsOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showEpisodeLabelsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "hidePoweredByOneUptimeBranding": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for hidePoweredByOneUptimeBranding field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "limitSubscribersToPrivateUsers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for limitSubscribersToPrivateUsers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "showIncidentLabelsOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showIncidentLabelsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "showSubscriberPageOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showSubscriberPageOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "enableMicrosoftTeamsSubscribers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableMicrosoftTeamsSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "privateUserSessionLengthInHours": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for privateUserSessionLengthInHours field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "showScheduledEventHistoryInDays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for showScheduledEventHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "allowSubscribersToChooseResources": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for allowSubscribersToChooseResources field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "isOwnerNotifiedOfResourceCreation": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotifiedOfResourceCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "allowSubscribersToChooseEventTypes": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for allowSubscribersToChooseEventTypes field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "showOverallUptimePercentOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showOverallUptimePercentOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "showScheduledEventLabelsOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showScheduledEventLabelsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "subscriberEmailNotificationFooterText": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberEmailNotificationFooterText field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "showScheduledMaintenanceEventsOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showScheduledMaintenanceEventsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "enableCustomSubscriberEmailNotificationFooterText": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableCustomSubscriberEmailNotificationFooterText field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Status Pages. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_teams

Count the total number of Teams in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.

read-only

Argument	Type	Description
query	object	Optional filter criteria. If omitted, counts all Teams. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "customFields": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "isTeamEditable": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isTeamEditable field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isTeamDeleteable": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isTeamDeleteable field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "isPermissionsEditable": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isPermissionsEditable field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "shouldHaveAtLeastOneMember": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldHaveAtLeastOneMember field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Optional filter criteria. If omitted, counts all Teams. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

count_threat_intel_indicators

Count Threat Intel Indicators telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.

read-only

Argument	Type	Description
query	object	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "feedId": {
          "type": "string",
          "description": "feedId field"
        },
        "stixId": {
          "type": "string",
          "description": "stixId field"
        },
        "revoked": {
          "type": "string",
          "description": "revoked field"
        },
        "version": {
          "type": "string",
          "description": "version field"
        },
        "feedName": {
          "type": "string",
          "description": "feedName field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "validFrom": {
          "type": "string",
          "description": "validFrom field"
        },
        "confidence": {
          "type": "string",
          "description": "confidence field"
        },
        "stixLabels": {
          "type": "string",
          "description": "stixLabels field"
        },
        "validUntil": {
          "type": "string",
          "description": "validUntil field"
        },
        "indicatorName": {
          "type": "string",
          "description": "indicatorName field"
        },
        "indicatorType": {
          "type": "string",
          "description": "indicatorType field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "indicatorValue": {
          "type": "string",
          "description": "indicatorValue field"
        }
      },
      "description": "Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

create_alert

Create a new Alert in OneUptime. Returns the created Alert object with its ID. Use this to add new Alerts to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
hosts	array	List of hosts affected by this alert.
title*	string	Title of this alert.
labels	array	Relation to Labels Array where this object is categorized in.
services	array	List of services affected by this alert.
iotFleets	array	List of IoT fleets affected by this alert.
isPrivate	boolean	If true, this alert is only visible to its owners (users in 'owner users' and members of 'owner teams'), project admins, and project owners.
monitorId	string	ID of the monitor this alert belongs to.
projectId	string	ID of your OneUptime Project in which this object belongs.
rootCause

create_alert_internal_note

Create a new Alert Internal Note in OneUptime. Returns the created Alert Internal Note object with its ID. Use this to add new Alert Internal Notes to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
note	string	Notes in markdown.
alertId*	string	Relation to Alert ID in which this resource belongs.
postedAt	object	Date and time the note belongs to in the timeline: when it was written, or - for a note saved from a Slack or Microsoft Teams message - when that message was posted.
projectId	string	ID of your OneUptime Project in which this object belongs.
attachments	array	Files attached to this note.
postedFromSlackMessageId	string	Unique identifier for the Slack message this note was created from (channel_id:message_ts). Used to prevent duplicate notes when multiple users react to the same message.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "alertId"
  ],
  "properties": {
    "note": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Notes in markdown."
    },
    "alertId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Relation to Alert ID in which this resource belongs."
    },
    "postedAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "Date and time the note belongs to in the timeline: when it was written, or - for a note saved from a Slack or Microsoft Teams message - when that message was posted."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Files attached to this note."
    },
    "postedFromSlackMessageId": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Unique identifier for the Slack message this note was created from (channel_id:message_ts). Used to prevent duplicate notes when multiple users react to the same message."
    }
  },
  "additionalProperties": false
}

create_alert_severity

Create a new Alert Severity in OneUptime. Returns the created Alert Severity object with its ID. Use this to add new Alert Severities to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
name*	string	Any friendly name of this object.
color*	object	Color of this resource in Hex (#32a852 for example).
order	integer	Where this severity ranks among the project's alert severities: 1 is the most severe. A new severity without a number goes to the end of the list. Setting a number moves the severity to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them.
projectId	string	ID of your OneUptime Project in which this object belongs.
isArchived	boolean	Archived severities stay on the alerts and episodes that have them, but can't be picked again. A project keeps at least one severity that is not archived.
description	string	Friendly description that will help you remember.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "name",
    "color"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "color": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Color of this resource in Hex (#32a852 for example)."
    },
    "order": {
      "type": "integer",
      "example": 10,
      "description": "Where this severity ranks among the project's alert severities: 1 is the most severe. A new severity without a number goes to the end of the list. Setting a number moves the severity to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived severities stay on the alerts and episodes that have them, but can't be picked again. A project keeps at least one severity that is not archived."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    }
  },
  "additionalProperties": false
}

create_alert_state

Create a new Alert State in OneUptime. Returns the created Alert State object with its ID. Use this to add new Alert States to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
name*	string	Any friendly name of this object.
color*	object	Color of this resource in Hex (#32a852 for example).
order	integer	Where this state sits in the project's list of alert states: 1 is the top. Alerts only ever move down the list, and an alert in a state at or below the acknowledged (or resolved) state counts as acknowledged (or resolved), so the created, acknowledged and resolved states have to stay in that order. A new state without a number goes just above the resolved state. Setting a number moves the state to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them.
projectId	string	ID of your OneUptime Project in which this object belongs.
isArchived	boolean	Archived states stay on the alerts and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived.
description	string	Friendly description that will help you remember.

create_alert_state_timeline

Create a new Alert State Timeline in OneUptime. Returns the created Alert State Timeline object with its ID. Use this to add new Alert State Timelines to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
endsAt	object	When did this status change end?
alertId*	string	Relation to Alert ID in which this resource belongs.
startsAt	object	When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value.
projectId	string	ID of your OneUptime Project in which this object belongs.
rootCause	string	What is the root cause of this status change?
alertStateId*	string	Alert State ID Relation. Which alert state does this alert change to?

Input schema (JSON)

{
  "type": "object",
  "required": [
    "alertId",
    "alertStateId"
  ],
  "properties": {
    "endsAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When did this status change end?"
    },
    "alertId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Relation to Alert ID in which this resource belongs."
    },
    "startsAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "rootCause": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "What is the root cause of this status change?"
    },
    "alertStateId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Alert State ID Relation. Which alert state does this alert change to?"
    }
  },
  "additionalProperties": false
}

create_incident

Create a new Incident in OneUptime. Returns the created Incident object with its ID. Use this to add new Incidents to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
hosts	array	List of hosts affected by this incident.
title*	string	Title of this incident.
labels	array	Relation to Labels Array where this object is categorized in.
monitors	array	List of monitors affected by this incident.
services	array	List of services affected by this incident.
iotFleets	array	List of IoT fleets affected by this incident.
isPrivate	boolean	If true, this incident is only visible to its owners (users in 'owner users' and members of 'owner teams'), project admins, and project owners. Private incidents are hidden from status pages.
projectId	string	ID of your OneUptime Project in which this object belongs.

create_incident_alert

Create a new Incident Alert in OneUptime. Returns the created Incident Alert object with its ID. Use this to add new Incident Alerts to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
alertId*	string	ID of the Alert that is linked to the incident.
projectId	string	ID of your OneUptime Project in which this object belongs.
incidentId*	string	ID of the Incident this alert is linked to.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "incidentId",
    "alertId"
  ],
  "properties": {
    "alertId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of the Alert that is linked to the incident."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "incidentId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of the Incident this alert is linked to."
    }
  },
  "additionalProperties": false
}

create_incident_internal_note

Create a new Incident Internal Note in OneUptime. Returns the created Incident Internal Note object with its ID. Use this to add new Incident Internal Notes to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
note	string	Notes in markdown.
postedAt	object	Date and time the note belongs to in the timeline: when it was written, or - for a note saved from a Slack or Microsoft Teams message - when that message was posted.
projectId	string	ID of your OneUptime Project in which this object belongs.
incidentId*	string	Relation to Incident ID in which this resource belongs.
attachments	array	Files attached to this note.
postedFromSlackMessageId	string	Unique identifier for the Slack message this note was created from (channel_id:message_ts). Used to prevent duplicate notes when multiple users react to the same message.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "incidentId"
  ],
  "properties": {
    "note": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Notes in markdown."
    },
    "postedAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "Date and time the note belongs to in the timeline: when it was written, or - for a note saved from a Slack or Microsoft Teams message - when that message was posted."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "incidentId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Relation to Incident ID in which this resource belongs."
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Files attached to this note."
    },
    "postedFromSlackMessageId": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Unique identifier for the Slack message this note was created from (channel_id:message_ts). Used to prevent duplicate notes when multiple users react to the same message."
    }
  },
  "additionalProperties": false
}

create_incident_public_note

Create a new Incident Public Note in OneUptime. Returns the created Incident Public Note object with its ID. Use this to add new Incident Public Notes to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
note	string	Notes in markdown.
postedAt	object	Date and time when the note was posted.
projectId	string	ID of your OneUptime Project in which this object belongs.
incidentId*	string	Relation to Incident ID in which this resource belongs.
attachments	array	Files attached to this note.
postedFromSlackMessageId	string	Unique identifier for the Slack message this note was created from (channel_id:message_ts). Used to prevent duplicate notes when multiple users react to the same message.
shouldStatusPageSubscribersBeNotifiedOnNoteCreated	boolean	Should subscribers be notified about this note? If left out, this follows the incident: true when subscribers were notified that the incident was declared, false when it was declared without notifying them.

create_incident_severity

Create a new Incident Severity in OneUptime. Returns the created Incident Severity object with its ID. Use this to add new Incident Severities to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
name*	string	Any friendly name of this object.
color*	object	Color of this resource in Hex (#32a852 for example).
order	integer	Where this severity ranks among the project's incident severities: 1 is the most severe. A new severity without a number goes to the end of the list. Setting a number moves the severity to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them.
projectId	string	ID of your OneUptime Project in which this object belongs.
isArchived	boolean	Archived severities stay on the incidents and episodes that have them, but can't be picked again. A project keeps at least one severity that is not archived.
description	string	Friendly description that will help you remember.

Input schema (JSON)

create_incident_state

Create a new Incident State in OneUptime. Returns the created Incident State object with its ID. Use this to add new Incident States to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
name*	string	Any friendly name of this object.
color*	object	Color of this resource in Hex (#32a852 for example).
order	integer	Where this state sits in the project's list of incident states: 1 is the top. Incidents only ever move down the list, and an incident in a state at or below the acknowledged (or resolved) state counts as acknowledged (or resolved), so the created, acknowledged and resolved states have to stay in that order. A new state without a number goes just above the resolved state. Setting a number moves the state to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them.
projectId	string	ID of your OneUptime Project in which this object belongs.
isArchived	boolean	Archived states stay on the incidents and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived.
description	string	Friendly description that will help you remember.

create_incident_state_timeline

Create a new Incident State Timeline in OneUptime. Returns the created Incident State Timeline object with its ID. Use this to add new Incident State Timelines to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
endsAt	object	When did this status change end?
startsAt	object	When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value.
projectId	string	ID of your OneUptime Project in which this object belongs.
rootCause	string	What is the root cause of this status change?
incidentId*	string	Relation to Incident ID in which this resource belongs.
incidentStateId*	string	Incident State ID Relation. Which incident state does this incident change to?
shouldStatusPageSubscribersBeNotified	boolean	Should subscribers be notified about this state change?

create_label

Create a new Label in OneUptime. Returns the created Label object with its ID. Use this to add new Labels to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
name*	string	Any friendly name of this object.
color*	object	Color of this resource in Hex (#32a852 for example).
projectId	string	ID of your OneUptime Project in which this object belongs.
isArchived	boolean	Archived labels stay on everything that has them, but can't be added to anything again.
description	string	Friendly description that will help you remember.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "name",
    "color"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "color": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Color of this resource in Hex (#32a852 for example)."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived labels stay on everything that has them, but can't be added to anything again."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    }
  },
  "additionalProperties": false
}

create_monitor

Create a new Monitor in OneUptime. Returns the created Monitor object with its ID. Use this to add new Monitors to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
name*	string	Any friendly name for this monitor.
hosts	array	Hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
labels	array	Relation to Labels Array where this object is categorized in.
services	array	Services this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
iotFleets	array	IoT fleets this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
projectId	string	ID of your OneUptime Project in which this object belongs.
isArchived	boolean	Archived monitors are hidden from monitor lists and status pages, are not checked, and open no incidents or alerts. Unarchiving resumes monitoring.

create_monitor_status

Create a new Monitor Status in OneUptime. Returns the created Monitor Status object with its ID. Use this to add new Monitor Statuses to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
name*	string	Any friendly name of this object.
color*	object	Color of this resource in Hex (#32a852 for example).
priority	number	Where this status sits in the project's list of monitor statuses, from the healthiest (the lowest number) down to the worst: where monitors are shown together, as on a status page or in a monitor group, the status furthest down the list wins. A new status without a number goes just above the offline status. Setting a number moves the status to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them.
projectId	string	ID of your OneUptime Project in which this object belongs.
isArchived	boolean	Archived statuses stay on the monitors that are in them, but can't be picked again. The operational and offline statuses can't be archived.
description	string	Friendly description that will help you remember.

create_monitor_status_event

Create a new Monitor Status Event in OneUptime. Returns the created Monitor Status Event object with its ID. Use this to add new Monitor Status Events to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
endsAt	object	When did this status change end?
startsAt	object	When did this status change?
monitorId*	string	Relation to Monitor ID Resource in which this object belongs.
projectId	string	ID of your OneUptime Project in which this object belongs.
rootCause	string	What is the root cause of this status change?
monitorStatusId*	string	Relation to Monitor Status ID Resource in which this object belongs.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "monitorId",
    "monitorStatusId"
  ],
  "properties": {
    "endsAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When did this status change end?"
    },
    "startsAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When did this status change?"
    },
    "monitorId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Relation to Monitor ID Resource in which this object belongs."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "rootCause": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "What is the root cause of this status change?"
    },
    "monitorStatusId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Relation to Monitor Status ID Resource in which this object belongs."
    }
  },
  "additionalProperties": false
}

create_on_call_policy

Create a new On-Call Policy in OneUptime. Returns the created On-Call Policy object with its ID. Use this to add new On-Call Duty Policies to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
name*	string	Any friendly name of this object.
labels	array	Relation to Labels Array where this object is categorized in.
projectId	string	ID of your OneUptime Project in which this object belongs.
isArchived	boolean	Archived on-call policies are hidden from the On-Call Policies list and page no one: incidents and alerts that use them skip them. Unarchiving puts them back in service.
description	string	Friendly description that will help you remember.
customFields	object	Custom Fields on this resource.
acknowledgementTimeoutInMinutes	number	Page again when something this policy paged about is acknowledged but not resolved within this many minutes (5 to 1440). Empty: never.

create_postmortem_status

Create a new Postmortem Status in OneUptime. Returns the created Postmortem Status object with its ID. Use this to add new Postmortem Statuses to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
name*	string	Any friendly name of this object.
color*	object	Color of this resource in Hex (#32a852 for example).
order	integer	Where this status sits in the project's list of postmortem statuses: 1 is the top. A postmortem in the completed status, or in a status below it, counts as done; one above it is still owed. So the not started, draft and completed statuses have to stay in that order. A new status without a number goes just above the completed status. Setting a number moves the status to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them.
projectId	string	ID of your OneUptime Project in which this object belongs.
isArchived	boolean	Archived statuses stay on the incidents whose postmortems are in them, but can't be picked again. The not started, draft and completed statuses can't be archived.
description	string	Friendly description that will help you remember.

create_scheduled_maintenance_event

Create a new Scheduled Maintenance Event in OneUptime. Returns the created Scheduled Maintenance Event object with its ID. Use this to add new Scheduled Maintenance Events to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
hosts	array	List of hosts affected by this event.
title*	string	Title of this scheduled event.
endsAt*	object	When does this event end?
labels	array	Relation to Labels Array where this object is categorized in.
monitors	array	List of monitors attached to this event.
services	array	List of services affected by this event.
startsAt*	object	When does this event start?
iotFleets	array	List of IoT fleets affected by this event.

create_scheduled_maintenance_state

Create a new Scheduled Maintenance State in OneUptime. Returns the created Scheduled Maintenance State object with its ID. Use this to add new Scheduled Maintenance States to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
name*	string	Any friendly name of this object.
color*	object	Color of this resource in Hex (#32a852 for example).
order	integer	Where this state sits in the project's list of scheduled maintenance states: 1 is the top. Events only ever move down the list, so the scheduled, ongoing, ended and completed states have to stay in that order. A new state without a number goes just above the completed state. Setting a number moves the state to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them.
projectId	string	ID of your OneUptime Project in which this object belongs.
isArchived	boolean	Archived states stay on the maintenance events that are in them, but can't be picked again. The scheduled, ongoing, ended and completed states can't be archived.
description	string	Friendly description that will help you remember.

create_scheduled_maintenance_state_timeline

Create a new Scheduled Maintenance State Timeline in OneUptime. Returns the created Scheduled Maintenance State Timeline object with its ID. Use this to add new Scheduled Maintenance State Timelines to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
endsAt	object	When did this status change end?
startsAt	object	When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value.
projectId	string	ID of your OneUptime Project in which this object belongs.
scheduledMaintenanceId*	string	ID of Scheduled Maintenance this resource belongs to.
scheduledMaintenanceStateId*	string	Scheduled Maintenance State ID. Which state does this event belongs to?
shouldStatusPageSubscribersBeNotified	boolean	Should subscribers be notified about this state change?

Input schema (JSON)

create_security_case

Create a new Security Case in OneUptime. Returns the created Security Case object with its ID. Use this to add new Security Cases to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
title*	string	What the case is about, in a line.
labels	array	Labels to filter and report on cases by.
status	string	New, Investigating, Contained or Closed. Every case starts New; closing it records a verdict.
verdict	string	What the case turned out to be, set when it is closed: True Positive, Benign Positive, False Positive or Undetermined.
entities	object	The users, hosts, IP addresses, domains and files the case is about, each as { type, value }. Detections add theirs as they join the case.
priority	string	Critical, High, Medium, Low or Informational. A case opened by a detection starts at the detection's severity and rises when a more severe one joins it.
projectId	string	ID of the project this case belongs to.

create_security_case_note

Create a new Security Case Note in OneUptime. Returns the created Security Case Note object with its ID. Use this to add new Security Case Notes to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
note*	string	The note, in Markdown.
projectId	string	ID of the project this note belongs to.
securityCaseId*	string	ID of the case this note is on.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "securityCaseId",
    "note"
  ],
  "properties": {
    "note": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "The note, in Markdown."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of the project this note belongs to."
    },
    "securityCaseId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of the case this note is on."
    }
  },
  "additionalProperties": false
}

create_security_detection

Create a new Security Detection in OneUptime. Returns the created Security Detection object with its ID. Use this to add new Security Detections to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

No arguments.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {},
  "additionalProperties": false
}

create_security_playbook

Create a new Security Playbook in OneUptime. Returns the created Security Playbook object with its ID. Use this to add new Security Playbooks to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
name*	object	What the playbook does, in a few words.
steps	object	The steps the playbook takes, in order. Each has an action, its settings, and whether it needs approval, may fail without stopping the run, or runs only when threat intel matched.
trigger	string	When the playbook runs on its own: Case Opened, Detection Added (a new detection joins an open case), or Manual (only when somebody runs it).
isEnabled	boolean	Whether the playbook runs on its own. A disabled playbook can still be run by hand from a case.
projectId	string	ID of the project this playbook belongs to.
description	string	When to use the playbook and what it is for.
detectionSource	string	Run only on cases raised by this source: a Detection Rule, Threat Intel or a Connected Product. Empty runs on every source.

create_status_page

Create a new Status Page in OneUptime. Returns the created Status Page object with its ID. Use this to add new Status Pages to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
name*	string	Any friendly name of this object.
theme	string	How the status page looks to visitors: Light, Dark, or System (light or dark, as each visitor's device is set). A status page created without a theme starts with System.
labels	array	Relation to Labels Array where this object is categorized in.
customCSS	string	Status Page Custom CSS. Served only from a verified custom domain.
pageTitle	string	Title of your Status Page. This is used for SEO.
projectId	string	ID of your OneUptime Project in which this object belongs.
footerHTML	string	Status Page Custom HTML Footer. Served only from a verified custom domain.
headerHTML	string

create_status_page_announcement

Create a new Status Page Announcement in OneUptime. Returns the created Status Page Announcement object with its ID. Use this to add new Status Page Announcements to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
title*	string	Title of this resource.
monitors	array	List of monitors affected by this announcement. If none are selected, all subscribers will be notified.
projectId	string	ID of your OneUptime Project in which this object belongs.
attachments	array	Files attached to this announcement.
description*	string	Text of the announcement. This can be in Markdown format.
statusPages	array	Status Pages to show show this announcement on.
endAnnouncementAt	object	When should this announcement hidden?
showAnnouncementAt*

create_team

Create a new Team in OneUptime. Returns the created Team object with its ID. Use this to add new Teams to your project. Note: projectId is inferred from your API key — you do not need to provide it.

destructive

Argument	Type	Description
name*	string	Any friendly name of this object.
projectId	string	ID of your OneUptime Project in which this object belongs.
description	string	Friendly description that will help you remember.
customFields	object	Custom Fields on this resource.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    },
    "customFields": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Custom Fields on this resource."
    }
  },
  "additionalProperties": false
}

delete_alert

Permanently delete a Alert from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Alert to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Alert to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_alert_internal_note

Permanently delete a Alert Internal Note from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Alert Internal Note to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Alert Internal Note to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_alert_severity

Permanently delete a Alert Severity from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Alert Severity to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Alert Severity to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_alert_state

Permanently delete a Alert State from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Alert State to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Alert State to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_alert_state_timeline

Permanently delete a Alert State Timeline from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Alert State Timeline to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Alert State Timeline to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_incident

Permanently delete a Incident from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_incident_alert

Permanently delete a Incident Alert from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident Alert to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident Alert to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_incident_internal_note

Permanently delete a Incident Internal Note from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident Internal Note to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident Internal Note to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_incident_public_note

Permanently delete a Incident Public Note from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident Public Note to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident Public Note to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_incident_severity

Permanently delete a Incident Severity from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident Severity to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident Severity to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_incident_state

Permanently delete a Incident State from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident State to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident State to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_incident_state_timeline

Permanently delete a Incident State Timeline from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident State Timeline to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident State Timeline to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_label

Permanently delete a Label from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Label to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Label to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_monitor

Permanently delete a Monitor from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Monitor to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Monitor to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_monitor_status

Permanently delete a Monitor Status from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Monitor Status to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Monitor Status to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_monitor_status_event

Permanently delete a Monitor Status Event from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Monitor Status Event to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Monitor Status Event to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_on_call_policy

Permanently delete a On-Call Policy from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the On-Call Policy to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the On-Call Policy to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_postmortem_status

Permanently delete a Postmortem Status from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Postmortem Status to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Postmortem Status to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_scheduled_maintenance_event

Permanently delete a Scheduled Maintenance Event from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Scheduled Maintenance Event to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Scheduled Maintenance Event to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_scheduled_maintenance_state

Permanently delete a Scheduled Maintenance State from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Scheduled Maintenance State to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Scheduled Maintenance State to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_scheduled_maintenance_state_timeline

Permanently delete a Scheduled Maintenance State Timeline from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Scheduled Maintenance State Timeline to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Scheduled Maintenance State Timeline to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_security_case

Permanently delete a Security Case from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Security Case to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Security Case to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_security_case_note

Permanently delete a Security Case Note from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Security Case Note to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Security Case Note to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_security_detection

Permanently delete a Security Detection from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Security Detection to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Security Detection to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_security_playbook

Permanently delete a Security Playbook from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Security Playbook to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Security Playbook to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_status_page

Permanently delete a Status Page from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Status Page to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Status Page to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_status_page_announcement

Permanently delete a Status Page Announcement from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Status Page Announcement to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Status Page Announcement to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

delete_team

Permanently delete a Team from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Team to delete. This action is irreversible.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Team to delete. This action is irreversible."
    }
  },
  "additionalProperties": false
}

get_alert

Retrieve a single Alert by its unique ID from OneUptime. Use list_alerts first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Alert to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Alert (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): customFields, createdStateLog, seriesLabels, monitorSummary, telemetryQuery.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Alert to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Alert (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): customFields, createdStateLog, seriesLabels, monitorSummary, telemetryQuery."
    }
  },
  "additionalProperties": false
}

get_alert_internal_note

Retrieve a single Alert Internal Note by its unique ID from OneUptime. Use list_alert_internal_notes first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Alert Internal Note to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Alert Internal Note (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): savedFromChatMessage.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Alert Internal Note to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Alert Internal Note (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): savedFromChatMessage."
    }
  },
  "additionalProperties": false
}

get_alert_severity

Retrieve a single Alert Severity by its unique ID from OneUptime. Use list_alert_severities first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Alert Severity to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Alert Severity (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Alert Severity to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Alert Severity (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

get_alert_state

Retrieve a single Alert State by its unique ID from OneUptime. Use list_alert_states first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Alert State to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Alert State (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Alert State to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Alert State (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

get_alert_state_timeline

Retrieve a single Alert State Timeline by its unique ID from OneUptime. Use list_alert_state_timelines first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Alert State Timeline to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Alert State Timeline (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): stateChangeLog.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Alert State Timeline to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Alert State Timeline (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): stateChangeLog."
    }
  },
  "additionalProperties": false
}

get_incident

Retrieve a single Incident by its unique ID from OneUptime. Use list_incidents first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Incident (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, subscriberNotificationStatusMessageOnPostmortemPublished, customFields, createdStateLog, seriesLabels, monitorSummary, telemetryQuery, statusPagesNotifiedOnCreation.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Incident (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, subscriberNotificationStatusMessageOnPostmortemPublished, customFields, createdStateLog, seriesLabels, monitorSummary, telemetryQuery, statusPagesNotifiedOnCreation."
    }
  },
  "additionalProperties": false
}

get_incident_alert

Retrieve a single Incident Alert by its unique ID from OneUptime. Use list_incident_alerts first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident Alert to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Incident Alert (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident Alert to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Incident Alert (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

get_incident_internal_note

Retrieve a single Incident Internal Note by its unique ID from OneUptime. Use list_incident_internal_notes first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident Internal Note to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Incident Internal Note (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): savedFromChatMessage.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident Internal Note to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Incident Internal Note (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): savedFromChatMessage."
    }
  },
  "additionalProperties": false
}

get_incident_public_note

Retrieve a single Incident Public Note by its unique ID from OneUptime. Use list_incident_public_notes first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident Public Note to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Incident Public Note (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, subscriberNotificationStatusMessageOnNoteUpdated, savedFromChatMessage.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident Public Note to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Incident Public Note (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, subscriberNotificationStatusMessageOnNoteUpdated, savedFromChatMessage."
    }
  },
  "additionalProperties": false
}

get_incident_severity

Retrieve a single Incident Severity by its unique ID from OneUptime. Use list_incident_severities first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident Severity to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Incident Severity (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident Severity to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Incident Severity (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

get_incident_state

Retrieve a single Incident State by its unique ID from OneUptime. Use list_incident_states first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident State to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Incident State (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident State to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Incident State (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

get_incident_state_timeline

Retrieve a single Incident State Timeline by its unique ID from OneUptime. Use list_incident_state_timelines first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident State Timeline to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Incident State Timeline (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, stateChangeLog.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident State Timeline to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Incident State Timeline (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, stateChangeLog."
    }
  },
  "additionalProperties": false
}

get_label

Retrieve a single Label by its unique ID from OneUptime. Use list_labels first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Label to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Label (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Label to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Label (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

get_monitor

Retrieve a single Monitor by its unique ID from OneUptime. Use list_monitors first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Monitor to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Monitor (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): description, customFields, incomingMonitorRequest, incomingEmailMonitorRequest, serverMonitorResponse.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Monitor to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Monitor (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): description, customFields, incomingMonitorRequest, incomingEmailMonitorRequest, serverMonitorResponse."
    }
  },
  "additionalProperties": false
}

get_monitor_status

Retrieve a single Monitor Status by its unique ID from OneUptime. Use list_monitor_statuses first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Monitor Status to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Monitor Status (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Monitor Status to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Monitor Status (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

get_monitor_status_event

Retrieve a single Monitor Status Event by its unique ID from OneUptime. Use list_monitor_status_events first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Monitor Status Event to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Monitor Status Event (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): statusChangeLog.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Monitor Status Event to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Monitor Status Event (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): statusChangeLog."
    }
  },
  "additionalProperties": false
}

get_on_call_policy

Retrieve a single On-Call Policy by its unique ID from OneUptime. Use list_on_call_duty_policies first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the On-Call Policy to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each On-Call Policy (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): customFields.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the On-Call Policy to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each On-Call Policy (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): customFields."
    }
  },
  "additionalProperties": false
}

get_postmortem_status

Retrieve a single Postmortem Status by its unique ID from OneUptime. Use list_postmortem_statuses first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Postmortem Status to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Postmortem Status (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Postmortem Status to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Postmortem Status (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

get_public_status_page_announcements

Get announcements from a public status page. This tool does NOT require an API key and works with public status pages. Status page owners can disable MCP access for their status page. If disabled, this tool returns an error and the data must be read from the status page website or its RSS feed instead. USAGE: - By domain: statusPageIdOrDomain = "status.company.com" - By ID: statusPageIdOrDomain = "550e8400-e29b-41d4-a716-446655440000" RETURNS: - List of active announcements - Announcement details (title, description, dates)

read-only

Argument	Type	Description
announcementId	string	Optional: Specific announcement ID to fetch details for
statusPageIdOrDomain*	string	The status page ID (UUID) or domain name (e.g., 'status.company.com')

Input schema (JSON)

{
  "type": "object",
  "required": [
    "statusPageIdOrDomain"
  ],
  "properties": {
    "announcementId": {
      "type": "string",
      "description": "Optional: Specific announcement ID to fetch details for"
    },
    "statusPageIdOrDomain": {
      "type": "string",
      "description": "The status page ID (UUID) or domain name (e.g., 'status.company.com')"
    }
  },
  "additionalProperties": false
}

get_public_status_page_incidents

Get incidents from a public status page. This tool does NOT require an API key and works with public status pages. Status page owners can disable MCP access for their status page. If disabled, this tool returns an error and the data must be read from the status page website or its RSS feed instead. USAGE: - By domain: statusPageIdOrDomain = "status.company.com" - By ID: statusPageIdOrDomain = "550e8400-e29b-41d4-a716-446655440000" RETURNS: - List of incidents (active and recent history) - Incident details (title, description, severity) - Incident timeline and state changes - Public notes/updates for each incident

read-only

Argument	Type	Description
incidentId	string	Optional: Specific incident ID to fetch details for
statusPageIdOrDomain*	string	The status page ID (UUID) or domain name (e.g., 'status.company.com')

Input schema (JSON)

{
  "type": "object",
  "required": [
    "statusPageIdOrDomain"
  ],
  "properties": {
    "incidentId": {
      "type": "string",
      "description": "Optional: Specific incident ID to fetch details for"
    },
    "statusPageIdOrDomain": {
      "type": "string",
      "description": "The status page ID (UUID) or domain name (e.g., 'status.company.com')"
    }
  },
  "additionalProperties": false
}

get_public_status_page_overview

Get the complete overview of a public status page including current status, resources, active incidents, scheduled maintenance, and announcements. This tool does NOT require an API key and works with public status pages. Status page owners can disable MCP access for their status page. If disabled, this tool returns an error and the data must be read from the status page website or its RSS feed instead. USAGE: - By domain: statusPageIdOrDomain = "status.company.com" - By ID: statusPageIdOrDomain = "550e8400-e29b-41d4-a716-446655440000" RETURNS: - Status page metadata (name, description, branding) - Resources and their current status - Active incidents - Upcoming scheduled maintenance - Active announcements - Monitor status history

read-only

Argument	Type	Description
statusPageIdOrDomain*	string	The status page ID (UUID) or domain name (e.g., 'status.company.com'). Use domain for public status pages with custom domains.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "statusPageIdOrDomain"
  ],
  "properties": {
    "statusPageIdOrDomain": {
      "type": "string",
      "description": "The status page ID (UUID) or domain name (e.g., 'status.company.com'). Use domain for public status pages with custom domains."
    }
  },
  "additionalProperties": false
}

get_public_status_page_scheduled_maintenance

Get scheduled maintenance events from a public status page. This tool does NOT require an API key and works with public status pages. Status page owners can disable MCP access for their status page. If disabled, this tool returns an error and the data must be read from the status page website or its RSS feed instead. USAGE: - By domain: statusPageIdOrDomain = "status.company.com" - By ID: statusPageIdOrDomain = "550e8400-e29b-41d4-a716-446655440000" RETURNS: - List of scheduled maintenance events (upcoming and ongoing) - Maintenance details (title, description, scheduled times) - Maintenance timeline and state changes - Public notes/updates for each maintenance event

read-only

Argument	Type	Description
statusPageIdOrDomain*	string	The status page ID (UUID) or domain name (e.g., 'status.company.com')
scheduledMaintenanceId	string	Optional: Specific scheduled maintenance ID to fetch details for

Input schema (JSON)

{
  "type": "object",
  "required": [
    "statusPageIdOrDomain"
  ],
  "properties": {
    "statusPageIdOrDomain": {
      "type": "string",
      "description": "The status page ID (UUID) or domain name (e.g., 'status.company.com')"
    },
    "scheduledMaintenanceId": {
      "type": "string",
      "description": "Optional: Specific scheduled maintenance ID to fetch details for"
    }
  },
  "additionalProperties": false
}

get_scheduled_maintenance_event

Retrieve a single Scheduled Maintenance Event by its unique ID from OneUptime. Use list_scheduled_maintenance_events first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Scheduled Maintenance Event to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Scheduled Maintenance Event (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, customFields, sendSubscriberNotificationsOnBeforeTheEvent.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Scheduled Maintenance Event to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Scheduled Maintenance Event (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, customFields, sendSubscriberNotificationsOnBeforeTheEvent."
    }
  },
  "additionalProperties": false
}

get_scheduled_maintenance_state

Retrieve a single Scheduled Maintenance State by its unique ID from OneUptime. Use list_scheduled_maintenance_states first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Scheduled Maintenance State to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Scheduled Maintenance State (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Scheduled Maintenance State to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Scheduled Maintenance State (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

get_scheduled_maintenance_state_timeline

Retrieve a single Scheduled Maintenance State Timeline by its unique ID from OneUptime. Use list_scheduled_maintenance_state_timelines first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Scheduled Maintenance State Timeline to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Scheduled Maintenance State Timeline (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Scheduled Maintenance State Timeline to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Scheduled Maintenance State Timeline (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage."
    }
  },
  "additionalProperties": false
}

get_security_case

Retrieve a single Security Case by its unique ID from OneUptime. Use list_security_cases first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Security Case to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Security Case (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): entities, mitreTactics, mitreTechniques.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Security Case to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Security Case (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): entities, mitreTactics, mitreTechniques."
    }
  },
  "additionalProperties": false
}

get_security_case_note

Retrieve a single Security Case Note by its unique ID from OneUptime. Use list_security_case_notes first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Security Case Note to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Security Case Note (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Security Case Note to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Security Case Note (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

get_security_detection

Retrieve a single Security Detection by its unique ID from OneUptime. Use list_security_detections first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Security Detection to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Security Detection (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): entities, mitreTactics, mitreTechniques, sampleMessage.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Security Detection to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Security Detection (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): entities, mitreTactics, mitreTechniques, sampleMessage."
    }
  },
  "additionalProperties": false
}

get_security_playbook

Retrieve a single Security Playbook by its unique ID from OneUptime. Use list_security_playbooks first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Security Playbook to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Security Playbook (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): detectionRuleIds, steps.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Security Playbook to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Security Playbook (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): detectionRuleIds, steps."
    }
  },
  "additionalProperties": false
}

get_status_page

Retrieve a single Status Page by its unique ID from OneUptime. Use list_status_pages first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Status Page to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Status Page (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): headerHTML, footerHTML, allowedSubscriberEmailDomains, customFields, subscriberTimezones, reportRecurringInterval, subscriberEmailNotificationFooterText, ipWhitelist, enabledLanguages.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Status Page to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Status Page (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): headerHTML, footerHTML, allowedSubscriberEmailDomains, customFields, subscriberTimezones, reportRecurringInterval, subscriberEmailNotificationFooterText, ipWhitelist, enabledLanguages."
    }
  },
  "additionalProperties": false
}

get_status_page_announcement

Retrieve a single Status Page Announcement by its unique ID from OneUptime. Use list_status_page_announcements first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Status Page Announcement to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Status Page Announcement (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, subscriberNotificationStatusMessageOnAnnouncementUpdated.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Status Page Announcement to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Status Page Announcement (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, subscriberNotificationStatusMessageOnAnnouncementUpdated."
    }
  },
  "additionalProperties": false
}

get_team

Retrieve a single Team by its unique ID from OneUptime. Use list_teams first if you need to find the ID.

read-only

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Team to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	Optional: field names to return for each Team (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): customFields.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Team to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Team (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): customFields."
    }
  },
  "additionalProperties": false
}

list_alert_internal_notes

List and search Alert Internal Notes from OneUptime with optional filtering, pagination, and sorting. Returns an array of Alert Internal Note objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Alert Internal Notes. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Alert Internal Note (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): savedFromChatMessage.

Input schema (JSON)

list_alert_severities

List and search Alert Severities from OneUptime with optional filtering, pagination, and sorting. Returns an array of Alert Severity objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Alert Severities. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Alert Severity (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "name": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for name field"
        },
        "slug": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for slug field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "archivedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedAt field"
        },
        "isArchived": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isArchived field"
        },
        "description": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for description field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "archivedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedByUserId field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "color": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "order": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 10
          },
          "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        }
      },
      "description": "Filter criteria for Alert Severities. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Alert Severity (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

list_alert_state_timelines

List and search Alert State Timelines from OneUptime with optional filtering, pagination, and sorting. Returns an array of Alert State Timeline objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Alert State Timelines. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Alert State Timeline (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): stateChangeLog.

Input schema (JSON)

list_alert_states

List and search Alert States from OneUptime with optional filtering, pagination, and sorting. Returns an array of Alert State objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Alert States. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Alert State (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "name": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for name field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "archivedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedAt field"
        },
        "isArchived": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isArchived field"
        },
        "description": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for description field"
        },
        "isCreatedState": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isCreatedState field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "isResolvedState": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isResolvedState field"
        },
        "archivedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedByUserId field"
        },
        "isAcknowledgedState": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isAcknowledgedState field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "color": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "order": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 10
          },
          "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "isCreatedState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isCreatedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isResolvedState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isResolvedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isAcknowledgedState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isAcknowledgedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Filter criteria for Alert States. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Alert State (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

list_alerts

List and search Alerts from OneUptime with optional filtering, pagination, and sorting. Returns an array of Alert objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Alerts. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Alert (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): customFields, createdStateLog, seriesLabels, monitorSummary, telemetryQuery.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "title": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for title field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "isPrivate": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isPrivate field"
        },
        "monitorId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for monitorId field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "alertNumber": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for alertNumber field"
        },
        "firstPagedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for firstPagedAt field"
        },
        "alertEpisodeId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for alertEpisodeId field"
        },
        "alertSeverityId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for alertSeverityId field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "enableReminders": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for enableReminders field"
        },
        "impactStartedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for impactStartedAt field"
        },
        "createdByProbeId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByProbeId field"
        },
        "createdCriteriaId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdCriteriaId field"
        },
        "seriesFingerprint": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for seriesFingerprint field"
        },
        "currentAlertStateId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for currentAlertStateId field"
        },
        "alertNumberWithPrefix": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for alertNumberWithPrefix field"
        },
        "isCreatedAutomatically": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isCreatedAutomatically field"
        },
        "aiInvestigationWaitUntil": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for aiInvestigationWaitUntil field"
        },
        "nextReminderNotificationAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for nextReminderNotificationAt field"
        },
        "reminderNotificationSentCount": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for reminderNotificationSentCount field"
        },
        "isOwnerNotifiedOfAlertCreation": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isOwnerNotifiedOfAlertCreation field"
        },
        "monitorStatusWhenThisAlertWasCreatedId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for monitorStatusWhenThisAlertWasCreatedId field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "hosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for hosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "title": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for title field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "labels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "services": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for services field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "iotFleets": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for iotFleets field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "isPrivate": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isPrivate field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "monitorId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for monitorId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "rootCause": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "alertNumber": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for alertNumber field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "dockerHosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "podmanHosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for podmanHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "cephClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for cephClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "customFields": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "firstPagedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for firstPagedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "seriesLabels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for seriesLabels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "storageArrays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for storageArrays field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "alertEpisodeId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for alertEpisodeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "monitorSummary": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for monitorSummary field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "telemetryQuery": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for telemetryQuery field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "vmwareVCenters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for vmwareVCenters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "alertSeverityId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for alertSeverityId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "createdStateLog": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for createdStateLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "databaseServers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for databaseServers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "dockerResources": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "enableReminders": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableReminders field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "impactStartedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for impactStartedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "podmanResources": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for podmanResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "proxmoxClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for proxmoxClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByProbeId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByProbeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "remediationNotes": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for remediationNotes field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdCriteriaId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for createdCriteriaId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "seriesFingerprint": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for seriesFingerprint field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "kubernetesClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for kubernetesClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "onCallDutyPolicies": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for onCallDutyPolicies field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "currentAlertStateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for currentAlertStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "dockerSwarmClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerSwarmClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "kubernetesResources": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for kubernetesResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "kubernetesContainers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for kubernetesContainers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "alertNumberWithPrefix": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for alertNumberWithPrefix field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "isCreatedAutomatically": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isCreatedAutomatically field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "serviceLevelObjectives": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for serviceLevelObjectives field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "aiInvestigationDecision": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for aiInvestigationDecision field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "aiInvestigationWaitUntil": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for aiInvestigationWaitUntil field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "nextReminderNotificationAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for nextReminderNotificationAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "reminderNotificationSentCount": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for reminderNotificationSentCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isOwnerNotifiedOfAlertCreation": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotifiedOfAlertCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "postUpdatesToWorkspaceChannels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "monitorStatusWhenThisAlertWasCreatedId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for monitorStatusWhenThisAlertWasCreatedId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        }
      },
      "description": "Filter criteria for Alerts. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Alert (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): customFields, createdStateLog, seriesLabels, monitorSummary, telemetryQuery."
    }
  },
  "additionalProperties": false
}

list_change_events

Query Change Events telemetry data from OneUptime. IMPORTANT: telemetry tables are large — always filter by a time range and keep limits small (e.g. 10-50). Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

read-only

Argument	Type	Description
skip	number	Number of records to skip. Default: 0.
sort	object	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
query	object	Filter criteria for Change Events. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	object	Fields to return, as an object of field names to true (e.g. {"time": true, "body": true}). Select only the fields you need — telemetry rows can be large.

list_exception_instances

Query Exception Instances telemetry data from OneUptime. IMPORTANT: telemetry tables are large — always filter by a time range and keep limits small (e.g. 10-50). Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

read-only

Argument	Type	Description
skip	number	Number of records to skip. Default: 0.
sort	object	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
query	object	Filter criteria for Exception Instances. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	object	Fields to return, as an object of field names to true (e.g. {"time": true, "body": true}). Select only the fields you need — telemetry rows can be large.

list_incident_alerts

List and search Incident Alerts from OneUptime with optional filtering, pagination, and sorting. Returns an array of Incident Alert objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Incident Alerts. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Incident Alert (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "alertId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for alertId field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "incidentId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for incidentId field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "alertId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for alertId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "incidentId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        }
      },
      "description": "Filter criteria for Incident Alerts. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Incident Alert (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

list_incident_internal_notes

List and search Incident Internal Notes from OneUptime with optional filtering, pagination, and sorting. Returns an array of Incident Internal Note objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Incident Internal Notes. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Incident Internal Note (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): savedFromChatMessage.

Input schema (JSON)

list_incident_public_notes

List and search Incident Public Notes from OneUptime with optional filtering, pagination, and sorting. Returns an array of Incident Public Note objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Incident Public Notes. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Incident Public Note (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, subscriberNotificationStatusMessageOnNoteUpdated, savedFromChatMessage.

Input schema (JSON)

list_incident_severities

List and search Incident Severities from OneUptime with optional filtering, pagination, and sorting. Returns an array of Incident Severity objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Incident Severities. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Incident Severity (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "name": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for name field"
        },
        "slug": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for slug field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "archivedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedAt field"
        },
        "isArchived": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isArchived field"
        },
        "description": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for description field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "archivedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedByUserId field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "color": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "order": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 10
          },
          "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        }
      },
      "description": "Filter criteria for Incident Severities. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Incident Severity (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

list_incident_state_timelines

List and search Incident State Timelines from OneUptime with optional filtering, pagination, and sorting. Returns an array of Incident State Timeline objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Incident State Timelines. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Incident State Timeline (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, stateChangeLog.

Input schema (JSON)

list_incident_states

List and search Incident States from OneUptime with optional filtering, pagination, and sorting. Returns an array of Incident State objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Incident States. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Incident State (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "name": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for name field"
        },
        "slug": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for slug field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "archivedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedAt field"
        },
        "isArchived": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isArchived field"
        },
        "description": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for description field"
        },
        "isCreatedState": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isCreatedState field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "isResolvedState": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isResolvedState field"
        },
        "archivedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedByUserId field"
        },
        "isAcknowledgedState": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isAcknowledgedState field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "color": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "order": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 10
          },
          "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "isCreatedState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isCreatedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isResolvedState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isResolvedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isAcknowledgedState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isAcknowledgedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Filter criteria for Incident States. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Incident State (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

list_incidents

List and search Incidents from OneUptime with optional filtering, pagination, and sorting. Returns an array of Incident objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Incidents. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Incident (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, subscriberNotificationStatusMessageOnPostmortemPublished, customFields, createdStateLog, seriesLabels, monitorSummary, telemetryQuery, statusPagesNotifiedOnCreation.

list_kubernetes_cost_allocations

Query Kubernetes Cost Allocations telemetry data from OneUptime. IMPORTANT: telemetry tables are large — always filter by a time range and keep limits small (e.g. 10-50). Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

read-only

Argument	Type	Description
skip	number	Number of records to skip. Default: 0.
sort	object	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
query	object	Filter criteria for Kubernetes Cost Allocations. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	object

list_labels

List and search Labels from OneUptime with optional filtering, pagination, and sorting. Returns an array of Label objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Labels. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Label (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "name": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for name field"
        },
        "slug": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for slug field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "archivedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedAt field"
        },
        "isArchived": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isArchived field"
        },
        "description": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for description field"
        },
        "nameSortKey": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for nameSortKey field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "archivedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedByUserId field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "color": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "nameSortKey": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for nameSortKey field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        }
      },
      "description": "Filter criteria for Labels. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Label (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

list_logs

Query Logs telemetry data from OneUptime. IMPORTANT: telemetry tables are large — always filter by a time range and keep limits small (e.g. 10-50). Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

read-only

Argument	Type	Description
skip	number	Number of records to skip. Default: 0.
sort	object	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
query	object	Filter criteria for Logs. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	object	Fields to return, as an object of field names to true (e.g. {"time": true, "body": true}). Select only the fields you need — telemetry rows can be large.

list_metrics

Query Metrics telemetry data from OneUptime. IMPORTANT: telemetry tables are large — always filter by a time range and keep limits small (e.g. 10-50). Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

read-only

Argument	Type	Description
skip	number	Number of records to skip. Default: 0.
sort	object	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
query	object	Filter criteria for Metrics. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	object	Fields to return, as an object of field names to true (e.g. {"time": true, "body": true}). Select only the fields you need — telemetry rows can be large.

list_monitor_logs

Query Monitor Logs telemetry data from OneUptime. IMPORTANT: telemetry tables are large — always filter by a time range and keep limits small (e.g. 10-50). Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

read-only

Argument	Type	Description
skip	number	Number of records to skip. Default: 0.
sort	object	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
query	object	Filter criteria for Monitor Logs. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	object	Fields to return, as an object of field names to true (e.g. {"time": true, "body": true}). Select only the fields you need — telemetry rows can be large.

list_monitor_status_events

List and search Monitor Status Events from OneUptime with optional filtering, pagination, and sorting. Returns an array of Monitor Status Event objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Monitor Status Events. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Monitor Status Event (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): statusChangeLog.

Input schema (JSON)

list_monitor_statuses

List and search Monitor Statuses from OneUptime with optional filtering, pagination, and sorting. Returns an array of Monitor Status objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Monitor Statuses. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Monitor Status (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "name": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for name field"
        },
        "slug": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for slug field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "priority": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for priority field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "archivedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedAt field"
        },
        "isArchived": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isArchived field"
        },
        "description": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for description field"
        },
        "isOfflineState": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isOfflineState field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "archivedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedByUserId field"
        },
        "isOperationalState": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isOperationalState field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "color": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "priority": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for priority field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "isOfflineState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOfflineState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOperationalState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOperationalState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Filter criteria for Monitor Statuses. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Monitor Status (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

list_monitors

List and search Monitors from OneUptime with optional filtering, pagination, and sorting. Returns an array of Monitor objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Monitors. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Monitor (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): description, customFields, incomingMonitorRequest, incomingEmailMonitorRequest, serverMonitorResponse.

Input schema (JSON)

list_on_call_duty_policies

List and search On-Call Duty Policies from OneUptime with optional filtering, pagination, and sorting. Returns an array of On-Call Policy objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for On-Call Duty Policies. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each On-Call Policy (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): customFields.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "name": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for name field"
        },
        "slug": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for slug field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "archivedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedAt field"
        },
        "isArchived": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isArchived field"
        },
        "description": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for description field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "archivedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedByUserId field"
        },
        "acknowledgementTimeoutInMinutes": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for acknowledgementTimeoutInMinutes field"
        },
        "repeatPolicyIfNoOneAcknowledges": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for repeatPolicyIfNoOneAcknowledges field"
        },
        "repeatPolicyIfNoOneAcknowledgesNoOfTimes": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for repeatPolicyIfNoOneAcknowledgesNoOfTimes field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "labels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "customFields": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "postUpdatesToWorkspaceChannels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "acknowledgementTimeoutInMinutes": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for acknowledgementTimeoutInMinutes field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "repeatPolicyIfNoOneAcknowledges": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for repeatPolicyIfNoOneAcknowledges field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "repeatPolicyIfNoOneAcknowledgesNoOfTimes": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for repeatPolicyIfNoOneAcknowledgesNoOfTimes field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        }
      },
      "description": "Filter criteria for On-Call Duty Policies. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each On-Call Policy (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): customFields."
    }
  },
  "additionalProperties": false
}

list_postmortem_statuses

List and search Postmortem Statuses from OneUptime with optional filtering, pagination, and sorting. Returns an array of Postmortem Status objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Postmortem Statuses. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Postmortem Status (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "name": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for name field"
        },
        "slug": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for slug field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "archivedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedAt field"
        },
        "isArchived": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isArchived field"
        },
        "description": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for description field"
        },
        "isDraftStatus": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isDraftStatus field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "archivedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedByUserId field"
        },
        "isCompletedStatus": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isCompletedStatus field"
        },
        "isNotStartedStatus": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isNotStartedStatus field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "color": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "order": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 10
          },
          "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "isDraftStatus": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isDraftStatus field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isCompletedStatus": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isCompletedStatus field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "isNotStartedStatus": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isNotStartedStatus field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Filter criteria for Postmortem Statuses. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Postmortem Status (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

list_scheduled_maintenance_events

List and search Scheduled Maintenance Events from OneUptime with optional filtering, pagination, and sorting. Returns an array of Scheduled Maintenance Event objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Scheduled Maintenance Events. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Scheduled Maintenance Event (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, customFields, sendSubscriberNotificationsOnBeforeTheEvent.

list_scheduled_maintenance_state_timelines

List and search Scheduled Maintenance State Timelines from OneUptime with optional filtering, pagination, and sorting. Returns an array of Scheduled Maintenance State Timeline objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Scheduled Maintenance State Timelines. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Scheduled Maintenance State Timeline (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage.

list_scheduled_maintenance_states

List and search Scheduled Maintenance States from OneUptime with optional filtering, pagination, and sorting. Returns an array of Scheduled Maintenance State objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Scheduled Maintenance States. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Scheduled Maintenance State (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "name": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for name field"
        },
        "slug": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for slug field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "archivedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedAt field"
        },
        "isArchived": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isArchived field"
        },
        "description": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for description field"
        },
        "isEndedState": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isEndedState field"
        },
        "isOngoingState": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isOngoingState field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "isResolvedState": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isResolvedState field"
        },
        "archivedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedByUserId field"
        },
        "isScheduledState": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isScheduledState field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "color": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "order": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 10
          },
          "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "isEndedState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isEndedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "isOngoingState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOngoingState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isResolvedState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isResolvedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isScheduledState": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isScheduledState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Filter criteria for Scheduled Maintenance States. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Scheduled Maintenance State (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

list_security_case_notes

List and search Security Case Notes from OneUptime with optional filtering, pagination, and sorting. Returns an array of Security Case Note objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Security Case Notes. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Security Case Note (e.g. ["_id", "name"]). Omit to get all readable fields.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "securityCaseId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for securityCaseId field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "note": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for note field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "securityCaseId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for securityCaseId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        }
      },
      "description": "Filter criteria for Security Case Notes. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Security Case Note (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."
    }
  },
  "additionalProperties": false
}

list_security_cases

List and search Security Cases from OneUptime with optional filtering, pagination, and sorting. Returns an array of Security Case objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Security Cases. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Security Case (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): entities, mitreTactics, mitreTechniques.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "title": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for title field"
        },
        "source": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for source field"
        },
        "status": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for status field"
        },
        "verdict": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for verdict field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "closedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for closedAt field"
        },
        "priority": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for priority field"
        },
        "aiVerdict": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for aiVerdict field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "caseNumber": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for caseNumber field"
        },
        "incidentId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for incidentId field"
        },
        "aiTriagedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for aiTriagedAt field"
        },
        "containedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for containedAt field"
        },
        "groupingKey": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for groupingKey field"
        },
        "acknowledgedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for acknowledgedAt field"
        },
        "closedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for closedByUserId field"
        },
        "detectionCount": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for detectionCount field"
        },
        "lastDetectedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for lastDetectedAt field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "firstDetectedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for firstDetectedAt field"
        },
        "assignedToTeamId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for assignedToTeamId field"
        },
        "assignedToUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for assignedToUserId field"
        },
        "notifiedPriority": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for notifiedPriority field"
        },
        "aiSuggestedPriority": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for aiSuggestedPriority field"
        },
        "caseNumberWithPrefix": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for caseNumberWithPrefix field"
        },
        "aiSuggestedPlaybookId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for aiSuggestedPlaybookId field"
        },
        "aiTriagePromptInjectionSuspected": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for aiTriagePromptInjectionSuspected field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "title": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for title field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "labels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "source": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for source field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "status": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for status field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "verdict": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for verdict field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "closedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for closedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "entities": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for entities field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "priority": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for priority field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "aiVerdict": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for aiVerdict field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "caseNumber": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for caseNumber field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "incidentId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "aiTriagedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for aiTriagedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "closingNote": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for closingNote field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "containedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for containedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "groupingKey": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for groupingKey field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "mitreTactics": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for mitreTactics field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "acknowledgedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for acknowledgedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "aiTriageReport": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for aiTriageReport field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "closedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for closedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "detectionCount": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for detectionCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "lastDetectedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for lastDetectedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "firstDetectedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for firstDetectedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "mitreTechniques": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for mitreTechniques field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "assignedToTeamId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for assignedToTeamId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "assignedToUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for assignedToUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "notifiedPriority": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for notifiedPriority field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "aiSuggestedPriority": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for aiSuggestedPriority field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "caseNumberWithPrefix": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for caseNumberWithPrefix field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "aiSuggestedPlaybookId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for aiSuggestedPlaybookId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "aiTriagePromptInjectionSuspected": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for aiTriagePromptInjectionSuspected field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Filter criteria for Security Cases. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Security Case (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): entities, mitreTactics, mitreTechniques."
    }
  },
  "additionalProperties": false
}

list_security_detections

List and search Security Detections from OneUptime with optional filtering, pagination, and sorting. Returns an array of Security Detection objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Security Detections. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Security Detection (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): entities, mitreTactics, mitreTechniques, sampleMessage.

Input schema (JSON)

list_security_events

Query Security Events telemetry data from OneUptime. IMPORTANT: telemetry tables are large — always filter by a time range and keep limits small (e.g. 10-50). Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

read-only

Argument	Type	Description
skip	number	Number of records to skip. Default: 0.
sort	object	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
query	object	Filter criteria for Security Events. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	object	Fields to return, as an object of field names to true (e.g. {"time": true, "body": true}). Select only the fields you need — telemetry rows can be large.

list_security_playbooks

List and search Security Playbooks from OneUptime with optional filtering, pagination, and sorting. Returns an array of Security Playbook objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Security Playbooks. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Security Playbook (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): detectionRuleIds, steps.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "trigger": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for trigger field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "runCount": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for runCount field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "isEnabled": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isEnabled field"
        },
        "lastRunAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for lastRunAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "description": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for description field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "detectionSource": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for detectionSource field"
        },
        "minimumPriority": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for minimumPriority field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Name. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "steps": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for steps field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "trigger": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for trigger field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "runCount": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for runCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isEnabled": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isEnabled field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "lastRunAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for lastRunAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "detectionSource": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for detectionSource field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "minimumPriority": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for minimumPriority field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "detectionRuleIds": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for detectionRuleIds field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        }
      },
      "description": "Filter criteria for Security Playbooks. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Security Playbook (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): detectionRuleIds, steps."
    }
  },
  "additionalProperties": false
}

list_spans

Query Spans telemetry data from OneUptime. IMPORTANT: telemetry tables are large — always filter by a time range and keep limits small (e.g. 10-50). Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

read-only

Argument	Type	Description
skip	number	Number of records to skip. Default: 0.
sort	object	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
query	object	Filter criteria for Spans. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	object	Fields to return, as an object of field names to true (e.g. {"time": true, "body": true}). Select only the fields you need — telemetry rows can be large.

list_status_page_announcements

List and search Status Page Announcements from OneUptime with optional filtering, pagination, and sorting. Returns an array of Status Page Announcement objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Status Page Announcements. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Status Page Announcement (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, subscriberNotificationStatusMessageOnAnnouncementUpdated.

Input schema (JSON)

list_status_pages

List and search Status Pages from OneUptime with optional filtering, pagination, and sorting. Returns an array of Status Page objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Status Pages. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Status Page (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): headerHTML, footerHTML, allowedSubscriberEmailDomains, customFields, subscriberTimezones, reportRecurringInterval, subscriberEmailNotificationFooterText, ipWhitelist, enabledLanguages.

list_teams

List and search Teams from OneUptime with optional filtering, pagination, and sorting. Returns an array of Team objects plus the total matching count.

read-only

Argument	Type	Description
skip	number	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
sort	object	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100.
query	object	Filter criteria for Teams. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	array	Optional: field names to return for each Team (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): customFields.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "name": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for name field"
        },
        "slug": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for slug field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "description": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for description field"
        },
        "isTeamEditable": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isTeamEditable field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "isTeamDeleteable": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isTeamDeleteable field"
        },
        "isPermissionsEditable": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isPermissionsEditable field"
        },
        "shouldHaveAtLeastOneMember": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for shouldHaveAtLeastOneMember field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "customFields": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "isTeamEditable": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isTeamEditable field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isTeamDeleteable": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isTeamDeleteable field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "isPermissionsEditable": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isPermissionsEditable field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "shouldHaveAtLeastOneMember": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldHaveAtLeastOneMember field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Filter criteria for Teams. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Team (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): customFields."
    }
  },
  "additionalProperties": false
}

list_threat_intel_indicators

Query Threat Intel Indicators telemetry data from OneUptime. IMPORTANT: telemetry tables are large — always filter by a time range and keep limits small (e.g. 10-50). Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.

read-only

Argument	Type	Description
skip	number	Number of records to skip. Default: 0.
sort	object	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.
limit	number	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
query	object	Filter criteria for Threat Intel Indicators. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {"createdAt": {"_type": "GreaterThan", "value": "2026-01-01T00:00:00.000Z"}}.
select	object

oneuptime_help

Get help and guidance for using the OneUptime MCP server. Returns information about available resources and common operations. Use this tool first to understand what you can do with OneUptime. AVAILABLE RESOURCES: - Teams: Groups of users with shared access to project resources. - Labels: Labels for organizing and filtering project resources. - Security Cases: Manages Security Case resources in OneUptime. - Security Case Notes: Manages Security Case Note resources in OneUptime. - Security Detections: Manages Security Detection resources in OneUptime. - Security Playbooks: Manages Security Playbook resources in OneUptime. - Status Pages: Public-facing page showing the status of your services to your customers. - On-Call Duty Policies: Defines escalation rules and schedules for incident response. - Monitors: Defines what to monitor (websites, APIs, servers) and how to check their health and availability. - Monitor Statuses: Represents the health states of monitors (e.g., Operational, Degraded, Offline). - Incident States: Represents the lifecycle states of incidents (e.g., Created, Acknowledged, Resolved). - Incidents: Represents service disruptions or issues affecting your systems. Track incident lifecycle from creation to resolution. - Incident State Timelines: History of state changes for incidents. Creating an entry changes the incident's state (this is how acknowledge/resolve work). - Incident Internal Notes: Internal team-only notes on incidents. - Incident Public Notes: Status-page-visible notes on incidents, seen by customers and subscribers. - Incident Severities: Severity levels for incidents (e.g., Critical, Major, Minor). List these to find the incidentSeverityId required by create_incident. - Postmortem Statuses: Manages Postmortem Status resources in OneUptime. - Alert States: Lifecycle states of alerts (e.g., Created, Acknowledged, Resolved). - Alerts: Notifications triggered when monitors detect issues. Configures who gets notified and how. - Alert State Timelines: History of state changes for alerts. Creating an entry changes the alert's state. - Alert Internal Notes: Internal team-only notes on alerts. - Alert Severities: Severity levels for alerts. List these to find the alertSeverityId required by create_alert. - Incident Alerts: Links an alert to an incident (many-to-many). Create one to link an alert to an incident, delete it to unlink. List these by incidentId to see an incident's linked alerts, or by alertId to see the incidents an alert is linked to. - Monitor Status Events: History of monitor status changes — useful for investigating when a monitor went down or recovered. - Status Page Announcements: Announcements posted to your status pages. - Scheduled Maintenance States: Lifecycle states for maintenance events (e.g., Scheduled, Ongoing, Completed). - Scheduled Maintenance Events: Manages Scheduled Maintenance Event resources in OneUptime. - Scheduled Maintenance State Timelines: Manages Scheduled Maintenance State Timeline resources in OneUptime. - Logs: OpenTelemetry log records from your services. Filter by time range and service. - Spans: OpenTelemetry trace spans from your services. - Metrics: OpenTelemetry metrics from your services. - Exception Instances: Application exceptions captured via telemetry. - Monitor Logs: Raw probe results for monitors — explains why a monitor check passed or failed. - Kubernetes Cost Allocations: Manages Kubernetes Cost Allocation resources in OneUptime. - Security Events: Manages Security Event resources in OneUptime. - Change Events: Manages Change Event resources in OneUptime. - Threat Intel Indicators: Manages Threat Intel Indicator resources in OneUptime. - Acknowledge Incident: Manages Acknowledge Incident resources in OneUptime. COMMON WORKFLOWS: 1. Orient yourself: Use oneuptime_whoami to see your project 2. List incidents: Use list_incidents to see current incidents 3. Respond: Use acknowledge_incident / resolve_incident / add_incident_note 4. Investigate: Use list_logs, list_metrics, list_spans, list_monitor_logs (always with a time-range filter) 5. Create incident: Use list_incident_severities to get a severity ID, then create_incident

oneuptime_list_resources

List all available OneUptime resources and their supported operations. Use this to discover what resources you can manage through the MCP server.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

oneuptime_whoami

Get the project your credentials belong to (ID and name), and - when signed in with OAuth - who you are signed in as and whether you may make changes. Call this first to understand your context. Note: create tools infer projectId from your credentials automatically, so you never need to pass it.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

resolve_alert

Resolve an alert: moves it to the project's 'Resolved' state.

destructive

Argument	Type	Description
alertId*	string	UUID of the alert to resolve. Use list_alerts to find it.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "alertId"
  ],
  "properties": {
    "alertId": {
      "type": "string",
      "description": "UUID of the alert to resolve. Use list_alerts to find it."
    }
  },
  "additionalProperties": false
}

resolve_incident

Resolve an incident: moves it to the project's 'Resolved' state. Equivalent to pressing 'Resolve' in the OneUptime dashboard.

destructive

Argument	Type	Description
incidentId*	string	UUID of the incident to resolve. Use list_incidents to find it.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "incidentId"
  ],
  "properties": {
    "incidentId": {
      "type": "string",
      "description": "UUID of the incident to resolve. Use list_incidents to find it."
    }
  },
  "additionalProperties": false
}

update_alert

Update an existing Alert in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_alert afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Alert to update. Required. Use list_alerts to find IDs.
hosts	array	List of hosts affected by this alert.
title	string	Title of this alert.
labels	array	Relation to Labels Array where this object is categorized in.
services	array	List of services affected by this alert.
iotFleets	array	List of IoT fleets affected by this alert.
isPrivate	boolean	If true, this alert is only visible to its owners (users in 'owner users' and members of 'owner teams'), project admins, and project owners.
monitorId	string	ID of the monitor this alert belongs to.
description

update_alert_internal_note

Update an existing Alert Internal Note in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_alert_internal_note afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Alert Internal Note to update. Required. Use list_alert_internal_notes to find IDs.
note	string	Notes in markdown.
postedAt	object	Date and time the note belongs to in the timeline: when it was written, or - for a note saved from a Slack or Microsoft Teams message - when that message was posted.
attachments	array	Files attached to this note.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Alert Internal Note to update. Required. Use list_alert_internal_notes to find IDs."
    },
    "note": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Notes in markdown."
    },
    "postedAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "Date and time the note belongs to in the timeline: when it was written, or - for a note saved from a Slack or Microsoft Teams message - when that message was posted."
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Files attached to this note."
    }
  },
  "additionalProperties": false
}

update_alert_severity

Update an existing Alert Severity in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_alert_severity afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Alert Severity to update. Required. Use list_alert_severities to find IDs.
name	string	Any friendly name of this object.
color	object	Color of this resource in Hex (#32a852 for example).
order	integer	Where this severity ranks among the project's alert severities: 1 is the most severe. A new severity without a number goes to the end of the list. Setting a number moves the severity to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them.
isArchived	boolean	Archived severities stay on the alerts and episodes that have them, but can't be picked again. A project keeps at least one severity that is not archived.
description	string	Friendly description that will help you remember.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Alert Severity to update. Required. Use list_alert_severities to find IDs."
    },
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "color": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Color of this resource in Hex (#32a852 for example)."
    },
    "order": {
      "type": "integer",
      "example": 10,
      "description": "Where this severity ranks among the project's alert severities: 1 is the most severe. A new severity without a number goes to the end of the list. Setting a number moves the severity to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived severities stay on the alerts and episodes that have them, but can't be picked again. A project keeps at least one severity that is not archived."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    }
  },
  "additionalProperties": false
}

update_alert_state

Update an existing Alert State in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_alert_state afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Alert State to update. Required. Use list_alert_states to find IDs.
name	string	Any friendly name of this object.
color	object	Color of this resource in Hex (#32a852 for example).
order	integer	Where this state sits in the project's list of alert states: 1 is the top. Alerts only ever move down the list, and an alert in a state at or below the acknowledged (or resolved) state counts as acknowledged (or resolved), so the created, acknowledged and resolved states have to stay in that order. A new state without a number goes just above the resolved state. Setting a number moves the state to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them.
isArchived	boolean	Archived states stay on the alerts and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived.
description	string	Friendly description that will help you remember.

update_alert_state_timeline

Update an existing Alert State Timeline in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_alert_state_timeline afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Alert State Timeline to update. Required. Use list_alert_state_timelines to find IDs.
startsAt	object	When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value.
alertStateId	string	Alert State ID Relation. Which alert state does this alert change to?

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Alert State Timeline to update. Required. Use list_alert_state_timelines to find IDs."
    },
    "startsAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value."
    },
    "alertStateId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Alert State ID Relation. Which alert state does this alert change to?"
    }
  },
  "additionalProperties": false
}

update_incident

Update an existing Incident in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_incident afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident to update. Required. Use list_incidents to find IDs.
hosts	array	List of hosts affected by this incident.
title	string	Title of this incident.
labels	array	Relation to Labels Array where this object is categorized in.
monitors	array	List of monitors affected by this incident.
services	array	List of services affected by this incident.
iotFleets	array	List of IoT fleets affected by this incident.
isPrivate	boolean	If true, this incident is only visible to its owners (users in 'owner users' and members of 'owner teams'), project admins, and project owners. Private incidents are hidden from status pages.

update_incident_alert

Update an existing Incident Alert in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_incident_alert afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident Alert to update. Required. Use list_incident_alerts to find IDs.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident Alert to update. Required. Use list_incident_alerts to find IDs."
    }
  },
  "additionalProperties": false
}

update_incident_internal_note

Update an existing Incident Internal Note in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_incident_internal_note afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident Internal Note to update. Required. Use list_incident_internal_notes to find IDs.
note	string	Notes in markdown.
postedAt	object	Date and time the note belongs to in the timeline: when it was written, or - for a note saved from a Slack or Microsoft Teams message - when that message was posted.
attachments	array	Files attached to this note.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident Internal Note to update. Required. Use list_incident_internal_notes to find IDs."
    },
    "note": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Notes in markdown."
    },
    "postedAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "Date and time the note belongs to in the timeline: when it was written, or - for a note saved from a Slack or Microsoft Teams message - when that message was posted."
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Files attached to this note."
    }
  },
  "additionalProperties": false
}

update_incident_public_note

Update an existing Incident Public Note in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_incident_public_note afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident Public Note to update. Required. Use list_incident_public_notes to find IDs.
note	string	Notes in markdown.
postedAt	object	Date and time when the note was posted.
attachments	array	Files attached to this note.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident Public Note to update. Required. Use list_incident_public_notes to find IDs."
    },
    "note": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Notes in markdown."
    },
    "postedAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "Date and time when the note was posted."
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Files attached to this note."
    }
  },
  "additionalProperties": false
}

update_incident_severity

Update an existing Incident Severity in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_incident_severity afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident Severity to update. Required. Use list_incident_severities to find IDs.
name	string	Any friendly name of this object.
color	object	Color of this resource in Hex (#32a852 for example).
order	integer	Where this severity ranks among the project's incident severities: 1 is the most severe. A new severity without a number goes to the end of the list. Setting a number moves the severity to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them.
isArchived	boolean	Archived severities stay on the incidents and episodes that have them, but can't be picked again. A project keeps at least one severity that is not archived.
description	string	Friendly description that will help you remember.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident Severity to update. Required. Use list_incident_severities to find IDs."
    },
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "color": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Color of this resource in Hex (#32a852 for example)."
    },
    "order": {
      "type": "integer",
      "example": 10,
      "description": "Where this severity ranks among the project's incident severities: 1 is the most severe. A new severity without a number goes to the end of the list. Setting a number moves the severity to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived severities stay on the incidents and episodes that have them, but can't be picked again. A project keeps at least one severity that is not archived."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    }
  },
  "additionalProperties": false
}

update_incident_state

Update an existing Incident State in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_incident_state afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident State to update. Required. Use list_incident_states to find IDs.
name	string	Any friendly name of this object.
color	object	Color of this resource in Hex (#32a852 for example).
order	integer	Where this state sits in the project's list of incident states: 1 is the top. Incidents only ever move down the list, and an incident in a state at or below the acknowledged (or resolved) state counts as acknowledged (or resolved), so the created, acknowledged and resolved states have to stay in that order. A new state without a number goes just above the resolved state. Setting a number moves the state to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them.
isArchived	boolean	Archived states stay on the incidents and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived.
description	string	Friendly description that will help you remember.

update_incident_state_timeline

Update an existing Incident State Timeline in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_incident_state_timeline afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Incident State Timeline to update. Required. Use list_incident_state_timelines to find IDs.
startsAt	object	When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value.
incidentStateId	string	Incident State ID Relation. Which incident state does this incident change to?

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident State Timeline to update. Required. Use list_incident_state_timelines to find IDs."
    },
    "startsAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value."
    },
    "incidentStateId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Incident State ID Relation. Which incident state does this incident change to?"
    }
  },
  "additionalProperties": false
}

update_label

Update an existing Label in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_label afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Label to update. Required. Use list_labels to find IDs.
name	string	Any friendly name of this object.
color	object	Color of this resource in Hex (#32a852 for example).
isArchived	boolean	Archived labels stay on everything that has them, but can't be added to anything again.
description	string	Friendly description that will help you remember.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Label to update. Required. Use list_labels to find IDs."
    },
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "color": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Color of this resource in Hex (#32a852 for example)."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived labels stay on everything that has them, but can't be added to anything again."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    }
  },
  "additionalProperties": false
}

update_monitor

Update an existing Monitor in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_monitor afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Monitor to update. Required. Use list_monitors to find IDs.
name	string	Any friendly name for this monitor.
hosts	array	Hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
labels	array	Relation to Labels Array where this object is categorized in.
services	array	Services this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
iotFleets	array	IoT fleets this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
isArchived	boolean	Archived monitors are hidden from monitor lists and status pages, are not checked, and open no incidents or alerts. Unarchiving resumes monitoring.

update_monitor_status

Update an existing Monitor Status in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_monitor_status afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Monitor Status to update. Required. Use list_monitor_statuses to find IDs.
name	string	Any friendly name of this object.
color	object	Color of this resource in Hex (#32a852 for example).
priority	number	Where this status sits in the project's list of monitor statuses, from the healthiest (the lowest number) down to the worst: where monitors are shown together, as on a status page or in a monitor group, the status furthest down the list wins. A new status without a number goes just above the offline status. Setting a number moves the status to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them.
isArchived	boolean	Archived statuses stay on the monitors that are in them, but can't be picked again. The operational and offline statuses can't be archived.
description	string	Friendly description that will help you remember.

update_monitor_status_event

Update an existing Monitor Status Event in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_monitor_status_event afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Monitor Status Event to update. Required. Use list_monitor_status_events to find IDs.
monitorStatusId	string	Relation to Monitor Status ID Resource in which this object belongs.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Monitor Status Event to update. Required. Use list_monitor_status_events to find IDs."
    },
    "monitorStatusId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Relation to Monitor Status ID Resource in which this object belongs."
    }
  },
  "additionalProperties": false
}

update_on_call_policy

Update an existing On-Call Policy in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_on_call_policy afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the On-Call Policy to update. Required. Use list_on_call_duty_policies to find IDs.
name	string	Any friendly name of this object.
labels	array	Relation to Labels Array where this object is categorized in.
isArchived	boolean	Archived on-call policies are hidden from the On-Call Policies list and page no one: incidents and alerts that use them skip them. Unarchiving puts them back in service.
description	string	Friendly description that will help you remember.
customFields	object	Custom Fields on this resource.
acknowledgementTimeoutInMinutes	number	Page again when something this policy paged about is acknowledged but not resolved within this many minutes (5 to 1440). Empty: never.

update_postmortem_status

Update an existing Postmortem Status in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_postmortem_status afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Postmortem Status to update. Required. Use list_postmortem_statuses to find IDs.
name	string	Any friendly name of this object.
color	object	Color of this resource in Hex (#32a852 for example).
order	integer	Where this status sits in the project's list of postmortem statuses: 1 is the top. A postmortem in the completed status, or in a status below it, counts as done; one above it is still owed. So the not started, draft and completed statuses have to stay in that order. A new status without a number goes just above the completed status. Setting a number moves the status to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them.
isArchived	boolean	Archived statuses stay on the incidents whose postmortems are in them, but can't be picked again. The not started, draft and completed statuses can't be archived.
description	string	Friendly description that will help you remember.

update_scheduled_maintenance_event

Update an existing Scheduled Maintenance Event in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_scheduled_maintenance_event afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Scheduled Maintenance Event to update. Required. Use list_scheduled_maintenance_events to find IDs.
hosts	array	List of hosts affected by this event.
title	string	Title of this scheduled event.
endsAt	object	When does this event end?
labels	array	Relation to Labels Array where this object is categorized in.
monitors	array	List of monitors attached to this event.
services	array	List of services affected by this event.
startsAt	object	When does this event start?
iotFleets

update_scheduled_maintenance_state

Update an existing Scheduled Maintenance State in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_scheduled_maintenance_state afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Scheduled Maintenance State to update. Required. Use list_scheduled_maintenance_states to find IDs.
name	string	Any friendly name of this object.
color	object	Color of this resource in Hex (#32a852 for example).
order	integer	Where this state sits in the project's list of scheduled maintenance states: 1 is the top. Events only ever move down the list, so the scheduled, ongoing, ended and completed states have to stay in that order. A new state without a number goes just above the completed state. Setting a number moves the state to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them.
isArchived	boolean	Archived states stay on the maintenance events that are in them, but can't be picked again. The scheduled, ongoing, ended and completed states can't be archived.
description	string	Friendly description that will help you remember.

update_scheduled_maintenance_state_timeline

Update an existing Scheduled Maintenance State Timeline in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_scheduled_maintenance_state_timeline afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Scheduled Maintenance State Timeline to update. Required. Use list_scheduled_maintenance_state_timelines to find IDs.
startsAt	object	When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value.
scheduledMaintenanceStateId	string	Scheduled Maintenance State ID. Which state does this event belongs to?

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Scheduled Maintenance State Timeline to update. Required. Use list_scheduled_maintenance_state_timelines to find IDs."
    },
    "startsAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value."
    },
    "scheduledMaintenanceStateId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": " Scheduled Maintenance State ID. Which state does this event belongs to?"
    }
  },
  "additionalProperties": false
}

update_security_case

Update an existing Security Case in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_security_case afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Security Case to update. Required. Use list_security_cases to find IDs.
title	string	What the case is about, in a line.
labels	array	Labels to filter and report on cases by.
status	string	New, Investigating, Contained or Closed. Every case starts New; closing it records a verdict.
verdict	string	What the case turned out to be, set when it is closed: True Positive, Benign Positive, False Positive or Undetermined.
entities	object	The users, hosts, IP addresses, domains and files the case is about, each as { type, value }. Detections add theirs as they join the case.
priority	string	Critical, High, Medium, Low or Informational. A case opened by a detection starts at the detection's severity and rises when a more severe one joins it.

update_security_case_note

Update an existing Security Case Note in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_security_case_note afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Security Case Note to update. Required. Use list_security_case_notes to find IDs.
note	string	The note, in Markdown.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Security Case Note to update. Required. Use list_security_case_notes to find IDs."
    },
    "note": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "The note, in Markdown."
    }
  },
  "additionalProperties": false
}

update_security_detection

Update an existing Security Detection in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_security_detection afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Security Detection to update. Required. Use list_security_detections to find IDs.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Security Detection to update. Required. Use list_security_detections to find IDs."
    }
  },
  "additionalProperties": false
}

update_security_playbook

Update an existing Security Playbook in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_security_playbook afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Security Playbook to update. Required. Use list_security_playbooks to find IDs.
name	object	What the playbook does, in a few words.
steps	object	The steps the playbook takes, in order. Each has an action, its settings, and whether it needs approval, may fail without stopping the run, or runs only when threat intel matched.
trigger	string	When the playbook runs on its own: Case Opened, Detection Added (a new detection joins an open case), or Manual (only when somebody runs it).
isEnabled	boolean	Whether the playbook runs on its own. A disabled playbook can still be run by hand from a case.
description	string	When to use the playbook and what it is for.
detectionSource	string	Run only on cases raised by this source: a Detection Rule, Threat Intel or a Connected Product. Empty runs on every source.

update_status_page

Update an existing Status Page in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_status_page afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Status Page to update. Required. Use list_status_pages to find IDs.
name	string	Any friendly name of this object.
theme	string	How the status page looks to visitors: Light, Dark, or System (light or dark, as each visitor's device is set). A status page created without a theme starts with System.
labels	array	Relation to Labels Array where this object is categorized in.
customCSS	string	Status Page Custom CSS. Served only from a verified custom domain.
pageTitle	string	Title of your Status Page. This is used for SEO.
footerHTML	string	Status Page Custom HTML Footer. Served only from a verified custom domain.
headerHTML	string

update_status_page_announcement

Update an existing Status Page Announcement in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_status_page_announcement afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Status Page Announcement to update. Required. Use list_status_page_announcements to find IDs.
title	string	Title of this resource.
monitors	array	List of monitors affected by this announcement. If none are selected, all subscribers will be notified.
attachments	array	Files attached to this announcement.
description	string	Text of the announcement. This can be in Markdown format.
statusPages	array	Status Pages to show show this announcement on.
endAnnouncementAt	object	When should this announcement hidden?
showAnnouncementAt	object	When should this announcement be shown?

update_team

Update an existing Team in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_team afterwards to see the updated record.

destructive

Argument	Type	Description
id*	string	The unique identifier (UUID) of the Team to update. Required. Use list_teams to find IDs.
name	string	Any friendly name of this object.
description	string	Friendly description that will help you remember.
customFields	object	Custom Fields on this resource.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Team to update. Required. Use list_teams to find IDs."
    },
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    },
    "customFields": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Custom Fields on this resource."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "title",
    "alertSeverityId"
  ],
  "properties": {
    "hosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of hosts affected by this alert."
    },
    "title": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Title of this alert."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Relation to Labels Array where this object is categorized in."
    },
    "services": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of services affected by this alert."
    },
    "iotFleets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of IoT fleets affected by this alert."
    },
    "isPrivate": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "If true, this alert is only visible to its owners (users in 'owner users' and members of 'owner teams'), project admins, and project owners."
    },
    "monitorId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of the monitor this alert belongs to."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "rootCause": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "What is the root cause of this alert?"
    },
    "description": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Short description of this alert. This will be visible on the status page. This is in markdown."
    },
    "dockerHosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Docker hosts affected by this alert."
    },
    "podmanHosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Podman hosts affected by this alert."
    },
    "cephClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Ceph clusters affected by this alert."
    },
    "customFields": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Custom Fields on this resource."
    },
    "storageArrays": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of storage arrays affected by this alert."
    },
    "telemetryQuery": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Telemetry query for this alert."
    },
    "vmwareVCenters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of vCenters affected by this alert."
    },
    "alertSeverityId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Alert Severity ID."
    },
    "databaseServers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of databases affected by this alert."
    },
    "dockerResources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Docker resources (containers, images, networks, volumes) affected by this alert."
    },
    "enableReminders": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should reminder notifications be sent to owners while this alert is still open? Reminders are sent based on the reminder rules configured for this project."
    },
    "impactStartedAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When customer impact actually began. Left blank until someone records it - never inferred, because a guessed value is worse than no value."
    },
    "podmanResources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Podman resources (containers, images, networks, volumes) affected by this alert."
    },
    "proxmoxClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Proxmox clusters affected by this alert."
    },
    "remediationNotes": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Notes on how to remediate this alert. This is in markdown."
    },
    "kubernetesClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Kubernetes clusters affected by this alert."
    },
    "onCallDutyPolicies": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of on-call duty policies affected by this alert."
    },
    "currentAlertStateId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Current Alert State ID."
    },
    "dockerSwarmClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Docker Swarm clusters affected by this alert."
    },
    "kubernetesResources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Kubernetes resources (pods, deployments, nodes, etc.) affected by this alert."
    },
    "kubernetesContainers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Kubernetes containers affected by this alert."
    },
    "serviceLevelObjectives": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Service Level Objectives (SLOs) affected by this alert."
    },
    "monitorStatusWhenThisAlertWasCreatedId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Monitor Status ID when this alert was created."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "name",
    "color"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "color": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Color of this resource in Hex (#32a852 for example)."
    },
    "order": {
      "type": "integer",
      "example": 10,
      "description": "Where this state sits in the project's list of alert states: 1 is the top. Alerts only ever move down the list, and an alert in a state at or below the acknowledged (or resolved) state counts as acknowledged (or resolved), so the created, acknowledged and resolved states have to stay in that order. A new state without a number goes just above the resolved state. Setting a number moves the state to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived states stay on the alerts and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    },
    "isCreatedState": {
      "type": "boolean",
      "example": true,
      "description": "Is it the created state of the alert?"
    },
    "isResolvedState": {
      "type": "boolean",
      "example": true,
      "description": "Is it the resolved state of the alert?"
    },
    "isAcknowledgedState": {
      "type": "boolean",
      "example": true,
      "description": "Is it the acknowledged state of the alert?"
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "title",
    "incidentSeverityId"
  ],
  "properties": {
    "hosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of hosts affected by this incident."
    },
    "title": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Title of this incident."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Relation to Labels Array where this object is categorized in."
    },
    "monitors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of monitors affected by this incident."
    },
    "services": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of services affected by this incident."
    },
    "iotFleets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of IoT fleets affected by this incident."
    },
    "isPrivate": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "If true, this incident is only visible to its owners (users in 'owner users' and members of 'owner teams'), project admins, and project owners. Private incidents are hidden from status pages."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "rootCause": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "What is the root cause of this incident?"
    },
    "declaredAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "Date and time when this incident was declared."
    },
    "description": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Short description of this incident. This is in markdown and will be visible on the status page."
    },
    "dockerHosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Docker hosts affected by this incident."
    },
    "podmanHosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Podman hosts affected by this incident."
    },
    "statusPages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Limit this incident to these status pages. When set, the incident is shown on, and notifies the subscribers of, only these pages among the status pages that list its monitors. Leave empty to reach every status page that lists its monitors."
    },
    "cephClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Ceph clusters affected by this incident."
    },
    "customFields": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "The incident's custom field values, keyed by each incident custom field's name. When a user or an API key creates or updates an incident, each value it sets or changes must fit its field - a number for a Number field, true or false for a Boolean, one of the options for a Dropdown, and so on - or the request is refused. Values left as they were, keys that are not the name of a field and empty values are not checked. Required on Create is not enforced here: it applies to the dashboard's Declare Incident form only."
    },
    "storageArrays": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of storage arrays affected by this incident."
    },
    "postmortemNote": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Document the postmortem summary for this incident."
    },
    "telemetryQuery": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Telemetry query for this incident."
    },
    "vmwareVCenters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of vCenters affected by this incident."
    },
    "databaseServers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of databases affected by this incident."
    },
    "dockerResources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Docker resources (containers, images, networks, volumes) affected by this incident."
    },
    "enableReminders": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should reminder notifications be sent to owners while this incident is still open? Reminders are sent based on the reminder rules configured for this project."
    },
    "impactStartedAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When customer impact actually began. Left blank until someone records it - never inferred, because a guessed value is worse than no value."
    },
    "podmanResources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Podman resources (containers, images, networks, volumes) affected by this incident."
    },
    "proxmoxClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Proxmox clusters affected by this incident."
    },
    "remediationNotes": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Notes on how to remediate this incident. This is in markdown."
    },
    "incidentSeverityId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Incident Severity ID."
    },
    "kubernetesClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Kubernetes clusters affected by this incident."
    },
    "onCallDutyPolicies": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of on-call duty policies affected by this incident."
    },
    "postmortemPostedAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "Timestamp that will be shown alongside the published postmortem on the status page."
    },
    "postmortemStatusId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of the incident's postmortem status. Left out on create, the postmortem starts in the project's not started status - or its draft status when the incident is created with a postmortem note, its completed status when that note is published on a status page."
    },
    "dockerSwarmClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Docker Swarm clusters affected by this incident."
    },
    "kubernetesResources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Kubernetes resources (pods, deployments, nodes, etc.) affected by this incident."
    },
    "kubernetesContainers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Kubernetes containers affected by this incident."
    },
    "isVisibleOnStatusPage": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should this incident be visible on the status page?"
    },
    "postmortemAttachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Files that accompany the postmortem note and can be shared publicly when enabled."
    },
    "currentIncidentStateId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Current Incident State ID."
    },
    "serviceLevelObjectives": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Service Level Objectives (SLOs) affected by this incident."
    },
    "changeMonitorStatusToId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Relation to Monitor Status Object ID. All monitors connected to this incident will be changed to this status when the incident is created."
    },
    "showPostmortemOnStatusPage": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Should the postmortem note and attachments be visible on the status page once published?"
    },
    "notifySubscribersOnPostmortemPublished": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should subscribers be notified when the postmortem is published?"
    },
    "shouldStatusPageSubscribersBeNotifiedOnIncidentCreated": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should subscribers be notified about this incident?"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "required": [
    "name",
    "color"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "color": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Color of this resource in Hex (#32a852 for example)."
    },
    "order": {
      "type": "integer",
      "example": 10,
      "description": "Where this severity ranks among the project's incident severities: 1 is the most severe. A new severity without a number goes to the end of the list. Setting a number moves the severity to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived severities stay on the incidents and episodes that have them, but can't be picked again. A project keeps at least one severity that is not archived."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "name",
    "color"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "color": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Color of this resource in Hex (#32a852 for example)."
    },
    "order": {
      "type": "integer",
      "example": 10,
      "description": "Where this state sits in the project's list of incident states: 1 is the top. Incidents only ever move down the list, and an incident in a state at or below the acknowledged (or resolved) state counts as acknowledged (or resolved), so the created, acknowledged and resolved states have to stay in that order. A new state without a number goes just above the resolved state. Setting a number moves the state to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived states stay on the incidents and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    },
    "isCreatedState": {
      "type": "boolean",
      "example": true,
      "description": "Is it the created state of the incident?"
    },
    "isResolvedState": {
      "type": "boolean",
      "example": true,
      "description": "Is it the resolved state of the incident?"
    },
    "isAcknowledgedState": {
      "type": "boolean",
      "example": true,
      "description": "Is it the acknowledged state of the incident?"
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "name",
    "monitorType"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name for this monitor."
    },
    "hosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Relation to Labels Array where this object is categorized in."
    },
    "services": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Services this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "iotFleets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "IoT fleets this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived monitors are hidden from monitor lists and status pages, are not checked, and open no incidents or alerts. Unarchiving resumes monitoring."
    },
    "description": {
      "type": "string",
      "example": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
      "description": "Friendly description that will help you remember."
    },
    "dockerHosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Docker hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "monitorType": {
      "enum": [
        "Manual",
        "Website",
        "API",
        "Ping",
        "Kubernetes",
        "Docker",
        "Host",
        "Podman",
        "Docker Swarm",
        "Proxmox",
        "VMware",
        "Ceph",
        "Storage Array",
        "IoT Device",
        "IP",
        "Incoming Request",
        "Incoming Email",
        "Port",
        "Server",
        "SSL Certificate",
        "SQL Query",
        "Database",
        "Synthetic Monitor",
        "Custom JavaScript Code",
        "Logs",
        "Metrics",
        "Traces",
        "Exceptions",
        "Profiles",
        "Security Events",
        "AI / LLM",
        "Network Device",
        "DNS",
        "DNSSEC",
        "NTP",
        "Domain",
        "External Status Page",
        "Probe Status"
      ],
      "type": "string",
      "example": "HTTP",
      "description": "What is the type of this monitor? Website? API? etc."
    },
    "podmanHosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Podman hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "cephClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Ceph clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "customFields": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Custom Fields on this resource."
    },
    "monitorSteps": {
      "type": "object",
      "example": {
        "_type": "MonitorSteps",
        "value": {
          "monitorStepsInstanceArray": []
        }
      },
      "description": "What would you like to monitor and what is the criteria?"
    },
    "storageArrays": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Storage arrays this monitor watches. Incidents and alerts it creates are linked to them."
    },
    "vmwareVCenters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "VMware vCenters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "databaseServers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Databases this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "proxmoxClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Proxmox clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "dependsOnMonitors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Parent monitors this monitor depends on. When a parent is offline (or in one of the configured suppression statuses), alerts and incidents from this monitor are suppressed at creation time — the monitor keeps evaluating and its status timeline still updates."
    },
    "monitorTemplateId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of the Monitor Template this monitor was created from. Null for monitors not created from a template."
    },
    "kubernetesClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Kubernetes clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "monitoringInterval": {
      "type": "string",
      "example": "Example short text",
      "description": "How often would you like OneUptime to monitor this resource? A 5-field cron expression, not a label: \"*/5 * * * *\" is every five minutes."
    },
    "dockerSwarmClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Docker Swarm clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "minimumProbeAgreement": {
      "type": "number",
      "example": 42,
      "description": "Minimum number of probes that must agree on a status before the monitor status changes. If null, all enabled and connected probes must agree."
    },
    "serverMonitorResponse": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Server Monitor Response for Server Monitor."
    },
    "currentMonitorStatusId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Whats the current status ID of this monitor?"
    },
    "incomingMonitorRequest": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Incoming Monitor Request for Incoming Request Monitor."
    },
    "disableActiveMonitoring": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Disable active monitoring for this resource?"
    },
    "telemetryMonitorLastMonitorAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "This field is for Telemetry Monitor only. When was the last time we monitored?"
    },
    "telemetryMonitorNextMonitorAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "This field is for Telemetry Monitor only. When is the next time we should monitor?"
    },
    "serverMonitorRequestReceivedAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "This field is for Server Monitor only. When was the last time we received a request?"
    },
    "suppressAlertsWhenParentMonitorStatuses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Parent monitor statuses that suppress this monitor's alerts and incidents. When empty, statuses flagged as offline suppress (the default). Only used when Depends On Monitors is set."
    },
    "incomingRequestMonitorHeartbeatCheckedAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "This field is for Incoming Request monitor only. When was the last time we checked the heartbeat?"
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "name",
    "color"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "color": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Color of this resource in Hex (#32a852 for example)."
    },
    "priority": {
      "type": "number",
      "example": 42,
      "description": "Where this status sits in the project's list of monitor statuses, from the healthiest (the lowest number) down to the worst: where monitors are shown together, as on a status page or in a monitor group, the status furthest down the list wins. A new status without a number goes just above the offline status. Setting a number moves the status to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived statuses stay on the monitors that are in them, but can't be picked again. The operational and offline statuses can't be archived."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    },
    "isOfflineState": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Is this monitor in offline state?"
    },
    "isOperationalState": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Is this monitor in operational state?"
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Relation to Labels Array where this object is categorized in."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived on-call policies are hidden from the On-Call Policies list and page no one: incidents and alerts that use them skip them. Unarchiving puts them back in service."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    },
    "customFields": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Custom Fields on this resource."
    },
    "acknowledgementTimeoutInMinutes": {
      "type": "number",
      "example": 42,
      "description": "Page again when something this policy paged about is acknowledged but not resolved within this many minutes (5 to 1440). Empty: never."
    },
    "repeatPolicyIfNoOneAcknowledges": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Repeat the policy if no one acknowledges the alert."
    },
    "repeatPolicyIfNoOneAcknowledgesNoOfTimes": {
      "type": "number",
      "default": 0,
      "example": 42,
      "description": "Repeat the policy X number of times if no one acknowledges the alert."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "name",
    "color"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "color": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Color of this resource in Hex (#32a852 for example)."
    },
    "order": {
      "type": "integer",
      "example": 10,
      "description": "Where this status sits in the project's list of postmortem statuses: 1 is the top. A postmortem in the completed status, or in a status below it, counts as done; one above it is still owed. So the not started, draft and completed statuses have to stay in that order. A new status without a number goes just above the completed status. Setting a number moves the status to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived statuses stay on the incidents whose postmortems are in them, but can't be picked again. The not started, draft and completed statuses can't be archived."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    },
    "isDraftStatus": {
      "type": "boolean",
      "example": true,
      "description": "Is it the status a postmortem moves to once its note is written? A project has one, and it can't be deleted or archived."
    },
    "isCompletedStatus": {
      "type": "boolean",
      "example": true,
      "description": "Is it the status a postmortem moves to once it is published on a status page? A postmortem in this status, or in one below it, counts as done. A project has one, and it can't be deleted or archived."
    },
    "isNotStartedStatus": {
      "type": "boolean",
      "example": true,
      "description": "Is it the status a new incident's postmortem starts in? A project has one, and it can't be deleted or archived."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "title",
    "startsAt",
    "endsAt"
  ],
  "properties": {
    "hosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of hosts affected by this event."
    },
    "title": {
      "type": "string",
      "example": "Example short text",
      "description": "Title of this scheduled event."
    },
    "endsAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When does this event end?"
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Relation to Labels Array where this object is categorized in."
    },
    "monitors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of monitors attached to this event."
    },
    "services": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of services affected by this event."
    },
    "startsAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When does this event start?"
    },
    "iotFleets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of IoT fleets affected by this event."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "description": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Description of this scheduled event that will show up on Status Page. This is in markdown."
    },
    "dockerHosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Docker hosts affected by this event."
    },
    "podmanHosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Podman hosts affected by this event."
    },
    "statusPages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of status pages to show this event on."
    },
    "cephClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Ceph clusters affected by this event."
    },
    "customFields": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Custom Fields on this resource."
    },
    "networkSites": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of network sites affected by this event. Their descendants are covered too."
    },
    "storageArrays": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of storage arrays affected by this event."
    },
    "vmwareVCenters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of vCenters affected by this event."
    },
    "databaseServers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of databases affected by this event."
    },
    "enableReminders": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should reminder notifications be sent to owners while this scheduled maintenance event is still not complete? Reminders are sent based on the reminder rules configured for this project."
    },
    "proxmoxClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Proxmox clusters affected by this event."
    },
    "kubernetesClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Kubernetes clusters affected by this event."
    },
    "dockerSwarmClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Docker Swarm clusters affected by this event."
    },
    "isVisibleOnStatusPage": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should this incident be visible on the status page?"
    },
    "changeMonitorStatusToId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Relation to Monitor Status Object ID. The monitors attached to this event change to this status when the event starts, and back to operational when it ends. It can be changed until the event starts."
    },
    "currentScheduledMaintenanceStateId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Scheduled Maintenance State ID. The state the event currently is in."
    },
    "nextSubscriberNotificationBeforeTheEventAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When will the next notification to subscribers be sent out?"
    },
    "sendSubscriberNotificationsOnBeforeTheEvent": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Should subscribers be notified before the event?"
    },
    "shouldStatusPageSubscribersBeNotifiedOnEventCreated": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should subscribers be notified about this event creation?"
    },
    "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should subscribers be notified about this event event is changed to ended?"
    },
    "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should subscribers be notified about this event event is changed to ongoing?"
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "name",
    "color"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "color": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Color of this resource in Hex (#32a852 for example)."
    },
    "order": {
      "type": "integer",
      "example": 10,
      "description": "Where this state sits in the project's list of scheduled maintenance states: 1 is the top. Events only ever move down the list, so the scheduled, ongoing, ended and completed states have to stay in that order. A new state without a number goes just above the completed state. Setting a number moves the state to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived states stay on the maintenance events that are in them, but can't be picked again. The scheduled, ongoing, ended and completed states can't be archived."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    },
    "isEndedState": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Is this state a ended state?"
    },
    "isOngoingState": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Is this state a ongoing state?"
    },
    "isResolvedState": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Is this state a resolved state?"
    },
    "isScheduledState": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Is this state a scheduled state?"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "required": [
    "scheduledMaintenanceId",
    "scheduledMaintenanceStateId"
  ],
  "properties": {
    "endsAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When did this status change end?"
    },
    "startsAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "scheduledMaintenanceId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of Scheduled Maintenance this resource belongs to."
    },
    "scheduledMaintenanceStateId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": " Scheduled Maintenance State ID. Which state does this event belongs to?"
    },
    "shouldStatusPageSubscribersBeNotified": {
      "type": "boolean",
      "example": true,
      "description": "Should subscribers be notified about this state change?"
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "title"
  ],
  "properties": {
    "title": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "What the case is about, in a line."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Labels to filter and report on cases by."
    },
    "status": {
      "type": "string",
      "default": "New",
      "example": "Example short text",
      "description": "New, Investigating, Contained or Closed. Every case starts New; closing it records a verdict."
    },
    "verdict": {
      "type": "string",
      "example": "Example short text",
      "description": "What the case turned out to be, set when it is closed: True Positive, Benign Positive, False Positive or Undetermined."
    },
    "entities": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "The users, hosts, IP addresses, domains and files the case is about, each as { type, value }. Detections add theirs as they join the case."
    },
    "priority": {
      "type": "string",
      "default": "Medium",
      "example": "Example short text",
      "description": "Critical, High, Medium, Low or Informational. A case opened by a detection starts at the detection's severity and rises when a more severe one joins it."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of the project this case belongs to."
    },
    "closingNote": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Why the case was closed the way it was, in Markdown: what was found and what was done."
    },
    "description": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "What is known about the threat, in Markdown. A case opened by a detection starts with the detection's description."
    },
    "mitreTactics": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "ATT&CK tactic ids (TA0006) the case's detections are tagged with."
    },
    "mitreTechniques": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "ATT&CK technique ids (T1110) the case's detections are tagged with."
    },
    "assignedToTeamId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of the team whose queue the case is in."
    },
    "assignedToUserId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of the person working the case."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "object",
      "example": {
        "_type": "Name",
        "value": "John Doe"
      },
      "description": "What the playbook does, in a few words."
    },
    "steps": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "The steps the playbook takes, in order. Each has an action, its settings, and whether it needs approval, may fail without stopping the run, or runs only when threat intel matched."
    },
    "trigger": {
      "type": "string",
      "default": "Case Opened",
      "example": "Example short text",
      "description": "When the playbook runs on its own: Case Opened, Detection Added (a new detection joins an open case), or Manual (only when somebody runs it)."
    },
    "isEnabled": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Whether the playbook runs on its own. A disabled playbook can still be run by hand from a case."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of the project this playbook belongs to."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "When to use the playbook and what it is for."
    },
    "detectionSource": {
      "type": "string",
      "example": "Example short text",
      "description": "Run only on cases raised by this source: a Detection Rule, Threat Intel or a Connected Product. Empty runs on every source."
    },
    "minimumPriority": {
      "type": "string",
      "example": "Example short text",
      "description": "Run only on cases at this priority or above. Empty runs on every priority."
    },
    "detectionRuleIds": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Run only on cases with a detection from one of these detection rules. Empty runs on cases from any rule."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "theme": {
      "type": "string",
      "default": "Light",
      "example": "Example short text",
      "description": "How the status page looks to visitors: Light, Dark, or System (light or dark, as each visitor's device is set). A status page created without a theme starts with System."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Relation to Labels Array where this object is categorized in."
    },
    "customCSS": {
      "type": "string",
      "example": "body { color: #333; margin: 0; }",
      "description": "Status Page Custom CSS. Served only from a verified custom domain."
    },
    "pageTitle": {
      "type": "string",
      "example": "Example short text",
      "description": "Title of your Status Page. This is used for SEO."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "footerHTML": {
      "type": "string",
      "example": "<div><h1>Title</h1><p>Content</p></div>",
      "description": "Status Page Custom HTML Footer. Served only from a verified custom domain."
    },
    "headerHTML": {
      "type": "string",
      "example": "<div><h1>Title</h1><p>Content</p></div>",
      "description": "Status Page Custom HTML Header. Served only from a verified custom domain."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived status pages are hidden from the Status Pages list, are not served to visitors, and send nothing to their subscribers. Unarchiving puts them back online."
    },
    "logoFileId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Status Page Logo File ID."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    },
    "ipWhitelist": {
      "type": "string",
      "example": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
      "description": "IP Whitelist for this Status Page. One IP per line. Only used if the status page is private."
    },
    "logoAltText": {
      "type": "string",
      "example": "Example short text",
      "description": "Alternative text for the logo image, read by screen readers for accessibility."
    },
    "customFields": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Custom Fields on this resource."
    },
    "smtpConfigId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your SMTP Config Resource which is used to send email to subscribers."
    },
    "copyrightText": {
      "type": "string",
      "example": "Example short text",
      "description": "Copyright Text."
    },
    "faviconFileId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Status Page Favicon File ID."
    },
    "masterPassword": {
      "type": "string",
      "format": "password",
      "example": "hashed_string_value",
      "description": "Password required to unlock a private status page. This value is stored as a secure hash."
    },
    "reportTimezone": {
      "type": "string",
      "default": "UTC",
      "example": "Example short text",
      "description": "The timezone report periods and send times are resolved in. A monthly report in this timezone runs from the 1st at 00:00 to the last day at 23:59."
    },
    "callSmsConfigId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your Call/SMS Config Resource which is used to send SMS to subscribers."
    },
    "defaultBarColor": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Default color of the bar on the overview page."
    },
    "defaultLanguage": {
      "type": "string",
      "default": "en",
      "example": "Example short text",
      "description": "Default language that the status page is shown in when a visitor arrives for the first time."
    },
    "enableMcpServer": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Can AI agents read this status page over the public OneUptime MCP server? This does not affect the status page website, its RSS feed, or its public JSON API."
    },
    "isReportEnabled": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Whether this status page's email subscribers get reports. Turned on without a schedule, reports go out on the 1st of every month at 09:00 in the report timezone, each covering the calendar month before it."
    },
    "pageDescription": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Description of your Status Page. This is used for SEO."
    },
    "coverImageFileId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Status Page Cover Image ID."
    },
    "customJavaScript": {
      "type": "string",
      "example": "function example() { return true; }",
      "description": "Status Page Custom JavaScript. This runs when the status page is loaded from a verified custom domain."
    },
    "enabledLanguages": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Languages offered in the footer language switcher. Leave empty to offer all supported languages."
    },
    "reportDataInDays": {
      "type": "number",
      "default": 30,
      "example": 42,
      "description": "How many days of data should be included in the report?"
    },
    "reportPeriodType": {
      "type": "string",
      "default": "Rolling",
      "example": "Example short text",
      "description": "Should the report cover a rolling number of days, or the previous whole calendar period?"
    },
    "sendNextReportBy": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When the next report goes out. The server works it out from the schedule."
    },
    "coverImageAltText": {
      "type": "string",
      "example": "Example short text",
      "description": "Alternative text for the cover image, read by screen readers for accessibility. Leave blank if the cover image is purely decorative."
    },
    "isPublicStatusPage": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Is this status page public?"
    },
    "requireSsoForLogin": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Should SSO be required to login to Private Status Page."
    },
    "reportStartDateTime": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When the first report goes out. Every later one follows it by the recurring interval, at the same time of day. Left out when reports are turned on, it is 09:00 in the report timezone at the start of the next period of the interval: the next 1st of the month for a monthly schedule (the default), the next Monday for a weekly one, the next day for a daily one and the next 1 January for a yearly one. An hourly schedule starts at the next full hour."
    },
    "subscriberTimezones": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Timezones of subscribers to this status page."
    },
    "enableMasterPassword": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Require visitors to enter a master password before viewing a private status page."
    },
    "enableSmsSubscribers": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Can SMS subscribers subscribe to this Status Page?"
    },
    "enableEmailSubscribers": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Can email subscribers subscribe to this Status Page?"
    },
    "enableSlackSubscribers": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Can Slack subscribers subscribe to this Status Page?"
    },
    "onlyShowScopedIncidents": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "When on, this status page shows and notifies its subscribers about only the incidents limited to it. Incidents that are not limited to any status page never reach it."
    },
    "overviewPageDescription": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Overview Page description for your status page. This is a markdown field."
    },
    "reportRecurringInterval": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "How often a report goes out. Left out when reports are turned on, it is every month."
    },
    "showUptimeHistoryInDays": {
      "type": "number",
      "default": 90,
      "example": 42,
      "description": "How many days of uptime history should be shown on the status page? Maximum is 90 days."
    },
    "enableWebhookSubscribers": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Can Webhook subscribers subscribe to this Status Page?"
    },
    "showEpisodeHistoryInDays": {
      "type": "number",
      "default": 14,
      "example": 42,
      "description": "How many days of episode history to show on the status page."
    },
    "showEpisodesOnStatusPage": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Show Incident Episodes on Status Page?"
    },
    "showIncidentHistoryInDays": {
      "type": "number",
      "default": 14,
      "example": 42,
      "description": "How many days of incident history should be shown on the status page (in days)?"
    },
    "showIncidentsOnStatusPage": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Show Incidents on Status Page?"
    },
    "embeddedOverallStatusToken": {
      "type": "string",
      "example": "Example short text",
      "description": "Security token required to access the embedded overall status badge. This token must be provided in the URL."
    },
    "enableSearchEngineIndexing": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should search engines like Google and Bing be allowed to index this status page? Turn this off to keep the page reachable by link but out of search results."
    },
    "enableEmbeddedOverallStatus": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Enable embedded overall status badge that can be displayed on external websites?"
    },
    "sendSubscriberNotifications": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Does this status page tell its subscribers anything? Off, it sends them nothing - no message about an incident, an episode, scheduled maintenance or an announcement, and no report - however the event was created. Its subscribers are kept, and the channel switches still decide how visitors can sign up."
    },
    "allowedSubscriberEmailDomains": {
      "type": "string",
      "example": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
      "description": "The domains an email subscriber's address may be at, one a line, such as acme.com. An address at a subdomain of one matches too. Sign-ups and additions at any other domain are refused, and an email subscriber at another domain is sent nothing. Empty: any domain."
    },
    "overallUptimePercentPrecision": {
      "type": "string",
      "default": "99.99% (Two Decimal)",
      "example": "Example short text",
      "description": "Overall Precision of uptime percent for this status page."
    },
    "showAnnouncementHistoryInDays": {
      "type": "number",
      "default": 14,
      "example": 42,
      "description": "How many days of announcement history should be shown on the status page (in days)?"
    },
    "showAnnouncementsOnStatusPage": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Show Announcements on Status Page?"
    },
    "showEpisodeLabelsOnStatusPage": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Show Episode Labels on Status Page?"
    },
    "hidePoweredByOneUptimeBranding": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Hide Powered By OneUptime Branding?"
    },
    "limitSubscribersToPrivateUsers": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Only people who can sign in to this status page can be its subscribers, each with the email address they sign in with: no other address, and no phone, Slack, Microsoft Teams or webhook. A subscriber whose address is not a private user of this page - one removed since, by SCIM or by hand - is sent nothing."
    },
    "showIncidentLabelsOnStatusPage": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Show Incident Labels on Status Page?"
    },
    "showSubscriberPageOnStatusPage": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Show Subscriber Page on Status Page?"
    },
    "enableMicrosoftTeamsSubscribers": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Can Microsoft Teams subscribers subscribe to this Status Page?"
    },
    "privateUserSessionLengthInHours": {
      "type": "number",
      "example": 42,
      "description": "How long, in hours, a private user stays signed in to this private status page after signing in, however active they are - with a password, SSO or OIDC. When the time is up they sign in again. Applies to readers signed in now too. A whole number from 1 to 8760; empty for no limit, where a reader stays signed in while they open the page at least once every 30 days."
    },
    "showScheduledEventHistoryInDays": {
      "type": "number",
      "default": 14,
      "example": 42,
      "description": "How many days of scheduled event history should be shown on the status page (in days)?"
    },
    "allowSubscribersToChooseResources": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Can subscribers choose which resources to subscribe to?"
    },
    "allowSubscribersToChooseEventTypes": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Can subscribers choose which event type like Announcements, Incidents, Scheduled Events to subscribe to?"
    },
    "showOverallUptimePercentOnStatusPage": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Show Overall Uptime Percent on Status Page?"
    },
    "showScheduledEventLabelsOnStatusPage": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Show Scheduled Event Labels on Status Page?"
    },
    "subscriberEmailNotificationFooterText": {
      "type": "string",
      "example": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
      "description": "Text to send to subscribers in the footer of the email."
    },
    "showScheduledMaintenanceEventsOnStatusPage": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Show Scheduled Maintenance Events on Status Page?"
    },
    "enableCustomSubscriberEmailNotificationFooterText": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Enable custom footer text in subscriber email notifications."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "title",
    "showAnnouncementAt",
    "description"
  ],
  "properties": {
    "title": {
      "type": "string",
      "example": "Example short text",
      "description": "Title of this resource."
    },
    "monitors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of monitors affected by this announcement. If none are selected, all subscribers will be notified."
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your OneUptime Project in which this object belongs."
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Files attached to this announcement."
    },
    "description": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Text of the announcement. This can be in Markdown format."
    },
    "statusPages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Status Pages to show show this announcement on."
    },
    "endAnnouncementAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When should this announcement hidden?"
    },
    "showAnnouncementAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When should this announcement be shown?"
    },
    "shouldStatusPageSubscribersBeNotified": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should subscribers be notified about this announcement?"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "alertId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for alertId field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "postedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for postedAt field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "isOwnerNotified": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isOwnerNotified field"
        },
        "postedFromSlackMessageId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for postedFromSlackMessageId field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "note": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for note field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "alertId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for alertId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "postedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for postedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "attachments": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for attachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOwnerNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "savedFromChatMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for savedFromChatMessage field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "postedFromSlackMessageId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postedFromSlackMessageId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        }
      },
      "description": "Filter criteria for Alert Internal Notes. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Alert Internal Note (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): savedFromChatMessage."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "endsAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for endsAt field"
        },
        "alertId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for alertId field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "startsAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for startsAt field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "alertStateId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for alertStateId field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "isOwnerNotified": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isOwnerNotified field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "endsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "alertId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for alertId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "startsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "rootCause": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "alertStateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for alertStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "stateChangeLog": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for stateChangeLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOwnerNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Filter criteria for Alert State Timelines. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Alert State Timeline (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): stateChangeLog."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip. Default: 0."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "title": {
          "type": "string",
          "description": "title field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "eventType": {
          "type": "string",
          "description": "eventType field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "description": {
          "type": "string",
          "description": "description field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        }
      },
      "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "time": {
          "type": "string",
          "description": "time field"
        },
        "title": {
          "type": "string",
          "description": "title field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "eventType": {
          "type": "string",
          "description": "eventType field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "attributes": {
          "type": "string",
          "description": "attributes field"
        },
        "description": {
          "type": "string",
          "description": "description field"
        },
        "attributeKeys": {
          "type": "string",
          "description": "attributeKeys field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        }
      },
      "description": "Filter criteria for Change Events. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "boolean",
          "example": true,
          "description": "Select _id field in the response"
        },
        "time": {
          "type": "boolean",
          "example": true,
          "description": "Select time field in the response"
        },
        "title": {
          "type": "boolean",
          "example": true,
          "description": "Select title field in the response"
        },
        "createdAt": {
          "type": "boolean",
          "example": true,
          "description": "Select createdAt field in the response"
        },
        "eventType": {
          "type": "boolean",
          "example": true,
          "description": "Select eventType field in the response"
        },
        "projectId": {
          "type": "boolean",
          "example": true,
          "description": "Select projectId field in the response"
        },
        "attributes": {
          "type": "boolean",
          "example": true,
          "description": "Select attributes field in the response"
        },
        "description": {
          "type": "boolean",
          "example": true,
          "description": "Select description field in the response"
        },
        "attributeKeys": {
          "type": "boolean",
          "example": true,
          "description": "Select attributeKeys field in the response"
        },
        "retentionDate": {
          "type": "boolean",
          "example": true,
          "description": "Select retentionDate field in the response"
        },
        "primaryEntityId": {
          "type": "boolean",
          "example": true,
          "description": "Select primaryEntityId field in the response"
        },
        "primaryEntityType": {
          "type": "boolean",
          "example": true,
          "description": "Select primaryEntityType field in the response"
        }
      },
      "description": "Fields to return, as an object of field names to true (e.g. {\"time\": true, \"body\": true}). Select only the fields you need — telemetry rows can be large.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip. Default: 0."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "spanId": {
          "type": "string",
          "description": "spanId field"
        },
        "escaped": {
          "type": "string",
          "description": "escaped field"
        },
        "message": {
          "type": "string",
          "description": "message field"
        },
        "release": {
          "type": "string",
          "description": "release field"
        },
        "traceId": {
          "type": "string",
          "description": "traceId field"
        },
        "spanName": {
          "type": "string",
          "description": "spanName field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "sessionId": {
          "type": "string",
          "description": "sessionId field"
        },
        "stackTrace": {
          "type": "string",
          "description": "stackTrace field"
        },
        "environment": {
          "type": "string",
          "description": "environment field"
        },
        "fingerprint": {
          "type": "string",
          "description": "fingerprint field"
        },
        "parsedFrames": {
          "type": "string",
          "description": "parsedFrames field"
        },
        "exceptionType": {
          "type": "string",
          "description": "exceptionType field"
        },
        "hostEntityKey": {
          "type": "string",
          "description": "hostEntityKey field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "spanStatusCode": {
          "type": "string",
          "description": "spanStatusCode field"
        },
        "k8sPodEntityKey": {
          "type": "string",
          "description": "k8sPodEntityKey field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "k8sNodeEntityKey": {
          "type": "string",
          "description": "k8sNodeEntityKey field"
        },
        "serviceEntityKey": {
          "type": "string",
          "description": "serviceEntityKey field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        },
        "containerEntityKey": {
          "type": "string",
          "description": "containerEntityKey field"
        },
        "k8sClusterEntityKey": {
          "type": "string",
          "description": "k8sClusterEntityKey field"
        }
      },
      "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "time": {
          "type": "string",
          "description": "time field"
        },
        "spanId": {
          "type": "string",
          "description": "spanId field"
        },
        "escaped": {
          "type": "string",
          "description": "escaped field"
        },
        "message": {
          "type": "string",
          "description": "message field"
        },
        "release": {
          "type": "string",
          "description": "release field"
        },
        "traceId": {
          "type": "string",
          "description": "traceId field"
        },
        "spanName": {
          "type": "string",
          "description": "spanName field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "sessionId": {
          "type": "string",
          "description": "sessionId field"
        },
        "attributes": {
          "type": "string",
          "description": "attributes field"
        },
        "entityKeys": {
          "type": "string",
          "description": "entityKeys field"
        },
        "stackTrace": {
          "type": "string",
          "description": "stackTrace field"
        },
        "environment": {
          "type": "string",
          "description": "environment field"
        },
        "fingerprint": {
          "type": "string",
          "description": "fingerprint field"
        },
        "parsedFrames": {
          "type": "string",
          "description": "parsedFrames field"
        },
        "timeUnixNano": {
          "type": "string",
          "description": "timeUnixNano field"
        },
        "attributeKeys": {
          "type": "string",
          "description": "attributeKeys field"
        },
        "exceptionType": {
          "type": "string",
          "description": "exceptionType field"
        },
        "hostEntityKey": {
          "type": "string",
          "description": "hostEntityKey field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "spanStatusCode": {
          "type": "string",
          "description": "spanStatusCode field"
        },
        "k8sPodEntityKey": {
          "type": "string",
          "description": "k8sPodEntityKey field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "k8sNodeEntityKey": {
          "type": "string",
          "description": "k8sNodeEntityKey field"
        },
        "serviceEntityKey": {
          "type": "string",
          "description": "serviceEntityKey field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        },
        "containerEntityKey": {
          "type": "string",
          "description": "containerEntityKey field"
        },
        "k8sClusterEntityKey": {
          "type": "string",
          "description": "k8sClusterEntityKey field"
        }
      },
      "description": "Filter criteria for Exception Instances. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "boolean",
          "example": true,
          "description": "Select _id field in the response"
        },
        "time": {
          "type": "boolean",
          "example": true,
          "description": "Select time field in the response"
        },
        "spanId": {
          "type": "boolean",
          "example": true,
          "description": "Select spanId field in the response"
        },
        "escaped": {
          "type": "boolean",
          "example": true,
          "description": "Select escaped field in the response"
        },
        "message": {
          "type": "boolean",
          "example": true,
          "description": "Select message field in the response"
        },
        "release": {
          "type": "boolean",
          "example": true,
          "description": "Select release field in the response"
        },
        "traceId": {
          "type": "boolean",
          "example": true,
          "description": "Select traceId field in the response"
        },
        "spanName": {
          "type": "boolean",
          "example": true,
          "description": "Select spanName field in the response"
        },
        "createdAt": {
          "type": "boolean",
          "example": true,
          "description": "Select createdAt field in the response"
        },
        "projectId": {
          "type": "boolean",
          "example": true,
          "description": "Select projectId field in the response"
        },
        "sessionId": {
          "type": "boolean",
          "example": true,
          "description": "Select sessionId field in the response"
        },
        "attributes": {
          "type": "boolean",
          "example": true,
          "description": "Select attributes field in the response"
        },
        "entityKeys": {
          "type": "boolean",
          "example": true,
          "description": "Select entityKeys field in the response"
        },
        "stackTrace": {
          "type": "boolean",
          "example": true,
          "description": "Select stackTrace field in the response"
        },
        "environment": {
          "type": "boolean",
          "example": true,
          "description": "Select environment field in the response"
        },
        "fingerprint": {
          "type": "boolean",
          "example": true,
          "description": "Select fingerprint field in the response"
        },
        "parsedFrames": {
          "type": "boolean",
          "example": true,
          "description": "Select parsedFrames field in the response"
        },
        "timeUnixNano": {
          "type": "boolean",
          "example": true,
          "description": "Select timeUnixNano field in the response"
        },
        "attributeKeys": {
          "type": "boolean",
          "example": true,
          "description": "Select attributeKeys field in the response"
        },
        "exceptionType": {
          "type": "boolean",
          "example": true,
          "description": "Select exceptionType field in the response"
        },
        "hostEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select hostEntityKey field in the response"
        },
        "retentionDate": {
          "type": "boolean",
          "example": true,
          "description": "Select retentionDate field in the response"
        },
        "spanStatusCode": {
          "type": "boolean",
          "example": true,
          "description": "Select spanStatusCode field in the response"
        },
        "k8sPodEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select k8sPodEntityKey field in the response"
        },
        "primaryEntityId": {
          "type": "boolean",
          "example": true,
          "description": "Select primaryEntityId field in the response"
        },
        "k8sNodeEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select k8sNodeEntityKey field in the response"
        },
        "serviceEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select serviceEntityKey field in the response"
        },
        "primaryEntityType": {
          "type": "boolean",
          "example": true,
          "description": "Select primaryEntityType field in the response"
        },
        "containerEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select containerEntityKey field in the response"
        },
        "k8sClusterEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select k8sClusterEntityKey field in the response"
        }
      },
      "description": "Fields to return, as an object of field names to true (e.g. {\"time\": true, \"body\": true}). Select only the fields you need — telemetry rows can be large.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "postedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for postedAt field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "incidentId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for incidentId field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "isOwnerNotified": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isOwnerNotified field"
        },
        "postedFromSlackMessageId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for postedFromSlackMessageId field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "note": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for note field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "postedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for postedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "incidentId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "attachments": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for attachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOwnerNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "savedFromChatMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for savedFromChatMessage field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "postedFromSlackMessageId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postedFromSlackMessageId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        }
      },
      "description": "Filter criteria for Incident Internal Notes. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Incident Internal Note (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): savedFromChatMessage."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "postedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for postedAt field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "incidentId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for incidentId field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "isOwnerNotified": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isOwnerNotified field"
        },
        "postedFromSlackMessageId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for postedFromSlackMessageId field"
        },
        "postedWithIncidentStateId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for postedWithIncidentStateId field"
        },
        "subscriberNotificationStatusMessage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatusMessage field"
        },
        "subscriberNotificationStatusOnNoteCreated": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatusOnNoteCreated field"
        },
        "subscriberNotificationStatusOnNoteUpdated": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatusOnNoteUpdated field"
        },
        "subscriberNotificationStatusMessageOnNoteUpdated": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatusMessageOnNoteUpdated field"
        },
        "shouldStatusPageSubscribersBeNotifiedOnNoteCreated": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for shouldStatusPageSubscribersBeNotifiedOnNoteCreated field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "note": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for note field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "postedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for postedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "incidentId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "attachments": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for attachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOwnerNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "savedFromChatMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for savedFromChatMessage field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "postedFromSlackMessageId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postedFromSlackMessageId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "postedWithIncidentStateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for postedWithIncidentStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "subscriberNotificationStatusMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationStatusOnNoteCreated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatusOnNoteCreated field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationStatusOnNoteUpdated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatusOnNoteUpdated field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationStatusMessageOnNoteUpdated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessageOnNoteUpdated field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "shouldStatusPageSubscribersBeNotifiedOnNoteCreated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldStatusPageSubscribersBeNotifiedOnNoteCreated field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Filter criteria for Incident Public Notes. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Incident Public Note (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, subscriberNotificationStatusMessageOnNoteUpdated, savedFromChatMessage."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "endsAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for endsAt field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "startsAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for startsAt field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "incidentId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for incidentId field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "incidentStateId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for incidentStateId field"
        },
        "isOwnerNotified": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isOwnerNotified field"
        },
        "subscriberNotificationStatus": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatus field"
        },
        "subscriberNotificationStatusMessage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatusMessage field"
        },
        "shouldStatusPageSubscribersBeNotified": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for shouldStatusPageSubscribersBeNotified field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "endsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "startsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "rootCause": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "incidentId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "stateChangeLog": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for stateChangeLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "incidentStateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incidentStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOwnerNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "subscriberNotificationStatus": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatus field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationStatusMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "shouldStatusPageSubscribersBeNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldStatusPageSubscribersBeNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Filter criteria for Incident State Timelines. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Incident State Timeline (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, stateChangeLog."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "slug": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for slug field"
        },
        "title": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for title field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "isPrivate": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isPrivate field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "declaredAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for declaredAt field"
        },
        "firstPagedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for firstPagedAt field"
        },
        "holdsMonitors": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for holdsMonitors field"
        },
        "incidentNumber": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for incidentNumber field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "enableReminders": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for enableReminders field"
        },
        "impactStartedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for impactStartedAt field"
        },
        "createdByProbeId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByProbeId field"
        },
        "createdCriteriaId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdCriteriaId field"
        },
        "incidentEpisodeId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for incidentEpisodeId field"
        },
        "seriesFingerprint": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for seriesFingerprint field"
        },
        "incidentSeverityId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for incidentSeverityId field"
        },
        "postmortemPostedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for postmortemPostedAt field"
        },
        "postmortemStatusId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for postmortemStatusId field"
        },
        "isScopedToStatusPages": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isScopedToStatusPages field"
        },
        "isVisibleOnStatusPage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isVisibleOnStatusPage field"
        },
        "currentIncidentStateId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for currentIncidentStateId field"
        },
        "isCreatedAutomatically": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isCreatedAutomatically field"
        },
        "changeMonitorStatusToId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for changeMonitorStatusToId field"
        },
        "aiInvestigationWaitUntil": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for aiInvestigationWaitUntil field"
        },
        "incidentNumberWithPrefix": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for incidentNumberWithPrefix field"
        },
        "createdIncidentTemplateId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdIncidentTemplateId field"
        },
        "nextReminderNotificationAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for nextReminderNotificationAt field"
        },
        "showPostmortemOnStatusPage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for showPostmortemOnStatusPage field"
        },
        "postmortemDraftWaitingSince": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for postmortemDraftWaitingSince field"
        },
        "reminderNotificationSentCount": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for reminderNotificationSentCount field"
        },
        "isOwnerNotifiedOfResourceCreation": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isOwnerNotifiedOfResourceCreation field"
        },
        "subscriberNotificationStatusMessage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatusMessage field"
        },
        "notifySubscribersOnPostmortemPublished": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for notifySubscribersOnPostmortemPublished field"
        },
        "subscriberNotificationStatusOnIncidentCreated": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatusOnIncidentCreated field"
        },
        "subscriberNotificationClaimedAtOnIncidentCreated": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationClaimedAtOnIncidentCreated field"
        },
        "subscriberNotificationStatusOnPostmortemPublished": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatusOnPostmortemPublished field"
        },
        "subscriberNotificationClaimedAtOnPostmortemPublished": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationClaimedAtOnPostmortemPublished field"
        },
        "shouldStatusPageSubscribersBeNotifiedOnIncidentCreated": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for shouldStatusPageSubscribersBeNotifiedOnIncidentCreated field"
        },
        "subscriberNotificationStatusMessageOnPostmortemPublished": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatusMessageOnPostmortemPublished field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "hosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for hosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "title": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for title field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "labels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "monitors": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for monitors field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "services": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for services field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "iotFleets": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for iotFleets field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "isPrivate": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isPrivate field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "rootCause": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "declaredAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for declaredAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "dockerHosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "podmanHosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for podmanHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "statusPages": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for statusPages field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "cephClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for cephClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "customFields": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "firstPagedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for firstPagedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "seriesLabels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for seriesLabels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "holdsMonitors": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for holdsMonitors field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "storageArrays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for storageArrays field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "incidentNumber": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for incidentNumber field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "monitorSummary": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for monitorSummary field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "postmortemNote": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postmortemNote field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "telemetryQuery": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for telemetryQuery field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "vmwareVCenters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for vmwareVCenters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "createdStateLog": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for createdStateLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "databaseServers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for databaseServers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "dockerResources": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "enableReminders": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableReminders field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "impactStartedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for impactStartedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "podmanResources": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for podmanResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "proxmoxClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for proxmoxClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByProbeId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByProbeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "remediationNotes": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for remediationNotes field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdCriteriaId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for createdCriteriaId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "incidentEpisodeId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incidentEpisodeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "seriesFingerprint": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for seriesFingerprint field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "incidentSeverityId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incidentSeverityId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "kubernetesClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for kubernetesClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "onCallDutyPolicies": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for onCallDutyPolicies field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "postmortemPostedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for postmortemPostedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "postmortemStatusId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for postmortemStatusId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "dockerSwarmClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerSwarmClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "kubernetesResources": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for kubernetesResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "kubernetesContainers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for kubernetesContainers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "isScopedToStatusPages": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isScopedToStatusPages field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "isVisibleOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isVisibleOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "postmortemAttachments": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postmortemAttachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "currentIncidentStateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for currentIncidentStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isCreatedAutomatically": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isCreatedAutomatically field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "serviceLevelObjectives": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for serviceLevelObjectives field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "aiInvestigationDecision": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for aiInvestigationDecision field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "changeMonitorStatusToId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for changeMonitorStatusToId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "aiInvestigationWaitUntil": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for aiInvestigationWaitUntil field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "incidentNumberWithPrefix": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for incidentNumberWithPrefix field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdIncidentTemplateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for createdIncidentTemplateId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "nextReminderNotificationAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for nextReminderNotificationAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "showPostmortemOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showPostmortemOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "postmortemDraftWaitingSince": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for postmortemDraftWaitingSince field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "reminderNotificationSentCount": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for reminderNotificationSentCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "statusPagesNotifiedOnCreation": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for statusPagesNotifiedOnCreation field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "postUpdatesToWorkspaceChannels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "isOwnerNotifiedOfResourceCreation": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotifiedOfResourceCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "subscriberNotificationStatusMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "notifySubscribersOnPostmortemPublished": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for notifySubscribersOnPostmortemPublished field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "subscriberNotificationStatusOnIncidentCreated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatusOnIncidentCreated field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationClaimedAtOnIncidentCreated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for subscriberNotificationClaimedAtOnIncidentCreated field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "subscriberNotificationStatusOnPostmortemPublished": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatusOnPostmortemPublished field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationClaimedAtOnPostmortemPublished": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for subscriberNotificationClaimedAtOnPostmortemPublished field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "shouldStatusPageSubscribersBeNotifiedOnIncidentCreated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldStatusPageSubscribersBeNotifiedOnIncidentCreated field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "subscriberNotificationStatusMessageOnPostmortemPublished": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessageOnPostmortemPublished field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        }
      },
      "description": "Filter criteria for Incidents. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Incident (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, subscriberNotificationStatusMessageOnPostmortemPublished, customFields, createdStateLog, seriesLabels, monitorSummary, telemetryQuery, statusPagesNotifiedOnCreation."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip. Default: 0."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "pvCost": {
          "type": "string",
          "description": "pvCost field"
        },
        "cpuCost": {
          "type": "string",
          "description": "cpuCost field"
        },
        "gpuCost": {
          "type": "string",
          "description": "gpuCost field"
        },
        "podName": {
          "type": "string",
          "description": "podName field"
        },
        "ramCost": {
          "type": "string",
          "description": "ramCost field"
        },
        "currency": {
          "type": "string",
          "description": "currency field"
        },
        "gpuHours": {
          "type": "string",
          "description": "gpuHours field"
        },
        "nodeName": {
          "type": "string",
          "description": "nodeName field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "namespace": {
          "type": "string",
          "description": "namespace field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "totalCost": {
          "type": "string",
          "description": "totalCost field"
        },
        "providerId": {
          "type": "string",
          "description": "providerId field"
        },
        "sharedCost": {
          "type": "string",
          "description": "sharedCost field"
        },
        "shipmentId": {
          "type": "string",
          "description": "shipmentId field"
        },
        "clusterName": {
          "type": "string",
          "description": "clusterName field"
        },
        "networkCost": {
          "type": "string",
          "description": "networkCost field"
        },
        "pvByteHours": {
          "type": "string",
          "description": "pvByteHours field"
        },
        "cpuCoreHours": {
          "type": "string",
          "description": "cpuCoreHours field"
        },
        "externalCost": {
          "type": "string",
          "description": "externalCost field"
        },
        "ramByteHours": {
          "type": "string",
          "description": "ramByteHours field"
        },
        "containerName": {
          "type": "string",
          "description": "containerName field"
        },
        "cpuEfficiency": {
          "type": "string",
          "description": "cpuEfficiency field"
        },
        "ramEfficiency": {
          "type": "string",
          "description": "ramEfficiency field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "shipmentChunk": {
          "type": "string",
          "description": "shipmentChunk field"
        },
        "controllerKind": {
          "type": "string",
          "description": "controllerKind field"
        },
        "controllerName": {
          "type": "string",
          "description": "controllerName field"
        },
        "totalEfficiency": {
          "type": "string",
          "description": "totalEfficiency field"
        },
        "loadBalancerCost": {
          "type": "string",
          "description": "loadBalancerCost field"
        },
        "ramBytesUsageMax": {
          "type": "string",
          "description": "ramBytesUsageMax field"
        },
        "cpuCoreLimitAverage": {
          "type": "string",
          "description": "cpuCoreLimitAverage field"
        },
        "cpuCoreUsageAverage": {
          "type": "string",
          "description": "cpuCoreUsageAverage field"
        },
        "k8sClusterEntityKey": {
          "type": "string",
          "description": "k8sClusterEntityKey field"
        },
        "kubernetesClusterId": {
          "type": "string",
          "description": "kubernetesClusterId field"
        },
        "ramBytesLimitAverage": {
          "type": "string",
          "description": "ramBytesLimitAverage field"
        },
        "ramBytesUsageAverage": {
          "type": "string",
          "description": "ramBytesUsageAverage field"
        },
        "cpuCoreRequestAverage": {
          "type": "string",
          "description": "cpuCoreRequestAverage field"
        },
        "ramBytesRequestAverage": {
          "type": "string",
          "description": "ramBytesRequestAverage field"
        }
      },
      "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "labels": {
          "type": "string",
          "description": "labels field"
        },
        "pvCost": {
          "type": "string",
          "description": "pvCost field"
        },
        "cpuCost": {
          "type": "string",
          "description": "cpuCost field"
        },
        "gpuCost": {
          "type": "string",
          "description": "gpuCost field"
        },
        "podName": {
          "type": "string",
          "description": "podName field"
        },
        "ramCost": {
          "type": "string",
          "description": "ramCost field"
        },
        "currency": {
          "type": "string",
          "description": "currency field"
        },
        "gpuHours": {
          "type": "string",
          "description": "gpuHours field"
        },
        "nodeName": {
          "type": "string",
          "description": "nodeName field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "labelKeys": {
          "type": "string",
          "description": "labelKeys field"
        },
        "namespace": {
          "type": "string",
          "description": "namespace field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "totalCost": {
          "type": "string",
          "description": "totalCost field"
        },
        "windowEnd": {
          "type": "string",
          "description": "windowEnd field"
        },
        "providerId": {
          "type": "string",
          "description": "providerId field"
        },
        "sharedCost": {
          "type": "string",
          "description": "sharedCost field"
        },
        "shipmentId": {
          "type": "string",
          "description": "shipmentId field"
        },
        "clusterName": {
          "type": "string",
          "description": "clusterName field"
        },
        "networkCost": {
          "type": "string",
          "description": "networkCost field"
        },
        "pvByteHours": {
          "type": "string",
          "description": "pvByteHours field"
        },
        "windowStart": {
          "type": "string",
          "description": "windowStart field"
        },
        "cpuCoreHours": {
          "type": "string",
          "description": "cpuCoreHours field"
        },
        "externalCost": {
          "type": "string",
          "description": "externalCost field"
        },
        "ramByteHours": {
          "type": "string",
          "description": "ramByteHours field"
        },
        "containerName": {
          "type": "string",
          "description": "containerName field"
        },
        "cpuEfficiency": {
          "type": "string",
          "description": "cpuEfficiency field"
        },
        "ramEfficiency": {
          "type": "string",
          "description": "ramEfficiency field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "shipmentChunk": {
          "type": "string",
          "description": "shipmentChunk field"
        },
        "controllerKind": {
          "type": "string",
          "description": "controllerKind field"
        },
        "controllerName": {
          "type": "string",
          "description": "controllerName field"
        },
        "totalEfficiency": {
          "type": "string",
          "description": "totalEfficiency field"
        },
        "loadBalancerCost": {
          "type": "string",
          "description": "loadBalancerCost field"
        },
        "ramBytesUsageMax": {
          "type": "string",
          "description": "ramBytesUsageMax field"
        },
        "cpuCoreLimitAverage": {
          "type": "string",
          "description": "cpuCoreLimitAverage field"
        },
        "cpuCoreUsageAverage": {
          "type": "string",
          "description": "cpuCoreUsageAverage field"
        },
        "k8sClusterEntityKey": {
          "type": "string",
          "description": "k8sClusterEntityKey field"
        },
        "kubernetesClusterId": {
          "type": "string",
          "description": "kubernetesClusterId field"
        },
        "ramBytesLimitAverage": {
          "type": "string",
          "description": "ramBytesLimitAverage field"
        },
        "ramBytesUsageAverage": {
          "type": "string",
          "description": "ramBytesUsageAverage field"
        },
        "cpuCoreRequestAverage": {
          "type": "string",
          "description": "cpuCoreRequestAverage field"
        },
        "ramBytesRequestAverage": {
          "type": "string",
          "description": "ramBytesRequestAverage field"
        }
      },
      "description": "Filter criteria for Kubernetes Cost Allocations. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "boolean",
          "example": true,
          "description": "Select _id field in the response"
        },
        "labels": {
          "type": "boolean",
          "example": true,
          "description": "Select labels field in the response"
        },
        "pvCost": {
          "type": "boolean",
          "example": true,
          "description": "Select pvCost field in the response"
        },
        "cpuCost": {
          "type": "boolean",
          "example": true,
          "description": "Select cpuCost field in the response"
        },
        "gpuCost": {
          "type": "boolean",
          "example": true,
          "description": "Select gpuCost field in the response"
        },
        "podName": {
          "type": "boolean",
          "example": true,
          "description": "Select podName field in the response"
        },
        "ramCost": {
          "type": "boolean",
          "example": true,
          "description": "Select ramCost field in the response"
        },
        "currency": {
          "type": "boolean",
          "example": true,
          "description": "Select currency field in the response"
        },
        "gpuHours": {
          "type": "boolean",
          "example": true,
          "description": "Select gpuHours field in the response"
        },
        "nodeName": {
          "type": "boolean",
          "example": true,
          "description": "Select nodeName field in the response"
        },
        "createdAt": {
          "type": "boolean",
          "example": true,
          "description": "Select createdAt field in the response"
        },
        "labelKeys": {
          "type": "boolean",
          "example": true,
          "description": "Select labelKeys field in the response"
        },
        "namespace": {
          "type": "boolean",
          "example": true,
          "description": "Select namespace field in the response"
        },
        "projectId": {
          "type": "boolean",
          "example": true,
          "description": "Select projectId field in the response"
        },
        "totalCost": {
          "type": "boolean",
          "example": true,
          "description": "Select totalCost field in the response"
        },
        "windowEnd": {
          "type": "boolean",
          "example": true,
          "description": "Select windowEnd field in the response"
        },
        "providerId": {
          "type": "boolean",
          "example": true,
          "description": "Select providerId field in the response"
        },
        "sharedCost": {
          "type": "boolean",
          "example": true,
          "description": "Select sharedCost field in the response"
        },
        "shipmentId": {
          "type": "boolean",
          "example": true,
          "description": "Select shipmentId field in the response"
        },
        "clusterName": {
          "type": "boolean",
          "example": true,
          "description": "Select clusterName field in the response"
        },
        "networkCost": {
          "type": "boolean",
          "example": true,
          "description": "Select networkCost field in the response"
        },
        "pvByteHours": {
          "type": "boolean",
          "example": true,
          "description": "Select pvByteHours field in the response"
        },
        "windowStart": {
          "type": "boolean",
          "example": true,
          "description": "Select windowStart field in the response"
        },
        "cpuCoreHours": {
          "type": "boolean",
          "example": true,
          "description": "Select cpuCoreHours field in the response"
        },
        "externalCost": {
          "type": "boolean",
          "example": true,
          "description": "Select externalCost field in the response"
        },
        "ramByteHours": {
          "type": "boolean",
          "example": true,
          "description": "Select ramByteHours field in the response"
        },
        "containerName": {
          "type": "boolean",
          "example": true,
          "description": "Select containerName field in the response"
        },
        "cpuEfficiency": {
          "type": "boolean",
          "example": true,
          "description": "Select cpuEfficiency field in the response"
        },
        "ramEfficiency": {
          "type": "boolean",
          "example": true,
          "description": "Select ramEfficiency field in the response"
        },
        "retentionDate": {
          "type": "boolean",
          "example": true,
          "description": "Select retentionDate field in the response"
        },
        "shipmentChunk": {
          "type": "boolean",
          "example": true,
          "description": "Select shipmentChunk field in the response"
        },
        "controllerKind": {
          "type": "boolean",
          "example": true,
          "description": "Select controllerKind field in the response"
        },
        "controllerName": {
          "type": "boolean",
          "example": true,
          "description": "Select controllerName field in the response"
        },
        "totalEfficiency": {
          "type": "boolean",
          "example": true,
          "description": "Select totalEfficiency field in the response"
        },
        "loadBalancerCost": {
          "type": "boolean",
          "example": true,
          "description": "Select loadBalancerCost field in the response"
        },
        "ramBytesUsageMax": {
          "type": "boolean",
          "example": true,
          "description": "Select ramBytesUsageMax field in the response"
        },
        "cpuCoreLimitAverage": {
          "type": "boolean",
          "example": true,
          "description": "Select cpuCoreLimitAverage field in the response"
        },
        "cpuCoreUsageAverage": {
          "type": "boolean",
          "example": true,
          "description": "Select cpuCoreUsageAverage field in the response"
        },
        "k8sClusterEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select k8sClusterEntityKey field in the response"
        },
        "kubernetesClusterId": {
          "type": "boolean",
          "example": true,
          "description": "Select kubernetesClusterId field in the response"
        },
        "ramBytesLimitAverage": {
          "type": "boolean",
          "example": true,
          "description": "Select ramBytesLimitAverage field in the response"
        },
        "ramBytesUsageAverage": {
          "type": "boolean",
          "example": true,
          "description": "Select ramBytesUsageAverage field in the response"
        },
        "cpuCoreRequestAverage": {
          "type": "boolean",
          "example": true,
          "description": "Select cpuCoreRequestAverage field in the response"
        },
        "ramBytesRequestAverage": {
          "type": "boolean",
          "example": true,
          "description": "Select ramBytesRequestAverage field in the response"
        }
      },
      "description": "Fields to return, as an object of field names to true (e.g. {\"time\": true, \"body\": true}). Select only the fields you need — telemetry rows can be large.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip. Default: 0."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "body": {
          "type": "string",
          "description": "body field"
        },
        "flags": {
          "type": "string",
          "description": "flags field"
        },
        "spanId": {
          "type": "string",
          "description": "spanId field"
        },
        "traceId": {
          "type": "string",
          "description": "traceId field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "sessionId": {
          "type": "string",
          "description": "sessionId field"
        },
        "severityText": {
          "type": "string",
          "description": "severityText field"
        },
        "hostEntityKey": {
          "type": "string",
          "description": "hostEntityKey field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "severityNumber": {
          "type": "string",
          "description": "severityNumber field"
        },
        "k8sPodEntityKey": {
          "type": "string",
          "description": "k8sPodEntityKey field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "k8sNodeEntityKey": {
          "type": "string",
          "description": "k8sNodeEntityKey field"
        },
        "serviceEntityKey": {
          "type": "string",
          "description": "serviceEntityKey field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        },
        "containerEntityKey": {
          "type": "string",
          "description": "containerEntityKey field"
        },
        "k8sClusterEntityKey": {
          "type": "string",
          "description": "k8sClusterEntityKey field"
        },
        "droppedAttributesCount": {
          "type": "string",
          "description": "droppedAttributesCount field"
        }
      },
      "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "body": {
          "type": "string",
          "description": "body field"
        },
        "time": {
          "type": "string",
          "description": "time field"
        },
        "flags": {
          "type": "string",
          "description": "flags field"
        },
        "spanId": {
          "type": "string",
          "description": "spanId field"
        },
        "traceId": {
          "type": "string",
          "description": "traceId field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "sessionId": {
          "type": "string",
          "description": "sessionId field"
        },
        "attributes": {
          "type": "string",
          "description": "attributes field"
        },
        "entityKeys": {
          "type": "string",
          "description": "entityKeys field"
        },
        "severityText": {
          "type": "string",
          "description": "severityText field"
        },
        "timeUnixNano": {
          "type": "string",
          "description": "timeUnixNano field"
        },
        "attributeKeys": {
          "type": "string",
          "description": "attributeKeys field"
        },
        "hostEntityKey": {
          "type": "string",
          "description": "hostEntityKey field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "severityNumber": {
          "type": "string",
          "description": "severityNumber field"
        },
        "k8sPodEntityKey": {
          "type": "string",
          "description": "k8sPodEntityKey field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "k8sNodeEntityKey": {
          "type": "string",
          "description": "k8sNodeEntityKey field"
        },
        "serviceEntityKey": {
          "type": "string",
          "description": "serviceEntityKey field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        },
        "containerEntityKey": {
          "type": "string",
          "description": "containerEntityKey field"
        },
        "k8sClusterEntityKey": {
          "type": "string",
          "description": "k8sClusterEntityKey field"
        },
        "observedTimeUnixNano": {
          "type": "string",
          "description": "observedTimeUnixNano field"
        },
        "droppedAttributesCount": {
          "type": "string",
          "description": "droppedAttributesCount field"
        }
      },
      "description": "Filter criteria for Logs. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "boolean",
          "example": true,
          "description": "Select _id field in the response"
        },
        "body": {
          "type": "boolean",
          "example": true,
          "description": "Select body field in the response"
        },
        "time": {
          "type": "boolean",
          "example": true,
          "description": "Select time field in the response"
        },
        "flags": {
          "type": "boolean",
          "example": true,
          "description": "Select flags field in the response"
        },
        "spanId": {
          "type": "boolean",
          "example": true,
          "description": "Select spanId field in the response"
        },
        "traceId": {
          "type": "boolean",
          "example": true,
          "description": "Select traceId field in the response"
        },
        "createdAt": {
          "type": "boolean",
          "example": true,
          "description": "Select createdAt field in the response"
        },
        "projectId": {
          "type": "boolean",
          "example": true,
          "description": "Select projectId field in the response"
        },
        "sessionId": {
          "type": "boolean",
          "example": true,
          "description": "Select sessionId field in the response"
        },
        "attributes": {
          "type": "boolean",
          "example": true,
          "description": "Select attributes field in the response"
        },
        "entityKeys": {
          "type": "boolean",
          "example": true,
          "description": "Select entityKeys field in the response"
        },
        "severityText": {
          "type": "boolean",
          "example": true,
          "description": "Select severityText field in the response"
        },
        "timeUnixNano": {
          "type": "boolean",
          "example": true,
          "description": "Select timeUnixNano field in the response"
        },
        "attributeKeys": {
          "type": "boolean",
          "example": true,
          "description": "Select attributeKeys field in the response"
        },
        "hostEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select hostEntityKey field in the response"
        },
        "retentionDate": {
          "type": "boolean",
          "example": true,
          "description": "Select retentionDate field in the response"
        },
        "severityNumber": {
          "type": "boolean",
          "example": true,
          "description": "Select severityNumber field in the response"
        },
        "k8sPodEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select k8sPodEntityKey field in the response"
        },
        "primaryEntityId": {
          "type": "boolean",
          "example": true,
          "description": "Select primaryEntityId field in the response"
        },
        "k8sNodeEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select k8sNodeEntityKey field in the response"
        },
        "serviceEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select serviceEntityKey field in the response"
        },
        "primaryEntityType": {
          "type": "boolean",
          "example": true,
          "description": "Select primaryEntityType field in the response"
        },
        "containerEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select containerEntityKey field in the response"
        },
        "k8sClusterEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select k8sClusterEntityKey field in the response"
        },
        "observedTimeUnixNano": {
          "type": "boolean",
          "example": true,
          "description": "Select observedTimeUnixNano field in the response"
        },
        "droppedAttributesCount": {
          "type": "boolean",
          "example": true,
          "description": "Select droppedAttributesCount field in the response"
        }
      },
      "description": "Fields to return, as an object of field names to true (e.g. {\"time\": true, \"body\": true}). Select only the fields you need — telemetry rows can be large.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip. Default: 0."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "max": {
          "type": "string",
          "description": "max field"
        },
        "min": {
          "type": "string",
          "description": "min field"
        },
        "sum": {
          "type": "string",
          "description": "sum field"
        },
        "name": {
          "type": "string",
          "description": "name field"
        },
        "scale": {
          "type": "string",
          "description": "scale field"
        },
        "value": {
          "type": "string",
          "description": "value field"
        },
        "spanId": {
          "type": "string",
          "description": "spanId field"
        },
        "traceId": {
          "type": "string",
          "description": "traceId field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "isMonotonic": {
          "type": "string",
          "description": "isMonotonic field"
        },
        "hostEntityKey": {
          "type": "string",
          "description": "hostEntityKey field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "negativeOffset": {
          "type": "string",
          "description": "negativeOffset field"
        },
        "positiveOffset": {
          "type": "string",
          "description": "positiveOffset field"
        },
        "k8sPodEntityKey": {
          "type": "string",
          "description": "k8sPodEntityKey field"
        },
        "metricPointType": {
          "type": "string",
          "description": "metricPointType field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "k8sNodeEntityKey": {
          "type": "string",
          "description": "k8sNodeEntityKey field"
        },
        "serviceEntityKey": {
          "type": "string",
          "description": "serviceEntityKey field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        },
        "containerEntityKey": {
          "type": "string",
          "description": "containerEntityKey field"
        },
        "k8sClusterEntityKey": {
          "type": "string",
          "description": "k8sClusterEntityKey field"
        },
        "aggregationTemporality": {
          "type": "string",
          "description": "aggregationTemporality field"
        }
      },
      "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "max": {
          "type": "string",
          "description": "max field"
        },
        "min": {
          "type": "string",
          "description": "min field"
        },
        "sum": {
          "type": "string",
          "description": "sum field"
        },
        "name": {
          "type": "string",
          "description": "name field"
        },
        "time": {
          "type": "string",
          "description": "time field"
        },
        "count": {
          "type": "string",
          "description": "count field"
        },
        "scale": {
          "type": "string",
          "description": "scale field"
        },
        "value": {
          "type": "string",
          "description": "value field"
        },
        "spanId": {
          "type": "string",
          "description": "spanId field"
        },
        "traceId": {
          "type": "string",
          "description": "traceId field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "startTime": {
          "type": "string",
          "description": "startTime field"
        },
        "zeroCount": {
          "type": "string",
          "description": "zeroCount field"
        },
        "attributes": {
          "type": "string",
          "description": "attributes field"
        },
        "entityKeys": {
          "type": "string",
          "description": "entityKeys field"
        },
        "isMonotonic": {
          "type": "string",
          "description": "isMonotonic field"
        },
        "bucketCounts": {
          "type": "string",
          "description": "bucketCounts field"
        },
        "timeUnixNano": {
          "type": "string",
          "description": "timeUnixNano field"
        },
        "attributeKeys": {
          "type": "string",
          "description": "attributeKeys field"
        },
        "hostEntityKey": {
          "type": "string",
          "description": "hostEntityKey field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "summaryValues": {
          "type": "string",
          "description": "summaryValues field"
        },
        "explicitBounds": {
          "type": "string",
          "description": "explicitBounds field"
        },
        "negativeOffset": {
          "type": "string",
          "description": "negativeOffset field"
        },
        "positiveOffset": {
          "type": "string",
          "description": "positiveOffset field"
        },
        "k8sPodEntityKey": {
          "type": "string",
          "description": "k8sPodEntityKey field"
        },
        "metricPointType": {
          "type": "string",
          "description": "metricPointType field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "k8sNodeEntityKey": {
          "type": "string",
          "description": "k8sNodeEntityKey field"
        },
        "serviceEntityKey": {
          "type": "string",
          "description": "serviceEntityKey field"
        },
        "summaryQuantiles": {
          "type": "string",
          "description": "summaryQuantiles field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        },
        "startTimeUnixNano": {
          "type": "string",
          "description": "startTimeUnixNano field"
        },
        "containerEntityKey": {
          "type": "string",
          "description": "containerEntityKey field"
        },
        "k8sClusterEntityKey": {
          "type": "string",
          "description": "k8sClusterEntityKey field"
        },
        "negativeBucketCounts": {
          "type": "string",
          "description": "negativeBucketCounts field"
        },
        "positiveBucketCounts": {
          "type": "string",
          "description": "positiveBucketCounts field"
        },
        "aggregationTemporality": {
          "type": "string",
          "description": "aggregationTemporality field"
        }
      },
      "description": "Filter criteria for Metrics. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "boolean",
          "example": true,
          "description": "Select _id field in the response"
        },
        "max": {
          "type": "boolean",
          "example": true,
          "description": "Select max field in the response"
        },
        "min": {
          "type": "boolean",
          "example": true,
          "description": "Select min field in the response"
        },
        "sum": {
          "type": "boolean",
          "example": true,
          "description": "Select sum field in the response"
        },
        "name": {
          "type": "boolean",
          "example": true,
          "description": "Select name field in the response"
        },
        "time": {
          "type": "boolean",
          "example": true,
          "description": "Select time field in the response"
        },
        "count": {
          "type": "boolean",
          "example": true,
          "description": "Select count field in the response"
        },
        "scale": {
          "type": "boolean",
          "example": true,
          "description": "Select scale field in the response"
        },
        "value": {
          "type": "boolean",
          "example": true,
          "description": "Select value field in the response"
        },
        "spanId": {
          "type": "boolean",
          "example": true,
          "description": "Select spanId field in the response"
        },
        "traceId": {
          "type": "boolean",
          "example": true,
          "description": "Select traceId field in the response"
        },
        "createdAt": {
          "type": "boolean",
          "example": true,
          "description": "Select createdAt field in the response"
        },
        "projectId": {
          "type": "boolean",
          "example": true,
          "description": "Select projectId field in the response"
        },
        "startTime": {
          "type": "boolean",
          "example": true,
          "description": "Select startTime field in the response"
        },
        "zeroCount": {
          "type": "boolean",
          "example": true,
          "description": "Select zeroCount field in the response"
        },
        "attributes": {
          "type": "boolean",
          "example": true,
          "description": "Select attributes field in the response"
        },
        "entityKeys": {
          "type": "boolean",
          "example": true,
          "description": "Select entityKeys field in the response"
        },
        "isMonotonic": {
          "type": "boolean",
          "example": true,
          "description": "Select isMonotonic field in the response"
        },
        "bucketCounts": {
          "type": "boolean",
          "example": true,
          "description": "Select bucketCounts field in the response"
        },
        "timeUnixNano": {
          "type": "boolean",
          "example": true,
          "description": "Select timeUnixNano field in the response"
        },
        "attributeKeys": {
          "type": "boolean",
          "example": true,
          "description": "Select attributeKeys field in the response"
        },
        "hostEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select hostEntityKey field in the response"
        },
        "retentionDate": {
          "type": "boolean",
          "example": true,
          "description": "Select retentionDate field in the response"
        },
        "summaryValues": {
          "type": "boolean",
          "example": true,
          "description": "Select summaryValues field in the response"
        },
        "explicitBounds": {
          "type": "boolean",
          "example": true,
          "description": "Select explicitBounds field in the response"
        },
        "negativeOffset": {
          "type": "boolean",
          "example": true,
          "description": "Select negativeOffset field in the response"
        },
        "positiveOffset": {
          "type": "boolean",
          "example": true,
          "description": "Select positiveOffset field in the response"
        },
        "k8sPodEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select k8sPodEntityKey field in the response"
        },
        "metricPointType": {
          "type": "boolean",
          "example": true,
          "description": "Select metricPointType field in the response"
        },
        "primaryEntityId": {
          "type": "boolean",
          "example": true,
          "description": "Select primaryEntityId field in the response"
        },
        "k8sNodeEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select k8sNodeEntityKey field in the response"
        },
        "serviceEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select serviceEntityKey field in the response"
        },
        "summaryQuantiles": {
          "type": "boolean",
          "example": true,
          "description": "Select summaryQuantiles field in the response"
        },
        "primaryEntityType": {
          "type": "boolean",
          "example": true,
          "description": "Select primaryEntityType field in the response"
        },
        "startTimeUnixNano": {
          "type": "boolean",
          "example": true,
          "description": "Select startTimeUnixNano field in the response"
        },
        "containerEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select containerEntityKey field in the response"
        },
        "k8sClusterEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select k8sClusterEntityKey field in the response"
        },
        "negativeBucketCounts": {
          "type": "boolean",
          "example": true,
          "description": "Select negativeBucketCounts field in the response"
        },
        "positiveBucketCounts": {
          "type": "boolean",
          "example": true,
          "description": "Select positiveBucketCounts field in the response"
        },
        "aggregationTemporality": {
          "type": "boolean",
          "example": true,
          "description": "Select aggregationTemporality field in the response"
        }
      },
      "description": "Fields to return, as an object of field names to true (e.g. {\"time\": true, \"body\": true}). Select only the fields you need — telemetry rows can be large.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip. Default: 0."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "monitorId": {
          "type": "string",
          "description": "monitorId field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        }
      },
      "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "time": {
          "type": "string",
          "description": "time field"
        },
        "logBody": {
          "type": "string",
          "description": "logBody field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "monitorId": {
          "type": "string",
          "description": "monitorId field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        }
      },
      "description": "Filter criteria for Monitor Logs. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "boolean",
          "example": true,
          "description": "Select _id field in the response"
        },
        "time": {
          "type": "boolean",
          "example": true,
          "description": "Select time field in the response"
        },
        "logBody": {
          "type": "boolean",
          "example": true,
          "description": "Select logBody field in the response"
        },
        "createdAt": {
          "type": "boolean",
          "example": true,
          "description": "Select createdAt field in the response"
        },
        "monitorId": {
          "type": "boolean",
          "example": true,
          "description": "Select monitorId field in the response"
        },
        "projectId": {
          "type": "boolean",
          "example": true,
          "description": "Select projectId field in the response"
        },
        "retentionDate": {
          "type": "boolean",
          "example": true,
          "description": "Select retentionDate field in the response"
        }
      },
      "description": "Fields to return, as an object of field names to true (e.g. {\"time\": true, \"body\": true}). Select only the fields you need — telemetry rows can be large.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "endsAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for endsAt field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "startsAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for startsAt field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "monitorId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for monitorId field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "isOwnerNotified": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isOwnerNotified field"
        },
        "monitorStatusId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for monitorStatusId field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "endsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "startsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "monitorId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for monitorId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "rootCause": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOwnerNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "monitorStatusId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for monitorStatusId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "statusChangeLog": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for statusChangeLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        }
      },
      "description": "Filter criteria for Monitor Status Events. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Monitor Status Event (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): statusChangeLog."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "name": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for name field"
        },
        "slug": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for slug field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "archivedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedAt field"
        },
        "isArchived": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isArchived field"
        },
        "description": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for description field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "archivedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedByUserId field"
        },
        "monitorTemplateId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for monitorTemplateId field"
        },
        "monitoringInterval": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for monitoringInterval field"
        },
        "networkAlertPolicyId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for networkAlertPolicyId field"
        },
        "minimumProbeAgreement": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for minimumProbeAgreement field"
        },
        "currentMonitorStatusId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for currentMonitorStatusId field"
        },
        "incomingEmailSecretKey": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for incomingEmailSecretKey field"
        },
        "serverMonitorSecretKey": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for serverMonitorSecretKey field"
        },
        "disableActiveMonitoring": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for disableActiveMonitoring field"
        },
        "incomingRequestSecretKey": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for incomingRequestSecretKey field"
        },
        "incomingEmailCustomLocalPart": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for incomingEmailCustomLocalPart field"
        },
        "isNoProbeEnabledOnThisMonitor": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isNoProbeEnabledOnThisMonitor field"
        },
        "telemetryMonitorLastMonitorAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for telemetryMonitorLastMonitorAt field"
        },
        "telemetryMonitorNextMonitorAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for telemetryMonitorNextMonitorAt field"
        },
        "autoProvisionedNetworkDeviceId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for autoProvisionedNetworkDeviceId field"
        },
        "serverMonitorRequestReceivedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for serverMonitorRequestReceivedAt field"
        },
        "isOwnerNotifiedOfResourceCreation": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isOwnerNotifiedOfResourceCreation field"
        },
        "incomingEmailMonitorHeartbeatCheckedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for incomingEmailMonitorHeartbeatCheckedAt field"
        },
        "isAllProbesDisconnectedFromThisMonitor": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isAllProbesDisconnectedFromThisMonitor field"
        },
        "incomingEmailMonitorLastEmailReceivedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for incomingEmailMonitorLastEmailReceivedAt field"
        },
        "incomingRequestMonitorHeartbeatCheckedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for incomingRequestMonitorHeartbeatCheckedAt field"
        },
        "disableActiveMonitoringBecauseOfManualIncident": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for disableActiveMonitoringBecauseOfManualIncident field"
        },
        "disableActiveMonitoringBecauseOfScheduledMaintenanceEvent": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for disableActiveMonitoringBecauseOfScheduledMaintenanceEvent field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "hosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for hosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "labels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "services": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for services field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "iotFleets": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for iotFleets field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "dockerHosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "monitorType": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for monitorType field of type Monitor Type. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "podmanHosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for podmanHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "cephClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for cephClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "customFields": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "monitorSteps": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for monitorSteps field of type Monitor Steps. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "storageArrays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for storageArrays field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "vmwareVCenters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for vmwareVCenters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "databaseServers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for databaseServers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "proxmoxClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for proxmoxClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "dependsOnMonitors": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dependsOnMonitors field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "monitorTemplateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for monitorTemplateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "kubernetesClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for kubernetesClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "monitoringInterval": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for monitoringInterval field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "dockerSwarmClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerSwarmClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "networkAlertPolicyId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for networkAlertPolicyId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "minimumProbeAgreement": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for minimumProbeAgreement field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "serverMonitorResponse": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for serverMonitorResponse field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "currentMonitorStatusId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for currentMonitorStatusId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "incomingEmailSecretKey": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incomingEmailSecretKey field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "incomingMonitorRequest": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for incomingMonitorRequest field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "serverMonitorSecretKey": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for serverMonitorSecretKey field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "disableActiveMonitoring": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for disableActiveMonitoring field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "incomingRequestSecretKey": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for incomingRequestSecretKey field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "incomingEmailMonitorRequest": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for incomingEmailMonitorRequest field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "incomingEmailCustomLocalPart": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for incomingEmailCustomLocalPart field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "isNoProbeEnabledOnThisMonitor": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isNoProbeEnabledOnThisMonitor field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "telemetryMonitorLastMonitorAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for telemetryMonitorLastMonitorAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "telemetryMonitorNextMonitorAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for telemetryMonitorNextMonitorAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "autoProvisionedNetworkDeviceId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for autoProvisionedNetworkDeviceId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "postUpdatesToWorkspaceChannels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "serverMonitorRequestReceivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for serverMonitorRequestReceivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isOwnerNotifiedOfResourceCreation": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotifiedOfResourceCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "incomingEmailMonitorHeartbeatCheckedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for incomingEmailMonitorHeartbeatCheckedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "isAllProbesDisconnectedFromThisMonitor": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isAllProbesDisconnectedFromThisMonitor field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "incomingEmailMonitorLastEmailReceivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for incomingEmailMonitorLastEmailReceivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "suppressAlertsWhenParentMonitorStatuses": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for suppressAlertsWhenParentMonitorStatuses field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "incomingRequestMonitorHeartbeatCheckedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for incomingRequestMonitorHeartbeatCheckedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "disableActiveMonitoringBecauseOfManualIncident": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for disableActiveMonitoringBecauseOfManualIncident field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "disableActiveMonitoringBecauseOfScheduledMaintenanceEvent": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for disableActiveMonitoringBecauseOfScheduledMaintenanceEvent field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Filter criteria for Monitors. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Monitor (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): description, customFields, incomingMonitorRequest, incomingEmailMonitorRequest, serverMonitorResponse."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "slug": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for slug field"
        },
        "title": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for title field"
        },
        "endsAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for endsAt field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "startsAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for startsAt field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "enableReminders": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for enableReminders field"
        },
        "isVisibleOnStatusPage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isVisibleOnStatusPage field"
        },
        "changeMonitorStatusToId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for changeMonitorStatusToId field"
        },
        "nextReminderNotificationAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for nextReminderNotificationAt field"
        },
        "scheduledMaintenanceNumber": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for scheduledMaintenanceNumber field"
        },
        "reminderNotificationSentCount": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for reminderNotificationSentCount field"
        },
        "isOwnerNotifiedOfResourceCreation": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isOwnerNotifiedOfResourceCreation field"
        },
        "currentScheduledMaintenanceStateId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for currentScheduledMaintenanceStateId field"
        },
        "subscriberNotificationStatusMessage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatusMessage field"
        },
        "scheduledMaintenanceNumberWithPrefix": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for scheduledMaintenanceNumberWithPrefix field"
        },
        "nextSubscriberNotificationBeforeTheEventAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for nextSubscriberNotificationBeforeTheEventAt field"
        },
        "subscriberNotificationStatusOnEventScheduled": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatusOnEventScheduled field"
        },
        "shouldStatusPageSubscribersBeNotifiedOnEventCreated": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for shouldStatusPageSubscribersBeNotifiedOnEventCreated field"
        },
        "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded field"
        },
        "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "hosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for hosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "title": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for title field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "endsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "labels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "monitors": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for monitors field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "services": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for services field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "startsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "iotFleets": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for iotFleets field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "dockerHosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "podmanHosts": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for podmanHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "statusPages": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for statusPages field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "cephClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for cephClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "customFields": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "networkSites": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for networkSites field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "storageArrays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for storageArrays field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "vmwareVCenters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for vmwareVCenters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "databaseServers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for databaseServers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "enableReminders": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableReminders field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "proxmoxClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for proxmoxClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "kubernetesClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for kubernetesClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "dockerSwarmClusters": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for dockerSwarmClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "isVisibleOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isVisibleOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "changeMonitorStatusToId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for changeMonitorStatusToId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "nextReminderNotificationAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for nextReminderNotificationAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "scheduledMaintenanceNumber": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for scheduledMaintenanceNumber field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "reminderNotificationSentCount": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for reminderNotificationSentCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "postUpdatesToWorkspaceChannels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "isOwnerNotifiedOfResourceCreation": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotifiedOfResourceCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "currentScheduledMaintenanceStateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for currentScheduledMaintenanceStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "subscriberNotificationStatusMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "scheduledMaintenanceNumberWithPrefix": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for scheduledMaintenanceNumberWithPrefix field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "nextSubscriberNotificationBeforeTheEventAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for nextSubscriberNotificationBeforeTheEventAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "sendSubscriberNotificationsOnBeforeTheEvent": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for sendSubscriberNotificationsOnBeforeTheEvent field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "subscriberNotificationStatusOnEventScheduled": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatusOnEventScheduled field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "shouldStatusPageSubscribersBeNotifiedOnEventCreated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldStatusPageSubscribersBeNotifiedOnEventCreated field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Filter criteria for Scheduled Maintenance Events. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Scheduled Maintenance Event (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, customFields, sendSubscriberNotificationsOnBeforeTheEvent."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "endsAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for endsAt field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "startsAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for startsAt field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "isOwnerNotified": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isOwnerNotified field"
        },
        "scheduledMaintenanceId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for scheduledMaintenanceId field"
        },
        "scheduledMaintenanceStateId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for scheduledMaintenanceStateId field"
        },
        "subscriberNotificationStatus": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatus field"
        },
        "subscriberNotificationStatusMessage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatusMessage field"
        },
        "shouldStatusPageSubscribersBeNotified": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for shouldStatusPageSubscribersBeNotified field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "endsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "startsAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOwnerNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "scheduledMaintenanceId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for scheduledMaintenanceId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "scheduledMaintenanceStateId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for scheduledMaintenanceStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "subscriberNotificationStatus": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatus field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationStatusMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "shouldStatusPageSubscribersBeNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldStatusPageSubscribersBeNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Filter criteria for Scheduled Maintenance State Timelines. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Scheduled Maintenance State Timeline (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "title": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for title field"
        },
        "source": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for source field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "eventUid": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for eventUid field"
        },
        "ruleName": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for ruleName field"
        },
        "severity": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for severity field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "fireCount": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for fireCount field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "eventCount": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for eventCount field"
        },
        "groupValue": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for groupValue field"
        },
        "lastSeenAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for lastSeenAt field"
        },
        "fingerprint": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for fingerprint field"
        },
        "firstSeenAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for firstSeenAt field"
        },
        "sampleMessage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for sampleMessage field"
        },
        "securityCaseId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for securityCaseId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "detectionRuleId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for detectionRuleId field"
        },
        "threatIntelFeedId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for threatIntelFeedId field"
        },
        "securityEventConnectionId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for securityEventConnectionId field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "title": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for title field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "source": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for source field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "entities": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for entities field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "eventUid": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for eventUid field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "ruleName": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for ruleName field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "severity": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for severity field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "fireCount": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for fireCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "eventCount": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for eventCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "groupValue": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for groupValue field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "lastSeenAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for lastSeenAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "fingerprint": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for fingerprint field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "firstSeenAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for firstSeenAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "mitreTactics": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for mitreTactics field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "sampleMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for sampleMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "securityCaseId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for securityCaseId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "detectionRuleId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for detectionRuleId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "mitreTechniques": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for mitreTechniques field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "threatIntelFeedId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for threatIntelFeedId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "securityEventConnectionId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for securityEventConnectionId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        }
      },
      "description": "Filter criteria for Security Detections. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Security Detection (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): entities, mitreTactics, mitreTechniques, sampleMessage."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip. Default: 0."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "ruleId": {
          "type": "string",
          "description": "ruleId field"
        },
        "message": {
          "type": "string",
          "description": "message field"
        },
        "classUid": {
          "type": "string",
          "description": "classUid field"
        },
        "eventUid": {
          "type": "string",
          "description": "eventUid field"
        },
        "ruleName": {
          "type": "string",
          "description": "ruleName field"
        },
        "targetIp": {
          "type": "string",
          "description": "targetIp field"
        },
        "className": {
          "type": "string",
          "description": "className field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "severityId": {
          "type": "string",
          "description": "severityId field"
        },
        "statusName": {
          "type": "string",
          "description": "statusName field"
        },
        "targetHost": {
          "type": "string",
          "description": "targetHost field"
        },
        "targetPort": {
          "type": "string",
          "description": "targetPort field"
        },
        "targetUser": {
          "type": "string",
          "description": "targetUser field"
        },
        "vendorName": {
          "type": "string",
          "description": "vendorName field"
        },
        "categoryUid": {
          "type": "string",
          "description": "categoryUid field"
        },
        "principalIp": {
          "type": "string",
          "description": "principalIp field"
        },
        "processName": {
          "type": "string",
          "description": "processName field"
        },
        "processPath": {
          "type": "string",
          "description": "processPath field"
        },
        "productName": {
          "type": "string",
          "description": "productName field"
        },
        "activityName": {
          "type": "string",
          "description": "activityName field"
        },
        "categoryName": {
          "type": "string",
          "description": "categoryName field"
        },
        "severityName": {
          "type": "string",
          "description": "severityName field"
        },
        "principalHost": {
          "type": "string",
          "description": "principalHost field"
        },
        "principalUser": {
          "type": "string",
          "description": "principalUser field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "targetResource": {
          "type": "string",
          "description": "targetResource field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "principalProcess": {
          "type": "string",
          "description": "principalProcess field"
        },
        "parentProcessName": {
          "type": "string",
          "description": "parentProcessName field"
        },
        "parentProcessPath": {
          "type": "string",
          "description": "parentProcessPath field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        },
        "processCommandLine": {
          "type": "string",
          "description": "processCommandLine field"
        },
        "parentProcessCommandLine": {
          "type": "string",
          "description": "parentProcessCommandLine field"
        }
      },
      "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "time": {
          "type": "string",
          "description": "time field"
        },
        "ruleId": {
          "type": "string",
          "description": "ruleId field"
        },
        "message": {
          "type": "string",
          "description": "message field"
        },
        "classUid": {
          "type": "string",
          "description": "classUid field"
        },
        "eventUid": {
          "type": "string",
          "description": "eventUid field"
        },
        "ruleName": {
          "type": "string",
          "description": "ruleName field"
        },
        "targetIp": {
          "type": "string",
          "description": "targetIp field"
        },
        "className": {
          "type": "string",
          "description": "className field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "attributes": {
          "type": "string",
          "description": "attributes field"
        },
        "severityId": {
          "type": "string",
          "description": "severityId field"
        },
        "statusName": {
          "type": "string",
          "description": "statusName field"
        },
        "targetHost": {
          "type": "string",
          "description": "targetHost field"
        },
        "targetPort": {
          "type": "string",
          "description": "targetPort field"
        },
        "targetUser": {
          "type": "string",
          "description": "targetUser field"
        },
        "vendorName": {
          "type": "string",
          "description": "vendorName field"
        },
        "categoryUid": {
          "type": "string",
          "description": "categoryUid field"
        },
        "observables": {
          "type": "string",
          "description": "observables field"
        },
        "principalIp": {
          "type": "string",
          "description": "principalIp field"
        },
        "processName": {
          "type": "string",
          "description": "processName field"
        },
        "processPath": {
          "type": "string",
          "description": "processPath field"
        },
        "productName": {
          "type": "string",
          "description": "productName field"
        },
        "activityName": {
          "type": "string",
          "description": "activityName field"
        },
        "categoryName": {
          "type": "string",
          "description": "categoryName field"
        },
        "mitreTactics": {
          "type": "string",
          "description": "mitreTactics field"
        },
        "severityName": {
          "type": "string",
          "description": "severityName field"
        },
        "attributeKeys": {
          "type": "string",
          "description": "attributeKeys field"
        },
        "principalHost": {
          "type": "string",
          "description": "principalHost field"
        },
        "principalUser": {
          "type": "string",
          "description": "principalUser field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "targetResource": {
          "type": "string",
          "description": "targetResource field"
        },
        "mitreTechniques": {
          "type": "string",
          "description": "mitreTechniques field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "principalProcess": {
          "type": "string",
          "description": "principalProcess field"
        },
        "parentProcessName": {
          "type": "string",
          "description": "parentProcessName field"
        },
        "parentProcessPath": {
          "type": "string",
          "description": "parentProcessPath field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        },
        "processCommandLine": {
          "type": "string",
          "description": "processCommandLine field"
        },
        "parentProcessCommandLine": {
          "type": "string",
          "description": "parentProcessCommandLine field"
        }
      },
      "description": "Filter criteria for Security Events. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "boolean",
          "example": true,
          "description": "Select _id field in the response"
        },
        "time": {
          "type": "boolean",
          "example": true,
          "description": "Select time field in the response"
        },
        "ruleId": {
          "type": "boolean",
          "example": true,
          "description": "Select ruleId field in the response"
        },
        "message": {
          "type": "boolean",
          "example": true,
          "description": "Select message field in the response"
        },
        "classUid": {
          "type": "boolean",
          "example": true,
          "description": "Select classUid field in the response"
        },
        "eventUid": {
          "type": "boolean",
          "example": true,
          "description": "Select eventUid field in the response"
        },
        "ruleName": {
          "type": "boolean",
          "example": true,
          "description": "Select ruleName field in the response"
        },
        "targetIp": {
          "type": "boolean",
          "example": true,
          "description": "Select targetIp field in the response"
        },
        "className": {
          "type": "boolean",
          "example": true,
          "description": "Select className field in the response"
        },
        "createdAt": {
          "type": "boolean",
          "example": true,
          "description": "Select createdAt field in the response"
        },
        "projectId": {
          "type": "boolean",
          "example": true,
          "description": "Select projectId field in the response"
        },
        "attributes": {
          "type": "boolean",
          "example": true,
          "description": "Select attributes field in the response"
        },
        "severityId": {
          "type": "boolean",
          "example": true,
          "description": "Select severityId field in the response"
        },
        "statusName": {
          "type": "boolean",
          "example": true,
          "description": "Select statusName field in the response"
        },
        "targetHost": {
          "type": "boolean",
          "example": true,
          "description": "Select targetHost field in the response"
        },
        "targetPort": {
          "type": "boolean",
          "example": true,
          "description": "Select targetPort field in the response"
        },
        "targetUser": {
          "type": "boolean",
          "example": true,
          "description": "Select targetUser field in the response"
        },
        "vendorName": {
          "type": "boolean",
          "example": true,
          "description": "Select vendorName field in the response"
        },
        "categoryUid": {
          "type": "boolean",
          "example": true,
          "description": "Select categoryUid field in the response"
        },
        "observables": {
          "type": "boolean",
          "example": true,
          "description": "Select observables field in the response"
        },
        "principalIp": {
          "type": "boolean",
          "example": true,
          "description": "Select principalIp field in the response"
        },
        "processName": {
          "type": "boolean",
          "example": true,
          "description": "Select processName field in the response"
        },
        "processPath": {
          "type": "boolean",
          "example": true,
          "description": "Select processPath field in the response"
        },
        "productName": {
          "type": "boolean",
          "example": true,
          "description": "Select productName field in the response"
        },
        "activityName": {
          "type": "boolean",
          "example": true,
          "description": "Select activityName field in the response"
        },
        "categoryName": {
          "type": "boolean",
          "example": true,
          "description": "Select categoryName field in the response"
        },
        "mitreTactics": {
          "type": "boolean",
          "example": true,
          "description": "Select mitreTactics field in the response"
        },
        "severityName": {
          "type": "boolean",
          "example": true,
          "description": "Select severityName field in the response"
        },
        "attributeKeys": {
          "type": "boolean",
          "example": true,
          "description": "Select attributeKeys field in the response"
        },
        "principalHost": {
          "type": "boolean",
          "example": true,
          "description": "Select principalHost field in the response"
        },
        "principalUser": {
          "type": "boolean",
          "example": true,
          "description": "Select principalUser field in the response"
        },
        "retentionDate": {
          "type": "boolean",
          "example": true,
          "description": "Select retentionDate field in the response"
        },
        "targetResource": {
          "type": "boolean",
          "example": true,
          "description": "Select targetResource field in the response"
        },
        "mitreTechniques": {
          "type": "boolean",
          "example": true,
          "description": "Select mitreTechniques field in the response"
        },
        "primaryEntityId": {
          "type": "boolean",
          "example": true,
          "description": "Select primaryEntityId field in the response"
        },
        "principalProcess": {
          "type": "boolean",
          "example": true,
          "description": "Select principalProcess field in the response"
        },
        "parentProcessName": {
          "type": "boolean",
          "example": true,
          "description": "Select parentProcessName field in the response"
        },
        "parentProcessPath": {
          "type": "boolean",
          "example": true,
          "description": "Select parentProcessPath field in the response"
        },
        "primaryEntityType": {
          "type": "boolean",
          "example": true,
          "description": "Select primaryEntityType field in the response"
        },
        "processCommandLine": {
          "type": "boolean",
          "example": true,
          "description": "Select processCommandLine field in the response"
        },
        "parentProcessCommandLine": {
          "type": "boolean",
          "example": true,
          "description": "Select parentProcessCommandLine field in the response"
        }
      },
      "description": "Fields to return, as an object of field names to true (e.g. {\"time\": true, \"body\": true}). Select only the fields you need — telemetry rows can be large.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip. Default: 0."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "kind": {
          "type": "string",
          "description": "kind field"
        },
        "name": {
          "type": "string",
          "description": "name field"
        },
        "spanId": {
          "type": "string",
          "description": "spanId field"
        },
        "llmCost": {
          "type": "string",
          "description": "llmCost field"
        },
        "llmTeam": {
          "type": "string",
          "description": "llmTeam field"
        },
        "traceId": {
          "type": "string",
          "description": "traceId field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "isLlmSpan": {
          "type": "string",
          "description": "isLlmSpan field"
        },
        "llmSystem": {
          "type": "string",
          "description": "llmSystem field"
        },
        "llmUserId": {
          "type": "string",
          "description": "llmUserId field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "sessionId": {
          "type": "string",
          "description": "sessionId field"
        },
        "isRootSpan": {
          "type": "string",
          "description": "isRootSpan field"
        },
        "statusCode": {
          "type": "string",
          "description": "statusCode field"
        },
        "traceState": {
          "type": "string",
          "description": "traceState field"
        },
        "llmCallKind": {
          "type": "string",
          "description": "llmCallKind field"
        },
        "llmToolName": {
          "type": "string",
          "description": "llmToolName field"
        },
        "hasException": {
          "type": "string",
          "description": "hasException field"
        },
        "llmAgentName": {
          "type": "string",
          "description": "llmAgentName field"
        },
        "llmOperation": {
          "type": "string",
          "description": "llmOperation field"
        },
        "llmUserEmail": {
          "type": "string",
          "description": "llmUserEmail field"
        },
        "parentSpanId": {
          "type": "string",
          "description": "parentSpanId field"
        },
        "hostEntityKey": {
          "type": "string",
          "description": "hostEntityKey field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "statusMessage": {
          "type": "string",
          "description": "statusMessage field"
        },
        "llmInputTokens": {
          "type": "string",
          "description": "llmInputTokens field"
        },
        "llmTotalTokens": {
          "type": "string",
          "description": "llmTotalTokens field"
        },
        "k8sPodEntityKey": {
          "type": "string",
          "description": "k8sPodEntityKey field"
        },
        "llmOutputTokens": {
          "type": "string",
          "description": "llmOutputTokens field"
        },
        "llmRequestModel": {
          "type": "string",
          "description": "llmRequestModel field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "durationUnixNano": {
          "type": "string",
          "description": "durationUnixNano field"
        },
        "k8sNodeEntityKey": {
          "type": "string",
          "description": "k8sNodeEntityKey field"
        },
        "llmResponseModel": {
          "type": "string",
          "description": "llmResponseModel field"
        },
        "serviceEntityKey": {
          "type": "string",
          "description": "serviceEntityKey field"
        },
        "llmConversationId": {
          "type": "string",
          "description": "llmConversationId field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        },
        "containerEntityKey": {
          "type": "string",
          "description": "containerEntityKey field"
        },
        "k8sClusterEntityKey": {
          "type": "string",
          "description": "k8sClusterEntityKey field"
        },
        "llmUserMessagePreview": {
          "type": "string",
          "description": "llmUserMessagePreview field"
        }
      },
      "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "kind": {
          "type": "string",
          "description": "kind field"
        },
        "name": {
          "type": "string",
          "description": "name field"
        },
        "links": {
          "type": "string",
          "description": "links field"
        },
        "events": {
          "type": "string",
          "description": "events field"
        },
        "spanId": {
          "type": "string",
          "description": "spanId field"
        },
        "endTime": {
          "type": "string",
          "description": "endTime field"
        },
        "llmCost": {
          "type": "string",
          "description": "llmCost field"
        },
        "llmTeam": {
          "type": "string",
          "description": "llmTeam field"
        },
        "traceId": {
          "type": "string",
          "description": "traceId field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "isLlmSpan": {
          "type": "string",
          "description": "isLlmSpan field"
        },
        "llmIssues": {
          "type": "string",
          "description": "llmIssues field"
        },
        "llmSystem": {
          "type": "string",
          "description": "llmSystem field"
        },
        "llmUserId": {
          "type": "string",
          "description": "llmUserId field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "sessionId": {
          "type": "string",
          "description": "sessionId field"
        },
        "startTime": {
          "type": "string",
          "description": "startTime field"
        },
        "attributes": {
          "type": "string",
          "description": "attributes field"
        },
        "entityKeys": {
          "type": "string",
          "description": "entityKeys field"
        },
        "isRootSpan": {
          "type": "string",
          "description": "isRootSpan field"
        },
        "statusCode": {
          "type": "string",
          "description": "statusCode field"
        },
        "traceState": {
          "type": "string",
          "description": "traceState field"
        },
        "llmCallKind": {
          "type": "string",
          "description": "llmCallKind field"
        },
        "llmToolName": {
          "type": "string",
          "description": "llmToolName field"
        },
        "hasException": {
          "type": "string",
          "description": "hasException field"
        },
        "llmAgentName": {
          "type": "string",
          "description": "llmAgentName field"
        },
        "llmOperation": {
          "type": "string",
          "description": "llmOperation field"
        },
        "llmUserEmail": {
          "type": "string",
          "description": "llmUserEmail field"
        },
        "parentSpanId": {
          "type": "string",
          "description": "parentSpanId field"
        },
        "attributeKeys": {
          "type": "string",
          "description": "attributeKeys field"
        },
        "hostEntityKey": {
          "type": "string",
          "description": "hostEntityKey field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "statusMessage": {
          "type": "string",
          "description": "statusMessage field"
        },
        "llmInputTokens": {
          "type": "string",
          "description": "llmInputTokens field"
        },
        "llmTotalTokens": {
          "type": "string",
          "description": "llmTotalTokens field"
        },
        "endTimeUnixNano": {
          "type": "string",
          "description": "endTimeUnixNano field"
        },
        "k8sPodEntityKey": {
          "type": "string",
          "description": "k8sPodEntityKey field"
        },
        "llmOutputTokens": {
          "type": "string",
          "description": "llmOutputTokens field"
        },
        "llmRequestModel": {
          "type": "string",
          "description": "llmRequestModel field"
        },
        "primaryEntityId": {
          "type": "string",
          "description": "primaryEntityId field"
        },
        "durationUnixNano": {
          "type": "string",
          "description": "durationUnixNano field"
        },
        "k8sNodeEntityKey": {
          "type": "string",
          "description": "k8sNodeEntityKey field"
        },
        "llmResponseModel": {
          "type": "string",
          "description": "llmResponseModel field"
        },
        "serviceEntityKey": {
          "type": "string",
          "description": "serviceEntityKey field"
        },
        "llmConversationId": {
          "type": "string",
          "description": "llmConversationId field"
        },
        "primaryEntityType": {
          "type": "string",
          "description": "primaryEntityType field"
        },
        "startTimeUnixNano": {
          "type": "string",
          "description": "startTimeUnixNano field"
        },
        "containerEntityKey": {
          "type": "string",
          "description": "containerEntityKey field"
        },
        "k8sClusterEntityKey": {
          "type": "string",
          "description": "k8sClusterEntityKey field"
        },
        "llmUserMessagePreview": {
          "type": "string",
          "description": "llmUserMessagePreview field"
        }
      },
      "description": "Filter criteria for Spans. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "boolean",
          "example": true,
          "description": "Select _id field in the response"
        },
        "kind": {
          "type": "boolean",
          "example": true,
          "description": "Select kind field in the response"
        },
        "name": {
          "type": "boolean",
          "example": true,
          "description": "Select name field in the response"
        },
        "links": {
          "type": "boolean",
          "example": true,
          "description": "Select links field in the response"
        },
        "events": {
          "type": "boolean",
          "example": true,
          "description": "Select events field in the response"
        },
        "spanId": {
          "type": "boolean",
          "example": true,
          "description": "Select spanId field in the response"
        },
        "endTime": {
          "type": "boolean",
          "example": true,
          "description": "Select endTime field in the response"
        },
        "llmCost": {
          "type": "boolean",
          "example": true,
          "description": "Select llmCost field in the response"
        },
        "llmTeam": {
          "type": "boolean",
          "example": true,
          "description": "Select llmTeam field in the response"
        },
        "traceId": {
          "type": "boolean",
          "example": true,
          "description": "Select traceId field in the response"
        },
        "createdAt": {
          "type": "boolean",
          "example": true,
          "description": "Select createdAt field in the response"
        },
        "isLlmSpan": {
          "type": "boolean",
          "example": true,
          "description": "Select isLlmSpan field in the response"
        },
        "llmIssues": {
          "type": "boolean",
          "example": true,
          "description": "Select llmIssues field in the response"
        },
        "llmSystem": {
          "type": "boolean",
          "example": true,
          "description": "Select llmSystem field in the response"
        },
        "llmUserId": {
          "type": "boolean",
          "example": true,
          "description": "Select llmUserId field in the response"
        },
        "projectId": {
          "type": "boolean",
          "example": true,
          "description": "Select projectId field in the response"
        },
        "sessionId": {
          "type": "boolean",
          "example": true,
          "description": "Select sessionId field in the response"
        },
        "startTime": {
          "type": "boolean",
          "example": true,
          "description": "Select startTime field in the response"
        },
        "attributes": {
          "type": "boolean",
          "example": true,
          "description": "Select attributes field in the response"
        },
        "entityKeys": {
          "type": "boolean",
          "example": true,
          "description": "Select entityKeys field in the response"
        },
        "isRootSpan": {
          "type": "boolean",
          "example": true,
          "description": "Select isRootSpan field in the response"
        },
        "statusCode": {
          "type": "boolean",
          "example": true,
          "description": "Select statusCode field in the response"
        },
        "traceState": {
          "type": "boolean",
          "example": true,
          "description": "Select traceState field in the response"
        },
        "llmCallKind": {
          "type": "boolean",
          "example": true,
          "description": "Select llmCallKind field in the response"
        },
        "llmToolName": {
          "type": "boolean",
          "example": true,
          "description": "Select llmToolName field in the response"
        },
        "hasException": {
          "type": "boolean",
          "example": true,
          "description": "Select hasException field in the response"
        },
        "llmAgentName": {
          "type": "boolean",
          "example": true,
          "description": "Select llmAgentName field in the response"
        },
        "llmOperation": {
          "type": "boolean",
          "example": true,
          "description": "Select llmOperation field in the response"
        },
        "llmUserEmail": {
          "type": "boolean",
          "example": true,
          "description": "Select llmUserEmail field in the response"
        },
        "parentSpanId": {
          "type": "boolean",
          "example": true,
          "description": "Select parentSpanId field in the response"
        },
        "attributeKeys": {
          "type": "boolean",
          "example": true,
          "description": "Select attributeKeys field in the response"
        },
        "hostEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select hostEntityKey field in the response"
        },
        "retentionDate": {
          "type": "boolean",
          "example": true,
          "description": "Select retentionDate field in the response"
        },
        "statusMessage": {
          "type": "boolean",
          "example": true,
          "description": "Select statusMessage field in the response"
        },
        "llmInputTokens": {
          "type": "boolean",
          "example": true,
          "description": "Select llmInputTokens field in the response"
        },
        "llmTotalTokens": {
          "type": "boolean",
          "example": true,
          "description": "Select llmTotalTokens field in the response"
        },
        "endTimeUnixNano": {
          "type": "boolean",
          "example": true,
          "description": "Select endTimeUnixNano field in the response"
        },
        "k8sPodEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select k8sPodEntityKey field in the response"
        },
        "llmOutputTokens": {
          "type": "boolean",
          "example": true,
          "description": "Select llmOutputTokens field in the response"
        },
        "llmRequestModel": {
          "type": "boolean",
          "example": true,
          "description": "Select llmRequestModel field in the response"
        },
        "primaryEntityId": {
          "type": "boolean",
          "example": true,
          "description": "Select primaryEntityId field in the response"
        },
        "durationUnixNano": {
          "type": "boolean",
          "example": true,
          "description": "Select durationUnixNano field in the response"
        },
        "k8sNodeEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select k8sNodeEntityKey field in the response"
        },
        "llmResponseModel": {
          "type": "boolean",
          "example": true,
          "description": "Select llmResponseModel field in the response"
        },
        "serviceEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select serviceEntityKey field in the response"
        },
        "llmConversationId": {
          "type": "boolean",
          "example": true,
          "description": "Select llmConversationId field in the response"
        },
        "primaryEntityType": {
          "type": "boolean",
          "example": true,
          "description": "Select primaryEntityType field in the response"
        },
        "startTimeUnixNano": {
          "type": "boolean",
          "example": true,
          "description": "Select startTimeUnixNano field in the response"
        },
        "containerEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select containerEntityKey field in the response"
        },
        "k8sClusterEntityKey": {
          "type": "boolean",
          "example": true,
          "description": "Select k8sClusterEntityKey field in the response"
        },
        "llmUserMessagePreview": {
          "type": "boolean",
          "example": true,
          "description": "Select llmUserMessagePreview field in the response"
        }
      },
      "description": "Fields to return, as an object of field names to true (e.g. {\"time\": true, \"body\": true}). Select only the fields you need — telemetry rows can be large.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "title": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for title field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "isOwnerNotified": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isOwnerNotified field"
        },
        "endAnnouncementAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for endAnnouncementAt field"
        },
        "showAnnouncementAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for showAnnouncementAt field"
        },
        "subscriberNotificationStatus": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatus field"
        },
        "subscriberNotificationStatusMessage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatusMessage field"
        },
        "shouldStatusPageSubscribersBeNotified": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for shouldStatusPageSubscribersBeNotified field"
        },
        "subscriberNotificationStatusOnAnnouncementUpdated": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatusOnAnnouncementUpdated field"
        },
        "subscriberNotificationStatusMessageOnAnnouncementUpdated": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberNotificationStatusMessageOnAnnouncementUpdated field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "title": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for title field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "monitors": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for monitors field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "attachments": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for attachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "statusPages": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for statusPages field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "isOwnerNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "endAnnouncementAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for endAnnouncementAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "showAnnouncementAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for showAnnouncementAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "subscriberNotificationStatus": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatus field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationStatusMessage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "shouldStatusPageSubscribersBeNotified": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for shouldStatusPageSubscribersBeNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "subscriberNotificationStatusOnAnnouncementUpdated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for subscriberNotificationStatusOnAnnouncementUpdated field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "subscriberNotificationStatusMessageOnAnnouncementUpdated": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberNotificationStatusMessageOnAnnouncementUpdated field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        }
      },
      "description": "Filter criteria for Status Page Announcements. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Status Page Announcement (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage, subscriberNotificationStatusMessageOnAnnouncementUpdated."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for _id field"
        },
        "name": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for name field"
        },
        "slug": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for slug field"
        },
        "theme": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for theme field"
        },
        "version": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for version field"
        },
        "createdAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdAt field"
        },
        "deletedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedAt field"
        },
        "pageTitle": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for pageTitle field"
        },
        "projectId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for projectId field"
        },
        "updatedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for updatedAt field"
        },
        "archivedAt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedAt field"
        },
        "isArchived": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isArchived field"
        },
        "logoFileId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for logoFileId field"
        },
        "description": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for description field"
        },
        "ipWhitelist": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for ipWhitelist field"
        },
        "logoAltText": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for logoAltText field"
        },
        "smtpConfigId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for smtpConfigId field"
        },
        "copyrightText": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for copyrightText field"
        },
        "faviconFileId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for faviconFileId field"
        },
        "reportTimezone": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for reportTimezone field"
        },
        "callSmsConfigId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for callSmsConfigId field"
        },
        "createdByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for createdByUserId field"
        },
        "defaultLanguage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for defaultLanguage field"
        },
        "deletedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for deletedByUserId field"
        },
        "enableMcpServer": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for enableMcpServer field"
        },
        "isReportEnabled": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isReportEnabled field"
        },
        "pageDescription": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for pageDescription field"
        },
        "archivedByUserId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for archivedByUserId field"
        },
        "coverImageFileId": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for coverImageFileId field"
        },
        "reportDataInDays": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for reportDataInDays field"
        },
        "reportPeriodType": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for reportPeriodType field"
        },
        "sendNextReportBy": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for sendNextReportBy field"
        },
        "coverImageAltText": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for coverImageAltText field"
        },
        "isPublicStatusPage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isPublicStatusPage field"
        },
        "masterPasswordSalt": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for masterPasswordSalt field"
        },
        "requireSsoForLogin": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for requireSsoForLogin field"
        },
        "reportStartDateTime": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for reportStartDateTime field"
        },
        "enableMasterPassword": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for enableMasterPassword field"
        },
        "enableSmsSubscribers": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for enableSmsSubscribers field"
        },
        "enableEmailSubscribers": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for enableEmailSubscribers field"
        },
        "enableSlackSubscribers": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for enableSlackSubscribers field"
        },
        "onlyShowScopedIncidents": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for onlyShowScopedIncidents field"
        },
        "showUptimeHistoryInDays": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for showUptimeHistoryInDays field"
        },
        "enableWebhookSubscribers": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for enableWebhookSubscribers field"
        },
        "showEpisodeHistoryInDays": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for showEpisodeHistoryInDays field"
        },
        "showEpisodesOnStatusPage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for showEpisodesOnStatusPage field"
        },
        "showIncidentHistoryInDays": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for showIncidentHistoryInDays field"
        },
        "showIncidentsOnStatusPage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for showIncidentsOnStatusPage field"
        },
        "embeddedOverallStatusToken": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for embeddedOverallStatusToken field"
        },
        "enableSearchEngineIndexing": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for enableSearchEngineIndexing field"
        },
        "enableEmbeddedOverallStatus": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for enableEmbeddedOverallStatus field"
        },
        "sendSubscriberNotifications": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for sendSubscriberNotifications field"
        },
        "allowedSubscriberEmailDomains": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for allowedSubscriberEmailDomains field"
        },
        "overallUptimePercentPrecision": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for overallUptimePercentPrecision field"
        },
        "showAnnouncementHistoryInDays": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for showAnnouncementHistoryInDays field"
        },
        "showAnnouncementsOnStatusPage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for showAnnouncementsOnStatusPage field"
        },
        "showEpisodeLabelsOnStatusPage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for showEpisodeLabelsOnStatusPage field"
        },
        "hidePoweredByOneUptimeBranding": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for hidePoweredByOneUptimeBranding field"
        },
        "limitSubscribersToPrivateUsers": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for limitSubscribersToPrivateUsers field"
        },
        "showIncidentLabelsOnStatusPage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for showIncidentLabelsOnStatusPage field"
        },
        "showSubscriberPageOnStatusPage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for showSubscriberPageOnStatusPage field"
        },
        "enableMicrosoftTeamsSubscribers": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for enableMicrosoftTeamsSubscribers field"
        },
        "privateUserSessionLengthInHours": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for privateUserSessionLengthInHours field"
        },
        "showScheduledEventHistoryInDays": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for showScheduledEventHistoryInDays field"
        },
        "allowSubscribersToChooseResources": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for allowSubscribersToChooseResources field"
        },
        "isOwnerNotifiedOfResourceCreation": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for isOwnerNotifiedOfResourceCreation field"
        },
        "allowSubscribersToChooseEventTypes": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for allowSubscribersToChooseEventTypes field"
        },
        "showOverallUptimePercentOnStatusPage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for showOverallUptimePercentOnStatusPage field"
        },
        "showScheduledEventLabelsOnStatusPage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for showScheduledEventLabelsOnStatusPage field"
        },
        "subscriberEmailNotificationFooterText": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for subscriberEmailNotificationFooterText field"
        },
        "showScheduledMaintenanceEventsOnStatusPage": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for showScheduledMaintenanceEventsOnStatusPage field"
        },
        "enableCustomSubscriberEmailNotificationFooterText": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "type": "string",
          "example": "ASC",
          "description": "Sort order for enableCustomSubscriberEmailNotificationFooterText field"
        }
      },
      "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "name": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "slug": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "theme": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for theme field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "labels": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "version": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "createdAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "customCSS": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customCSS field of type CSS. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "deletedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "pageTitle": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for pageTitle field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "projectId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "updatedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "archivedAt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "footerHTML": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for footerHTML field of type HTML. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "headerHTML": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for headerHTML field of type HTML. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "isArchived": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "logoFileId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for logoFileId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "description": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "ipWhitelist": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for ipWhitelist field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "logoAltText": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for logoAltText field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "customFields": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "smtpConfigId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for smtpConfigId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "copyrightText": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for copyrightText field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "faviconFileId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for faviconFileId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "masterPassword": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for masterPassword field of type Hashed String. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "reportTimezone": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for reportTimezone field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "callSmsConfigId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for callSmsConfigId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "createdByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "defaultBarColor": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for defaultBarColor field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "defaultLanguage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for defaultLanguage field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "deletedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "enableMcpServer": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableMcpServer field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "isReportEnabled": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isReportEnabled field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "pageDescription": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for pageDescription field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "archivedByUserId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "coverImageFileId": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          },
          "description": "Query operators for coverImageFileId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes"
        },
        "customJavaScript": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for customJavaScript field of type JavaSCript. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "enabledLanguages": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for enabledLanguages field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "reportDataInDays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for reportDataInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "reportPeriodType": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for reportPeriodType field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "sendNextReportBy": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for sendNextReportBy field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "coverImageAltText": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for coverImageAltText field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "isPublicStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isPublicStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "masterPasswordSalt": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for masterPasswordSalt field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "requireSsoForLogin": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for requireSsoForLogin field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "reportStartDateTime": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "2023-01-01T00:00:00.000Z"
          },
          "description": "Query operators for reportStartDateTime field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "subscriberTimezones": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberTimezones field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "enableMasterPassword": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableMasterPassword field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "enableSmsSubscribers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableSmsSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "enableEmailSubscribers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableEmailSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "enableSlackSubscribers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableSlackSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "downtimeMonitorStatuses": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for downtimeMonitorStatuses field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes"
        },
        "onlyShowScopedIncidents": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for onlyShowScopedIncidents field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "overviewPageDescription": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for overviewPageDescription field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "reportRecurringInterval": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for reportRecurringInterval field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull"
        },
        "showUptimeHistoryInDays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for showUptimeHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "enableWebhookSubscribers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableWebhookSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "showEpisodeHistoryInDays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for showEpisodeHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "showEpisodesOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showEpisodesOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "showIncidentHistoryInDays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for showIncidentHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "showIncidentsOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showIncidentsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "embeddedOverallStatusToken": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for embeddedOverallStatusToken field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "enableSearchEngineIndexing": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableSearchEngineIndexing field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "enableEmbeddedOverallStatus": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableEmbeddedOverallStatus field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "sendSubscriberNotifications": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for sendSubscriberNotifications field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "allowedSubscriberEmailDomains": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for allowedSubscriberEmailDomains field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "overallUptimePercentPrecision": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "John Doe"
          },
          "description": "Query operators for overallUptimePercentPrecision field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "showAnnouncementHistoryInDays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for showAnnouncementHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "showAnnouncementsOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showAnnouncementsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "showEpisodeLabelsOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showEpisodeLabelsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "hidePoweredByOneUptimeBranding": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for hidePoweredByOneUptimeBranding field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "limitSubscribersToPrivateUsers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for limitSubscribersToPrivateUsers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "showIncidentLabelsOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showIncidentLabelsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "showSubscriberPageOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showSubscriberPageOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "enableMicrosoftTeamsSubscribers": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableMicrosoftTeamsSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "privateUserSessionLengthInHours": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for privateUserSessionLengthInHours field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "showScheduledEventHistoryInDays": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": 50
          },
          "description": "Query operators for showScheduledEventHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween"
        },
        "allowSubscribersToChooseResources": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for allowSubscribersToChooseResources field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "isOwnerNotifiedOfResourceCreation": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for isOwnerNotifiedOfResourceCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "allowSubscribersToChooseEventTypes": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for allowSubscribersToChooseEventTypes field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "showOverallUptimePercentOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showOverallUptimePercentOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "showScheduledEventLabelsOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showScheduledEventLabelsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "subscriberEmailNotificationFooterText": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": "example_value_1"
          },
          "description": "Query operators for subscriberEmailNotificationFooterText field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes"
        },
        "showScheduledMaintenanceEventsOnStatusPage": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for showScheduledMaintenanceEventsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        },
        "enableCustomSubscriberEmailNotificationFooterText": {
          "type": "object",
          "example": {
            "_type": "EqualTo",
            "value": true
          },
          "description": "Query operators for enableCustomSubscriberEmailNotificationFooterText field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull"
        }
      },
      "description": "Filter criteria for Status Pages. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional: field names to return for each Status Page (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): headerHTML, footerHTML, allowedSubscriberEmailDomains, customFields, subscriberTimezones, reportRecurringInterval, subscriberEmailNotificationFooterText, ipWhitelist, enabledLanguages."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "skip": {
      "type": "number",
      "description": "Number of records to skip. Default: 0."
    },
    "sort": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "feedId": {
          "type": "string",
          "description": "feedId field"
        },
        "stixId": {
          "type": "string",
          "description": "stixId field"
        },
        "revoked": {
          "type": "string",
          "description": "revoked field"
        },
        "feedName": {
          "type": "string",
          "description": "feedName field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "confidence": {
          "type": "string",
          "description": "confidence field"
        },
        "indicatorName": {
          "type": "string",
          "description": "indicatorName field"
        },
        "indicatorType": {
          "type": "string",
          "description": "indicatorType field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "indicatorValue": {
          "type": "string",
          "description": "indicatorValue field"
        }
      },
      "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.",
      "additionalProperties": false
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries."
    },
    "query": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "string",
          "description": "_id field"
        },
        "feedId": {
          "type": "string",
          "description": "feedId field"
        },
        "stixId": {
          "type": "string",
          "description": "stixId field"
        },
        "revoked": {
          "type": "string",
          "description": "revoked field"
        },
        "version": {
          "type": "string",
          "description": "version field"
        },
        "feedName": {
          "type": "string",
          "description": "feedName field"
        },
        "createdAt": {
          "type": "string",
          "description": "createdAt field"
        },
        "projectId": {
          "type": "string",
          "description": "projectId field"
        },
        "validFrom": {
          "type": "string",
          "description": "validFrom field"
        },
        "confidence": {
          "type": "string",
          "description": "confidence field"
        },
        "stixLabels": {
          "type": "string",
          "description": "stixLabels field"
        },
        "validUntil": {
          "type": "string",
          "description": "validUntil field"
        },
        "indicatorName": {
          "type": "string",
          "description": "indicatorName field"
        },
        "indicatorType": {
          "type": "string",
          "description": "indicatorType field"
        },
        "retentionDate": {
          "type": "string",
          "description": "retentionDate field"
        },
        "indicatorValue": {
          "type": "string",
          "description": "indicatorValue field"
        }
      },
      "description": "Filter criteria for Threat Intel Indicators. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}.",
      "additionalProperties": false
    },
    "select": {
      "type": "object",
      "properties": {
        "_id": {
          "type": "boolean",
          "example": true,
          "description": "Select _id field in the response"
        },
        "feedId": {
          "type": "boolean",
          "example": true,
          "description": "Select feedId field in the response"
        },
        "stixId": {
          "type": "boolean",
          "example": true,
          "description": "Select stixId field in the response"
        },
        "revoked": {
          "type": "boolean",
          "example": true,
          "description": "Select revoked field in the response"
        },
        "version": {
          "type": "boolean",
          "example": true,
          "description": "Select version field in the response"
        },
        "feedName": {
          "type": "boolean",
          "example": true,
          "description": "Select feedName field in the response"
        },
        "createdAt": {
          "type": "boolean",
          "example": true,
          "description": "Select createdAt field in the response"
        },
        "projectId": {
          "type": "boolean",
          "example": true,
          "description": "Select projectId field in the response"
        },
        "validFrom": {
          "type": "boolean",
          "example": true,
          "description": "Select validFrom field in the response"
        },
        "confidence": {
          "type": "boolean",
          "example": true,
          "description": "Select confidence field in the response"
        },
        "stixLabels": {
          "type": "boolean",
          "example": true,
          "description": "Select stixLabels field in the response"
        },
        "validUntil": {
          "type": "boolean",
          "example": true,
          "description": "Select validUntil field in the response"
        },
        "indicatorName": {
          "type": "boolean",
          "example": true,
          "description": "Select indicatorName field in the response"
        },
        "indicatorType": {
          "type": "boolean",
          "example": true,
          "description": "Select indicatorType field in the response"
        },
        "retentionDate": {
          "type": "boolean",
          "example": true,
          "description": "Select retentionDate field in the response"
        },
        "indicatorValue": {
          "type": "boolean",
          "example": true,
          "description": "Select indicatorValue field in the response"
        }
      },
      "description": "Fields to return, as an object of field names to true (e.g. {\"time\": true, \"body\": true}). Select only the fields you need — telemetry rows can be large.",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Argument	Type	Description
topic	string	Optional topic to get help on: 'resources', 'incidents', 'monitors', 'alerts', 'workflows', or 'examples'

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "topic": {
      "enum": [
        "resources",
        "incidents",
        "monitors",
        "alerts",
        "workflows",
        "examples"
      ],
      "type": "string",
      "description": "Optional topic to get help on: 'resources', 'incidents', 'monitors', 'alerts', 'workflows', or 'examples'"
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Alert to update. Required. Use list_alerts to find IDs."
    },
    "hosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of hosts affected by this alert."
    },
    "title": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Title of this alert."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Relation to Labels Array where this object is categorized in."
    },
    "services": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of services affected by this alert."
    },
    "iotFleets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of IoT fleets affected by this alert."
    },
    "isPrivate": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "If true, this alert is only visible to its owners (users in 'owner users' and members of 'owner teams'), project admins, and project owners."
    },
    "monitorId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of the monitor this alert belongs to."
    },
    "description": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Short description of this alert. This will be visible on the status page. This is in markdown."
    },
    "dockerHosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Docker hosts affected by this alert."
    },
    "podmanHosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Podman hosts affected by this alert."
    },
    "cephClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Ceph clusters affected by this alert."
    },
    "customFields": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Custom Fields on this resource."
    },
    "storageArrays": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of storage arrays affected by this alert."
    },
    "telemetryQuery": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Telemetry query for this alert."
    },
    "vmwareVCenters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of vCenters affected by this alert."
    },
    "alertSeverityId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Alert Severity ID."
    },
    "databaseServers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of databases affected by this alert."
    },
    "dockerResources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Docker resources (containers, images, networks, volumes) affected by this alert."
    },
    "enableReminders": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should reminder notifications be sent to owners while this alert is still open? Reminders are sent based on the reminder rules configured for this project."
    },
    "impactStartedAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When customer impact actually began. Left blank until someone records it - never inferred, because a guessed value is worse than no value."
    },
    "podmanResources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Podman resources (containers, images, networks, volumes) affected by this alert."
    },
    "proxmoxClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Proxmox clusters affected by this alert."
    },
    "remediationNotes": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Notes on how to remediate this alert. This is in markdown."
    },
    "kubernetesClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Kubernetes clusters affected by this alert."
    },
    "onCallDutyPolicies": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of on-call duty policies affected by this alert."
    },
    "currentAlertStateId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Current Alert State ID."
    },
    "dockerSwarmClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Docker Swarm clusters affected by this alert."
    },
    "kubernetesResources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Kubernetes resources (pods, deployments, nodes, etc.) affected by this alert."
    },
    "kubernetesContainers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Kubernetes containers affected by this alert."
    },
    "serviceLevelObjectives": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Service Level Objectives (SLOs) affected by this alert."
    },
    "monitorStatusWhenThisAlertWasCreatedId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Monitor Status ID when this alert was created."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Alert State to update. Required. Use list_alert_states to find IDs."
    },
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "color": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Color of this resource in Hex (#32a852 for example)."
    },
    "order": {
      "type": "integer",
      "example": 10,
      "description": "Where this state sits in the project's list of alert states: 1 is the top. Alerts only ever move down the list, and an alert in a state at or below the acknowledged (or resolved) state counts as acknowledged (or resolved), so the created, acknowledged and resolved states have to stay in that order. A new state without a number goes just above the resolved state. Setting a number moves the state to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived states stay on the alerts and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    },
    "isCreatedState": {
      "type": "boolean",
      "example": true,
      "description": "Is it the created state of the alert?"
    },
    "isResolvedState": {
      "type": "boolean",
      "example": true,
      "description": "Is it the resolved state of the alert?"
    },
    "isAcknowledgedState": {
      "type": "boolean",
      "example": true,
      "description": "Is it the acknowledged state of the alert?"
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident to update. Required. Use list_incidents to find IDs."
    },
    "hosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of hosts affected by this incident."
    },
    "title": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Title of this incident."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Relation to Labels Array where this object is categorized in."
    },
    "monitors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of monitors affected by this incident."
    },
    "services": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of services affected by this incident."
    },
    "iotFleets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of IoT fleets affected by this incident."
    },
    "isPrivate": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "If true, this incident is only visible to its owners (users in 'owner users' and members of 'owner teams'), project admins, and project owners. Private incidents are hidden from status pages."
    },
    "rootCause": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "What is the root cause of this incident?"
    },
    "declaredAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "Date and time when this incident was declared."
    },
    "description": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Short description of this incident. This is in markdown and will be visible on the status page."
    },
    "dockerHosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Docker hosts affected by this incident."
    },
    "podmanHosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Podman hosts affected by this incident."
    },
    "statusPages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Limit this incident to these status pages. When set, the incident is shown on, and notifies the subscribers of, only these pages among the status pages that list its monitors. Leave empty to reach every status page that lists its monitors."
    },
    "cephClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Ceph clusters affected by this incident."
    },
    "customFields": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "The incident's custom field values, keyed by each incident custom field's name. When a user or an API key creates or updates an incident, each value it sets or changes must fit its field - a number for a Number field, true or false for a Boolean, one of the options for a Dropdown, and so on - or the request is refused. Values left as they were, keys that are not the name of a field and empty values are not checked. Required on Create is not enforced here: it applies to the dashboard's Declare Incident form only."
    },
    "storageArrays": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of storage arrays affected by this incident."
    },
    "postmortemNote": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Document the postmortem summary for this incident."
    },
    "telemetryQuery": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Telemetry query for this incident."
    },
    "vmwareVCenters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of vCenters affected by this incident."
    },
    "databaseServers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of databases affected by this incident."
    },
    "dockerResources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Docker resources (containers, images, networks, volumes) affected by this incident."
    },
    "enableReminders": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should reminder notifications be sent to owners while this incident is still open? Reminders are sent based on the reminder rules configured for this project."
    },
    "impactStartedAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When customer impact actually began. Left blank until someone records it - never inferred, because a guessed value is worse than no value."
    },
    "podmanResources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Podman resources (containers, images, networks, volumes) affected by this incident."
    },
    "proxmoxClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Proxmox clusters affected by this incident."
    },
    "remediationNotes": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Notes on how to remediate this incident. This is in markdown."
    },
    "incidentSeverityId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Incident Severity ID."
    },
    "kubernetesClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Kubernetes clusters affected by this incident."
    },
    "onCallDutyPolicies": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of on-call duty policies affected by this incident."
    },
    "postmortemPostedAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "Timestamp that will be shown alongside the published postmortem on the status page."
    },
    "postmortemStatusId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of the incident's postmortem status. Left out on create, the postmortem starts in the project's not started status - or its draft status when the incident is created with a postmortem note, its completed status when that note is published on a status page."
    },
    "dockerSwarmClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Docker Swarm clusters affected by this incident."
    },
    "kubernetesResources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Kubernetes resources (pods, deployments, nodes, etc.) affected by this incident."
    },
    "kubernetesContainers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Kubernetes containers affected by this incident."
    },
    "isVisibleOnStatusPage": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should this incident be visible on the status page?"
    },
    "postmortemAttachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Files that accompany the postmortem note and can be shared publicly when enabled."
    },
    "currentIncidentStateId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Current Incident State ID."
    },
    "serviceLevelObjectives": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Service Level Objectives (SLOs) affected by this incident."
    },
    "changeMonitorStatusToId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Relation to Monitor Status Object ID. All monitors connected to this incident will be changed to this status when the incident is created."
    },
    "showPostmortemOnStatusPage": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Should the postmortem note and attachments be visible on the status page once published?"
    },
    "notifySubscribersOnPostmortemPublished": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should subscribers be notified when the postmortem is published?"
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Incident State to update. Required. Use list_incident_states to find IDs."
    },
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "color": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Color of this resource in Hex (#32a852 for example)."
    },
    "order": {
      "type": "integer",
      "example": 10,
      "description": "Where this state sits in the project's list of incident states: 1 is the top. Incidents only ever move down the list, and an incident in a state at or below the acknowledged (or resolved) state counts as acknowledged (or resolved), so the created, acknowledged and resolved states have to stay in that order. A new state without a number goes just above the resolved state. Setting a number moves the state to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived states stay on the incidents and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    },
    "isCreatedState": {
      "type": "boolean",
      "example": true,
      "description": "Is it the created state of the incident?"
    },
    "isResolvedState": {
      "type": "boolean",
      "example": true,
      "description": "Is it the resolved state of the incident?"
    },
    "isAcknowledgedState": {
      "type": "boolean",
      "example": true,
      "description": "Is it the acknowledged state of the incident?"
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Monitor to update. Required. Use list_monitors to find IDs."
    },
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name for this monitor."
    },
    "hosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Relation to Labels Array where this object is categorized in."
    },
    "services": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Services this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "iotFleets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "IoT fleets this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived monitors are hidden from monitor lists and status pages, are not checked, and open no incidents or alerts. Unarchiving resumes monitoring."
    },
    "description": {
      "type": "string",
      "example": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
      "description": "Friendly description that will help you remember."
    },
    "dockerHosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Docker hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "podmanHosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Podman hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "cephClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Ceph clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "customFields": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Custom Fields on this resource."
    },
    "monitorSteps": {
      "type": "object",
      "example": {
        "_type": "MonitorSteps",
        "value": {
          "monitorStepsInstanceArray": []
        }
      },
      "description": "What would you like to monitor and what is the criteria?"
    },
    "storageArrays": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Storage arrays this monitor watches. Incidents and alerts it creates are linked to them."
    },
    "vmwareVCenters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "VMware vCenters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "databaseServers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Databases this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "proxmoxClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Proxmox clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "dependsOnMonitors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Parent monitors this monitor depends on. When a parent is offline (or in one of the configured suppression statuses), alerts and incidents from this monitor are suppressed at creation time — the monitor keeps evaluating and its status timeline still updates."
    },
    "monitorTemplateId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of the Monitor Template this monitor was created from. Null for monitors not created from a template."
    },
    "kubernetesClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Kubernetes clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "monitoringInterval": {
      "type": "string",
      "example": "Example short text",
      "description": "How often would you like OneUptime to monitor this resource? A 5-field cron expression, not a label: \"*/5 * * * *\" is every five minutes."
    },
    "dockerSwarmClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Docker Swarm clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there."
    },
    "minimumProbeAgreement": {
      "type": "number",
      "example": 42,
      "description": "Minimum number of probes that must agree on a status before the monitor status changes. If null, all enabled and connected probes must agree."
    },
    "currentMonitorStatusId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Whats the current status ID of this monitor?"
    },
    "disableActiveMonitoring": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Disable active monitoring for this resource?"
    },
    "incomingEmailCustomLocalPart": {
      "type": "string",
      "example": "Example short text",
      "description": "This field is for Incoming Email Monitor only. A custom name for this monitor's inbound email address: the part before the @, on the server's inbound email domain. While set, it replaces the generated monitor-{secret key} address. Must be unique across all monitors. Set to null to go back to the generated address."
    },
    "suppressAlertsWhenParentMonitorStatuses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Parent monitor statuses that suppress this monitor's alerts and incidents. When empty, statuses flagged as offline suppress (the default). Only used when Depends On Monitors is set."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the On-Call Policy to update. Required. Use list_on_call_duty_policies to find IDs."
    },
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Relation to Labels Array where this object is categorized in."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived on-call policies are hidden from the On-Call Policies list and page no one: incidents and alerts that use them skip them. Unarchiving puts them back in service."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    },
    "customFields": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Custom Fields on this resource."
    },
    "acknowledgementTimeoutInMinutes": {
      "type": "number",
      "example": 42,
      "description": "Page again when something this policy paged about is acknowledged but not resolved within this many minutes (5 to 1440). Empty: never."
    },
    "repeatPolicyIfNoOneAcknowledges": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Repeat the policy if no one acknowledges the alert."
    },
    "repeatPolicyIfNoOneAcknowledgesNoOfTimes": {
      "type": "number",
      "default": 0,
      "example": 42,
      "description": "Repeat the policy X number of times if no one acknowledges the alert."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Postmortem Status to update. Required. Use list_postmortem_statuses to find IDs."
    },
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "color": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Color of this resource in Hex (#32a852 for example)."
    },
    "order": {
      "type": "integer",
      "example": 10,
      "description": "Where this status sits in the project's list of postmortem statuses: 1 is the top. A postmortem in the completed status, or in a status below it, counts as done; one above it is still owed. So the not started, draft and completed statuses have to stay in that order. A new status without a number goes just above the completed status. Setting a number moves the status to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived statuses stay on the incidents whose postmortems are in them, but can't be picked again. The not started, draft and completed statuses can't be archived."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    },
    "isDraftStatus": {
      "type": "boolean",
      "example": true,
      "description": "Is it the status a postmortem moves to once its note is written? A project has one, and it can't be deleted or archived."
    },
    "isCompletedStatus": {
      "type": "boolean",
      "example": true,
      "description": "Is it the status a postmortem moves to once it is published on a status page? A postmortem in this status, or in one below it, counts as done. A project has one, and it can't be deleted or archived."
    },
    "isNotStartedStatus": {
      "type": "boolean",
      "example": true,
      "description": "Is it the status a new incident's postmortem starts in? A project has one, and it can't be deleted or archived."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Scheduled Maintenance Event to update. Required. Use list_scheduled_maintenance_events to find IDs."
    },
    "hosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of hosts affected by this event."
    },
    "title": {
      "type": "string",
      "example": "Example short text",
      "description": "Title of this scheduled event."
    },
    "endsAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When does this event end?"
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Relation to Labels Array where this object is categorized in."
    },
    "monitors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of monitors attached to this event."
    },
    "services": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of services affected by this event."
    },
    "startsAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When does this event start?"
    },
    "iotFleets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of IoT fleets affected by this event."
    },
    "description": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Description of this scheduled event that will show up on Status Page. This is in markdown."
    },
    "dockerHosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Docker hosts affected by this event."
    },
    "podmanHosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Podman hosts affected by this event."
    },
    "statusPages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of status pages to show this event on."
    },
    "cephClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Ceph clusters affected by this event."
    },
    "customFields": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Custom Fields on this resource."
    },
    "networkSites": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of network sites affected by this event. Their descendants are covered too."
    },
    "storageArrays": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of storage arrays affected by this event."
    },
    "vmwareVCenters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of vCenters affected by this event."
    },
    "databaseServers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of databases affected by this event."
    },
    "enableReminders": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should reminder notifications be sent to owners while this scheduled maintenance event is still not complete? Reminders are sent based on the reminder rules configured for this project."
    },
    "proxmoxClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Proxmox clusters affected by this event."
    },
    "kubernetesClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Kubernetes clusters affected by this event."
    },
    "dockerSwarmClusters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of Docker Swarm clusters affected by this event."
    },
    "isVisibleOnStatusPage": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should this incident be visible on the status page?"
    },
    "changeMonitorStatusToId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Relation to Monitor Status Object ID. The monitors attached to this event change to this status when the event starts, and back to operational when it ends. It can be changed until the event starts."
    },
    "currentScheduledMaintenanceStateId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Scheduled Maintenance State ID. The state the event currently is in."
    },
    "nextSubscriberNotificationBeforeTheEventAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When will the next notification to subscribers be sent out?"
    },
    "sendSubscriberNotificationsOnBeforeTheEvent": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Should subscribers be notified before the event?"
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Scheduled Maintenance State to update. Required. Use list_scheduled_maintenance_states to find IDs."
    },
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "color": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Color of this resource in Hex (#32a852 for example)."
    },
    "order": {
      "type": "integer",
      "example": 10,
      "description": "Where this state sits in the project's list of scheduled maintenance states: 1 is the top. Events only ever move down the list, so the scheduled, ongoing, ended and completed states have to stay in that order. A new state without a number goes just above the completed state. Setting a number moves the state to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived states stay on the maintenance events that are in them, but can't be picked again. The scheduled, ongoing, ended and completed states can't be archived."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    },
    "isEndedState": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Is this state a ended state?"
    },
    "isOngoingState": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Is this state a ongoing state?"
    },
    "isResolvedState": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Is this state a resolved state?"
    },
    "isScheduledState": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Is this state a scheduled state?"
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Security Case to update. Required. Use list_security_cases to find IDs."
    },
    "title": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "What the case is about, in a line."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Labels to filter and report on cases by."
    },
    "status": {
      "type": "string",
      "default": "New",
      "example": "Example short text",
      "description": "New, Investigating, Contained or Closed. Every case starts New; closing it records a verdict."
    },
    "verdict": {
      "type": "string",
      "example": "Example short text",
      "description": "What the case turned out to be, set when it is closed: True Positive, Benign Positive, False Positive or Undetermined."
    },
    "entities": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "The users, hosts, IP addresses, domains and files the case is about, each as { type, value }. Detections add theirs as they join the case."
    },
    "priority": {
      "type": "string",
      "default": "Medium",
      "example": "Example short text",
      "description": "Critical, High, Medium, Low or Informational. A case opened by a detection starts at the detection's severity and rises when a more severe one joins it."
    },
    "closingNote": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Why the case was closed the way it was, in Markdown: what was found and what was done."
    },
    "description": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "What is known about the threat, in Markdown. A case opened by a detection starts with the detection's description."
    },
    "mitreTactics": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "ATT&CK tactic ids (TA0006) the case's detections are tagged with."
    },
    "mitreTechniques": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "ATT&CK technique ids (T1110) the case's detections are tagged with."
    },
    "assignedToTeamId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of the team whose queue the case is in."
    },
    "assignedToUserId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of the person working the case."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Security Playbook to update. Required. Use list_security_playbooks to find IDs."
    },
    "name": {
      "type": "object",
      "example": {
        "_type": "Name",
        "value": "John Doe"
      },
      "description": "What the playbook does, in a few words."
    },
    "steps": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "The steps the playbook takes, in order. Each has an action, its settings, and whether it needs approval, may fail without stopping the run, or runs only when threat intel matched."
    },
    "trigger": {
      "type": "string",
      "default": "Case Opened",
      "example": "Example short text",
      "description": "When the playbook runs on its own: Case Opened, Detection Added (a new detection joins an open case), or Manual (only when somebody runs it)."
    },
    "isEnabled": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Whether the playbook runs on its own. A disabled playbook can still be run by hand from a case."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "When to use the playbook and what it is for."
    },
    "detectionSource": {
      "type": "string",
      "example": "Example short text",
      "description": "Run only on cases raised by this source: a Detection Rule, Threat Intel or a Connected Product. Empty runs on every source."
    },
    "minimumPriority": {
      "type": "string",
      "example": "Example short text",
      "description": "Run only on cases at this priority or above. Empty runs on every priority."
    },
    "detectionRuleIds": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Run only on cases with a detection from one of these detection rules. Empty runs on cases from any rule."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Status Page to update. Required. Use list_status_pages to find IDs."
    },
    "name": {
      "type": "string",
      "example": "Example short text",
      "description": "Any friendly name of this object."
    },
    "theme": {
      "type": "string",
      "default": "Light",
      "example": "Example short text",
      "description": "How the status page looks to visitors: Light, Dark, or System (light or dark, as each visitor's device is set). A status page created without a theme starts with System."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Relation to Labels Array where this object is categorized in."
    },
    "customCSS": {
      "type": "string",
      "example": "body { color: #333; margin: 0; }",
      "description": "Status Page Custom CSS. Served only from a verified custom domain."
    },
    "pageTitle": {
      "type": "string",
      "example": "Example short text",
      "description": "Title of your Status Page. This is used for SEO."
    },
    "footerHTML": {
      "type": "string",
      "example": "<div><h1>Title</h1><p>Content</p></div>",
      "description": "Status Page Custom HTML Footer. Served only from a verified custom domain."
    },
    "headerHTML": {
      "type": "string",
      "example": "<div><h1>Title</h1><p>Content</p></div>",
      "description": "Status Page Custom HTML Header. Served only from a verified custom domain."
    },
    "isArchived": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Archived status pages are hidden from the Status Pages list, are not served to visitors, and send nothing to their subscribers. Unarchiving puts them back online."
    },
    "logoFileId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Status Page Logo File ID."
    },
    "description": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Friendly description that will help you remember."
    },
    "ipWhitelist": {
      "type": "string",
      "example": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
      "description": "IP Whitelist for this Status Page. One IP per line. Only used if the status page is private."
    },
    "logoAltText": {
      "type": "string",
      "example": "Example short text",
      "description": "Alternative text for the logo image, read by screen readers for accessibility."
    },
    "customFields": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Custom Fields on this resource."
    },
    "smtpConfigId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your SMTP Config Resource which is used to send email to subscribers."
    },
    "copyrightText": {
      "type": "string",
      "example": "Example short text",
      "description": "Copyright Text."
    },
    "faviconFileId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Status Page Favicon File ID."
    },
    "masterPassword": {
      "type": "string",
      "format": "password",
      "example": "hashed_string_value",
      "description": "Password required to unlock a private status page. This value is stored as a secure hash."
    },
    "reportTimezone": {
      "type": "string",
      "default": "UTC",
      "example": "Example short text",
      "description": "The timezone report periods and send times are resolved in. A monthly report in this timezone runs from the 1st at 00:00 to the last day at 23:59."
    },
    "callSmsConfigId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "ID of your Call/SMS Config Resource which is used to send SMS to subscribers."
    },
    "defaultBarColor": {
      "type": "object",
      "example": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "description": "Default color of the bar on the overview page."
    },
    "defaultLanguage": {
      "type": "string",
      "default": "en",
      "example": "Example short text",
      "description": "Default language that the status page is shown in when a visitor arrives for the first time."
    },
    "enableMcpServer": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Can AI agents read this status page over the public OneUptime MCP server? This does not affect the status page website, its RSS feed, or its public JSON API."
    },
    "isReportEnabled": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Whether this status page's email subscribers get reports. Turned on without a schedule, reports go out on the 1st of every month at 09:00 in the report timezone, each covering the calendar month before it."
    },
    "pageDescription": {
      "type": "string",
      "example": "This is an example of longer text content that might be stored in this field.",
      "description": "Description of your Status Page. This is used for SEO."
    },
    "coverImageFileId": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Status Page Cover Image ID."
    },
    "customJavaScript": {
      "type": "string",
      "example": "function example() { return true; }",
      "description": "Status Page Custom JavaScript. This runs when the status page is loaded from a verified custom domain."
    },
    "enabledLanguages": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Languages offered in the footer language switcher. Leave empty to offer all supported languages."
    },
    "reportDataInDays": {
      "type": "number",
      "default": 30,
      "example": 42,
      "description": "How many days of data should be included in the report?"
    },
    "reportPeriodType": {
      "type": "string",
      "default": "Rolling",
      "example": "Example short text",
      "description": "Should the report cover a rolling number of days, or the previous whole calendar period?"
    },
    "sendNextReportBy": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When the next report goes out. The server works it out from the schedule."
    },
    "coverImageAltText": {
      "type": "string",
      "example": "Example short text",
      "description": "Alternative text for the cover image, read by screen readers for accessibility. Leave blank if the cover image is purely decorative."
    },
    "isPublicStatusPage": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Is this status page public?"
    },
    "requireSsoForLogin": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Should SSO be required to login to Private Status Page."
    },
    "reportStartDateTime": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When the first report goes out. Every later one follows it by the recurring interval, at the same time of day. Left out when reports are turned on, it is 09:00 in the report timezone at the start of the next period of the interval: the next 1st of the month for a monthly schedule (the default), the next Monday for a weekly one, the next day for a daily one and the next 1 January for a yearly one. An hourly schedule starts at the next full hour."
    },
    "subscriberTimezones": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "Timezones of subscribers to this status page."
    },
    "enableMasterPassword": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Require visitors to enter a master password before viewing a private status page."
    },
    "enableSmsSubscribers": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Can SMS subscribers subscribe to this Status Page?"
    },
    "enableEmailSubscribers": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Can email subscribers subscribe to this Status Page?"
    },
    "enableSlackSubscribers": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Can Slack subscribers subscribe to this Status Page?"
    },
    "onlyShowScopedIncidents": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "When on, this status page shows and notifies its subscribers about only the incidents limited to it. Incidents that are not limited to any status page never reach it."
    },
    "overviewPageDescription": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Overview Page description for your status page. This is a markdown field."
    },
    "reportRecurringInterval": {
      "type": "object",
      "example": {
        "key": "value",
        "nested": {
          "data": 123
        }
      },
      "description": "How often a report goes out. Left out when reports are turned on, it is every month."
    },
    "showUptimeHistoryInDays": {
      "type": "number",
      "default": 90,
      "example": 42,
      "description": "How many days of uptime history should be shown on the status page? Maximum is 90 days."
    },
    "enableWebhookSubscribers": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Can Webhook subscribers subscribe to this Status Page?"
    },
    "showEpisodeHistoryInDays": {
      "type": "number",
      "default": 14,
      "example": 42,
      "description": "How many days of episode history to show on the status page."
    },
    "showEpisodesOnStatusPage": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Show Incident Episodes on Status Page?"
    },
    "showIncidentHistoryInDays": {
      "type": "number",
      "default": 14,
      "example": 42,
      "description": "How many days of incident history should be shown on the status page (in days)?"
    },
    "showIncidentsOnStatusPage": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Show Incidents on Status Page?"
    },
    "embeddedOverallStatusToken": {
      "type": "string",
      "example": "Example short text",
      "description": "Security token required to access the embedded overall status badge. This token must be provided in the URL."
    },
    "enableSearchEngineIndexing": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Should search engines like Google and Bing be allowed to index this status page? Turn this off to keep the page reachable by link but out of search results."
    },
    "enableEmbeddedOverallStatus": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Enable embedded overall status badge that can be displayed on external websites?"
    },
    "sendSubscriberNotifications": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Does this status page tell its subscribers anything? Off, it sends them nothing - no message about an incident, an episode, scheduled maintenance or an announcement, and no report - however the event was created. Its subscribers are kept, and the channel switches still decide how visitors can sign up."
    },
    "allowedSubscriberEmailDomains": {
      "type": "string",
      "example": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
      "description": "The domains an email subscriber's address may be at, one a line, such as acme.com. An address at a subdomain of one matches too. Sign-ups and additions at any other domain are refused, and an email subscriber at another domain is sent nothing. Empty: any domain."
    },
    "overallUptimePercentPrecision": {
      "type": "string",
      "default": "99.99% (Two Decimal)",
      "example": "Example short text",
      "description": "Overall Precision of uptime percent for this status page."
    },
    "showAnnouncementHistoryInDays": {
      "type": "number",
      "default": 14,
      "example": 42,
      "description": "How many days of announcement history should be shown on the status page (in days)?"
    },
    "showAnnouncementsOnStatusPage": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Show Announcements on Status Page?"
    },
    "showEpisodeLabelsOnStatusPage": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Show Episode Labels on Status Page?"
    },
    "hidePoweredByOneUptimeBranding": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Hide Powered By OneUptime Branding?"
    },
    "limitSubscribersToPrivateUsers": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Only people who can sign in to this status page can be its subscribers, each with the email address they sign in with: no other address, and no phone, Slack, Microsoft Teams or webhook. A subscriber whose address is not a private user of this page - one removed since, by SCIM or by hand - is sent nothing."
    },
    "showIncidentLabelsOnStatusPage": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Show Incident Labels on Status Page?"
    },
    "showSubscriberPageOnStatusPage": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Show Subscriber Page on Status Page?"
    },
    "enableMicrosoftTeamsSubscribers": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Can Microsoft Teams subscribers subscribe to this Status Page?"
    },
    "privateUserSessionLengthInHours": {
      "type": "number",
      "example": 42,
      "description": "How long, in hours, a private user stays signed in to this private status page after signing in, however active they are - with a password, SSO or OIDC. When the time is up they sign in again. Applies to readers signed in now too. A whole number from 1 to 8760; empty for no limit, where a reader stays signed in while they open the page at least once every 30 days."
    },
    "showScheduledEventHistoryInDays": {
      "type": "number",
      "default": 14,
      "example": 42,
      "description": "How many days of scheduled event history should be shown on the status page (in days)?"
    },
    "allowSubscribersToChooseResources": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Can subscribers choose which resources to subscribe to?"
    },
    "allowSubscribersToChooseEventTypes": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Can subscribers choose which event type like Announcements, Incidents, Scheduled Events to subscribe to?"
    },
    "showOverallUptimePercentOnStatusPage": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Show Overall Uptime Percent on Status Page?"
    },
    "showScheduledEventLabelsOnStatusPage": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Show Scheduled Event Labels on Status Page?"
    },
    "subscriberEmailNotificationFooterText": {
      "type": "string",
      "example": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
      "description": "Text to send to subscribers in the footer of the email."
    },
    "showScheduledMaintenanceEventsOnStatusPage": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Show Scheduled Maintenance Events on Status Page?"
    },
    "enableCustomSubscriberEmailNotificationFooterText": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Enable custom footer text in subscriber email notifications."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier (UUID) of the Status Page Announcement to update. Required. Use list_status_page_announcements to find IDs."
    },
    "title": {
      "type": "string",
      "example": "Example short text",
      "description": "Title of this resource."
    },
    "monitors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "List of monitors affected by this announcement. If none are selected, all subscribers will be notified."
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Files attached to this announcement."
    },
    "description": {
      "type": "string",
      "example": "# Heading\n\nThis is **markdown** content",
      "description": "Text of the announcement. This can be in Markdown format."
    },
    "statusPages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "description": "Status Pages to show show this announcement on."
    },
    "endAnnouncementAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When should this announcement hidden?"
    },
    "showAnnouncementAt": {
      "type": "object",
      "example": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "description": "When should this announcement be shown?"
    }
  },
  "additionalProperties": false
}