Endpoints: 39,967MCP servers: 22,496Payout addresses: 2,533Paid calls: 3,294Letters: 54Defects: 1,976counted 4 min ago
teppi

Server definition

Hash
sha256:9632d559654a2bccb700fb1815dc409f517cc5353f93c48a943e4efefe9854df
What it is
What a remote MCP server returned when asked what it offers: 193 tools

The blob, as servednamed by its sha256

{ "instructions": null, "tools": [ { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "alertId": { "description": "UUID of the alert to acknowledge. Use list_alerts to find it.", "type": "string" } }, "required": [ "alertId" ], "type": "object" }, "name": "acknowledge_alert", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "incidentId": { "description": "UUID of the incident to acknowledge. Use list_incidents to find it.", "type": "string" } }, "required": [ "incidentId" ], "type": "object" }, "name": "acknowledge_incident", "outputSchema": null }, { "description": "Add an internal note to an alert, visible to your team. Markdown is supported.", "inputSchema": { "additionalProperties": false, "properties": { "alertId": { "description": "UUID of the alert to annotate.", "type": "string" }, "note": { "description": "The note content (Markdown supported).", "type": "string" } }, "required": [ "alertId", "note" ], "type": "object" }, "name": "add_alert_note", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "incidentId": { "description": "UUID of the incident to annotate.", "type": "string" }, "note": { "description": "The note content (Markdown supported).", "type": "string" }, "visibility": { "default": "internal", "description": "Where the note is visible: 'internal' (team only, default) or 'public' (posted to the status page).", "enum": [ "internal", "public" ], "type": "string" } }, "required": [ "incidentId", "note" ], "type": "object" }, "name": "add_incident_note", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "alertId": { "description": "Query operators for alertId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "attachments": { "description": "Query operators for attachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "isOwnerNotified": { "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "note": { "description": "Query operators for note field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postedAt": { "description": "Query operators for postedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "postedFromSlackMessageId": { "description": "Query operators for postedFromSlackMessageId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "savedFromChatMessage": { "description": "Query operators for savedFromChatMessage field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_alert_internal_notes", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "color": { "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "order": { "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 10 }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_alert_severities", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "alertId": { "description": "Query operators for alertId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "alertStateId": { "description": "Query operators for alertStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "endsAt": { "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "isOwnerNotified": { "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "rootCause": { "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "startsAt": { "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "stateChangeLog": { "description": "Query operators for stateChangeLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_alert_state_timelines", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "color": { "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isAcknowledgedState": { "description": "Query operators for isAcknowledgedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isCreatedState": { "description": "Query operators for isCreatedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isResolvedState": { "description": "Query operators for isResolvedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "order": { "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 10 }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_alert_states", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "aiInvestigationDecision": { "description": "Query operators for aiInvestigationDecision field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "alertEpisodeId": { "description": "Query operators for alertEpisodeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "alertNumber": { "description": "Query operators for alertNumber field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "alertNumberWithPrefix": { "description": "Query operators for alertNumberWithPrefix field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "alertSeverityId": { "description": "Query operators for alertSeverityId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "cephClusters": { "description": "Query operators for cephClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByProbeId": { "description": "Query operators for createdByProbeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdCriteriaId": { "description": "Query operators for createdCriteriaId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdStateLog": { "description": "Query operators for createdStateLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "currentAlertStateId": { "description": "Query operators for currentAlertStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "customFields": { "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "databaseServers": { "description": "Query operators for databaseServers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerHosts": { "description": "Query operators for dockerHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerResources": { "description": "Query operators for dockerResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerSwarmClusters": { "description": "Query operators for dockerSwarmClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "enableReminders": { "description": "Query operators for enableReminders field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "hosts": { "description": "Query operators for hosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "impactStartedAt": { "description": "Query operators for impactStartedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "iotFleets": { "description": "Query operators for iotFleets field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isCreatedAutomatically": { "description": "Query operators for isCreatedAutomatically field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isOwnerNotifiedOfAlertCreation": { "description": "Query operators for isOwnerNotifiedOfAlertCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isPrivate": { "description": "Query operators for isPrivate field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "kubernetesClusters": { "description": "Query operators for kubernetesClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "kubernetesContainers": { "description": "Query operators for kubernetesContainers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "kubernetesResources": { "description": "Query operators for kubernetesResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "labels": { "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "monitorId": { "description": "Query operators for monitorId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "monitorStatusWhenThisAlertWasCreatedId": { "description": "Query operators for monitorStatusWhenThisAlertWasCreatedId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "monitorSummary": { "description": "Query operators for monitorSummary field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "nextReminderNotificationAt": { "description": "Query operators for nextReminderNotificationAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "onCallDutyPolicies": { "description": "Query operators for onCallDutyPolicies field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "podmanHosts": { "description": "Query operators for podmanHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "podmanResources": { "description": "Query operators for podmanResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postUpdatesToWorkspaceChannels": { "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "proxmoxClusters": { "description": "Query operators for proxmoxClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "remediationNotes": { "description": "Query operators for remediationNotes field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "reminderNotificationSentCount": { "description": "Query operators for reminderNotificationSentCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "rootCause": { "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "seriesFingerprint": { "description": "Query operators for seriesFingerprint field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "seriesLabels": { "description": "Query operators for seriesLabels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "serviceLevelObjectives": { "description": "Query operators for serviceLevelObjectives field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "services": { "description": "Query operators for services field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "storageArrays": { "description": "Query operators for storageArrays field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "telemetryQuery": { "description": "Query operators for telemetryQuery field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "title": { "description": "Query operators for title field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "vmwareVCenters": { "description": "Query operators for vmwareVCenters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_alerts", "outputSchema": null }, { "description": "Count Change Events telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "attributeKeys": { "description": "attributeKeys field", "type": "string" }, "attributes": { "description": "attributes field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "description": { "description": "description field", "type": "string" }, "eventType": { "description": "eventType field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "time": { "description": "time field", "type": "string" }, "title": { "description": "title field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "count_change_events", "outputSchema": null }, { "description": "Count Exception Instances telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "attributeKeys": { "description": "attributeKeys field", "type": "string" }, "attributes": { "description": "attributes field", "type": "string" }, "containerEntityKey": { "description": "containerEntityKey field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "entityKeys": { "description": "entityKeys field", "type": "string" }, "environment": { "description": "environment field", "type": "string" }, "escaped": { "description": "escaped field", "type": "string" }, "exceptionType": { "description": "exceptionType field", "type": "string" }, "fingerprint": { "description": "fingerprint field", "type": "string" }, "hostEntityKey": { "description": "hostEntityKey field", "type": "string" }, "k8sClusterEntityKey": { "description": "k8sClusterEntityKey field", "type": "string" }, "k8sNodeEntityKey": { "description": "k8sNodeEntityKey field", "type": "string" }, "k8sPodEntityKey": { "description": "k8sPodEntityKey field", "type": "string" }, "message": { "description": "message field", "type": "string" }, "parsedFrames": { "description": "parsedFrames field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "release": { "description": "release field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "serviceEntityKey": { "description": "serviceEntityKey field", "type": "string" }, "sessionId": { "description": "sessionId field", "type": "string" }, "spanId": { "description": "spanId field", "type": "string" }, "spanName": { "description": "spanName field", "type": "string" }, "spanStatusCode": { "description": "spanStatusCode field", "type": "string" }, "stackTrace": { "description": "stackTrace field", "type": "string" }, "time": { "description": "time field", "type": "string" }, "timeUnixNano": { "description": "timeUnixNano field", "type": "string" }, "traceId": { "description": "traceId field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "count_exception_instances", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "alertId": { "description": "Query operators for alertId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "incidentId": { "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_incident_alerts", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "attachments": { "description": "Query operators for attachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "incidentId": { "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "isOwnerNotified": { "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "note": { "description": "Query operators for note field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postedAt": { "description": "Query operators for postedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "postedFromSlackMessageId": { "description": "Query operators for postedFromSlackMessageId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "savedFromChatMessage": { "description": "Query operators for savedFromChatMessage field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_incident_internal_notes", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "attachments": { "description": "Query operators for attachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "incidentId": { "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "isOwnerNotified": { "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "note": { "description": "Query operators for note field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postedAt": { "description": "Query operators for postedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "postedFromSlackMessageId": { "description": "Query operators for postedFromSlackMessageId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postedWithIncidentStateId": { "description": "Query operators for postedWithIncidentStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "savedFromChatMessage": { "description": "Query operators for savedFromChatMessage field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "shouldStatusPageSubscribersBeNotifiedOnNoteCreated": { "description": "Query operators for shouldStatusPageSubscribersBeNotifiedOnNoteCreated field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "subscriberNotificationStatusMessage": { "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatusMessageOnNoteUpdated": { "description": "Query operators for subscriberNotificationStatusMessageOnNoteUpdated field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatusOnNoteCreated": { "description": "Query operators for subscriberNotificationStatusOnNoteCreated field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "subscriberNotificationStatusOnNoteUpdated": { "description": "Query operators for subscriberNotificationStatusOnNoteUpdated field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_incident_public_notes", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "color": { "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "order": { "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 10 }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_incident_severities", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "endsAt": { "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "incidentId": { "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "incidentStateId": { "description": "Query operators for incidentStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "isOwnerNotified": { "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "rootCause": { "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "shouldStatusPageSubscribersBeNotified": { "description": "Query operators for shouldStatusPageSubscribersBeNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "startsAt": { "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "stateChangeLog": { "description": "Query operators for stateChangeLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatus": { "description": "Query operators for subscriberNotificationStatus field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "subscriberNotificationStatusMessage": { "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_incident_state_timelines", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "color": { "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isAcknowledgedState": { "description": "Query operators for isAcknowledgedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isCreatedState": { "description": "Query operators for isCreatedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isResolvedState": { "description": "Query operators for isResolvedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "order": { "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 10 }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_incident_states", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "aiInvestigationDecision": { "description": "Query operators for aiInvestigationDecision field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "cephClusters": { "description": "Query operators for cephClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "changeMonitorStatusToId": { "description": "Query operators for changeMonitorStatusToId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByProbeId": { "description": "Query operators for createdByProbeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdCriteriaId": { "description": "Query operators for createdCriteriaId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdIncidentTemplateId": { "description": "Query operators for createdIncidentTemplateId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdStateLog": { "description": "Query operators for createdStateLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "currentIncidentStateId": { "description": "Query operators for currentIncidentStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "customFields": { "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "databaseServers": { "description": "Query operators for databaseServers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "declaredAt": { "description": "Query operators for declaredAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerHosts": { "description": "Query operators for dockerHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerResources": { "description": "Query operators for dockerResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerSwarmClusters": { "description": "Query operators for dockerSwarmClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "enableReminders": { "description": "Query operators for enableReminders field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "holdsMonitors": { "description": "Query operators for holdsMonitors field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "hosts": { "description": "Query operators for hosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "impactStartedAt": { "description": "Query operators for impactStartedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "incidentEpisodeId": { "description": "Query operators for incidentEpisodeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "incidentNumber": { "description": "Query operators for incidentNumber field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "incidentNumberWithPrefix": { "description": "Query operators for incidentNumberWithPrefix field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "incidentSeverityId": { "description": "Query operators for incidentSeverityId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "iotFleets": { "description": "Query operators for iotFleets field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isCreatedAutomatically": { "description": "Query operators for isCreatedAutomatically field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isOwnerNotifiedOfResourceCreation": { "description": "Query operators for isOwnerNotifiedOfResourceCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isPrivate": { "description": "Query operators for isPrivate field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isScopedToStatusPages": { "description": "Query operators for isScopedToStatusPages field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isVisibleOnStatusPage": { "description": "Query operators for isVisibleOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "kubernetesClusters": { "description": "Query operators for kubernetesClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "kubernetesContainers": { "description": "Query operators for kubernetesContainers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "kubernetesResources": { "description": "Query operators for kubernetesResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "labels": { "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "monitorSummary": { "description": "Query operators for monitorSummary field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "monitors": { "description": "Query operators for monitors field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "nextReminderNotificationAt": { "description": "Query operators for nextReminderNotificationAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "notifySubscribersOnPostmortemPublished": { "description": "Query operators for notifySubscribersOnPostmortemPublished field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "onCallDutyPolicies": { "description": "Query operators for onCallDutyPolicies field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "podmanHosts": { "description": "Query operators for podmanHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "podmanResources": { "description": "Query operators for podmanResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postUpdatesToWorkspaceChannels": { "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postmortemAttachments": { "description": "Query operators for postmortemAttachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postmortemNote": { "description": "Query operators for postmortemNote field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postmortemPostedAt": { "description": "Query operators for postmortemPostedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "proxmoxClusters": { "description": "Query operators for proxmoxClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "remediationNotes": { "description": "Query operators for remediationNotes field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "reminderNotificationSentCount": { "description": "Query operators for reminderNotificationSentCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "rootCause": { "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "seriesFingerprint": { "description": "Query operators for seriesFingerprint field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "seriesLabels": { "description": "Query operators for seriesLabels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "serviceLevelObjectives": { "description": "Query operators for serviceLevelObjectives field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "services": { "description": "Query operators for services field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "shouldStatusPageSubscribersBeNotifiedOnIncidentCreated": { "description": "Query operators for shouldStatusPageSubscribersBeNotifiedOnIncidentCreated field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showPostmortemOnStatusPage": { "description": "Query operators for showPostmortemOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "statusPages": { "description": "Query operators for statusPages field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "statusPagesNotifiedOnCreation": { "description": "Query operators for statusPagesNotifiedOnCreation field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "storageArrays": { "description": "Query operators for storageArrays field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationClaimedAtOnIncidentCreated": { "description": "Query operators for subscriberNotificationClaimedAtOnIncidentCreated field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "subscriberNotificationClaimedAtOnPostmortemPublished": { "description": "Query operators for subscriberNotificationClaimedAtOnPostmortemPublished field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "subscriberNotificationStatusMessage": { "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatusMessageOnPostmortemPublished": { "description": "Query operators for subscriberNotificationStatusMessageOnPostmortemPublished field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatusOnIncidentCreated": { "description": "Query operators for subscriberNotificationStatusOnIncidentCreated field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "subscriberNotificationStatusOnPostmortemPublished": { "description": "Query operators for subscriberNotificationStatusOnPostmortemPublished field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "telemetryQuery": { "description": "Query operators for telemetryQuery field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "title": { "description": "Query operators for title field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "vmwareVCenters": { "description": "Query operators for vmwareVCenters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_incidents", "outputSchema": null }, { "description": "Count Kubernetes Cost Allocations telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "clusterName": { "description": "clusterName field", "type": "string" }, "containerName": { "description": "containerName field", "type": "string" }, "controllerKind": { "description": "controllerKind field", "type": "string" }, "controllerName": { "description": "controllerName field", "type": "string" }, "cpuCoreHours": { "description": "cpuCoreHours field", "type": "string" }, "cpuCoreLimitAverage": { "description": "cpuCoreLimitAverage field", "type": "string" }, "cpuCoreRequestAverage": { "description": "cpuCoreRequestAverage field", "type": "string" }, "cpuCoreUsageAverage": { "description": "cpuCoreUsageAverage field", "type": "string" }, "cpuCost": { "description": "cpuCost field", "type": "string" }, "cpuEfficiency": { "description": "cpuEfficiency field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "currency": { "description": "currency field", "type": "string" }, "externalCost": { "description": "externalCost field", "type": "string" }, "gpuCost": { "description": "gpuCost field", "type": "string" }, "gpuHours": { "description": "gpuHours field", "type": "string" }, "k8sClusterEntityKey": { "description": "k8sClusterEntityKey field", "type": "string" }, "kubernetesClusterId": { "description": "kubernetesClusterId field", "type": "string" }, "labelKeys": { "description": "labelKeys field", "type": "string" }, "labels": { "description": "labels field", "type": "string" }, "loadBalancerCost": { "description": "loadBalancerCost field", "type": "string" }, "namespace": { "description": "namespace field", "type": "string" }, "networkCost": { "description": "networkCost field", "type": "string" }, "nodeName": { "description": "nodeName field", "type": "string" }, "podName": { "description": "podName field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "providerId": { "description": "providerId field", "type": "string" }, "pvByteHours": { "description": "pvByteHours field", "type": "string" }, "pvCost": { "description": "pvCost field", "type": "string" }, "ramByteHours": { "description": "ramByteHours field", "type": "string" }, "ramBytesLimitAverage": { "description": "ramBytesLimitAverage field", "type": "string" }, "ramBytesRequestAverage": { "description": "ramBytesRequestAverage field", "type": "string" }, "ramBytesUsageAverage": { "description": "ramBytesUsageAverage field", "type": "string" }, "ramBytesUsageMax": { "description": "ramBytesUsageMax field", "type": "string" }, "ramCost": { "description": "ramCost field", "type": "string" }, "ramEfficiency": { "description": "ramEfficiency field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "sharedCost": { "description": "sharedCost field", "type": "string" }, "shipmentChunk": { "description": "shipmentChunk field", "type": "string" }, "shipmentId": { "description": "shipmentId field", "type": "string" }, "totalCost": { "description": "totalCost field", "type": "string" }, "totalEfficiency": { "description": "totalEfficiency field", "type": "string" }, "windowEnd": { "description": "windowEnd field", "type": "string" }, "windowStart": { "description": "windowStart field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "count_kubernetes_cost_allocations", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "color": { "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_labels", "outputSchema": null }, { "description": "Count Logs telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "attributeKeys": { "description": "attributeKeys field", "type": "string" }, "attributes": { "description": "attributes field", "type": "string" }, "body": { "description": "body field", "type": "string" }, "containerEntityKey": { "description": "containerEntityKey field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "droppedAttributesCount": { "description": "droppedAttributesCount field", "type": "string" }, "entityKeys": { "description": "entityKeys field", "type": "string" }, "flags": { "description": "flags field", "type": "string" }, "hostEntityKey": { "description": "hostEntityKey field", "type": "string" }, "k8sClusterEntityKey": { "description": "k8sClusterEntityKey field", "type": "string" }, "k8sNodeEntityKey": { "description": "k8sNodeEntityKey field", "type": "string" }, "k8sPodEntityKey": { "description": "k8sPodEntityKey field", "type": "string" }, "observedTimeUnixNano": { "description": "observedTimeUnixNano field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "serviceEntityKey": { "description": "serviceEntityKey field", "type": "string" }, "sessionId": { "description": "sessionId field", "type": "string" }, "severityNumber": { "description": "severityNumber field", "type": "string" }, "severityText": { "description": "severityText field", "type": "string" }, "spanId": { "description": "spanId field", "type": "string" }, "time": { "description": "time field", "type": "string" }, "timeUnixNano": { "description": "timeUnixNano field", "type": "string" }, "traceId": { "description": "traceId field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "count_logs", "outputSchema": null }, { "description": "Count Metrics telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "aggregationTemporality": { "description": "aggregationTemporality field", "type": "string" }, "attributeKeys": { "description": "attributeKeys field", "type": "string" }, "attributes": { "description": "attributes field", "type": "string" }, "bucketCounts": { "description": "bucketCounts field", "type": "string" }, "containerEntityKey": { "description": "containerEntityKey field", "type": "string" }, "count": { "description": "count field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "entityKeys": { "description": "entityKeys field", "type": "string" }, "explicitBounds": { "description": "explicitBounds field", "type": "string" }, "hostEntityKey": { "description": "hostEntityKey field", "type": "string" }, "isMonotonic": { "description": "isMonotonic field", "type": "string" }, "k8sClusterEntityKey": { "description": "k8sClusterEntityKey field", "type": "string" }, "k8sNodeEntityKey": { "description": "k8sNodeEntityKey field", "type": "string" }, "k8sPodEntityKey": { "description": "k8sPodEntityKey field", "type": "string" }, "max": { "description": "max field", "type": "string" }, "metricPointType": { "description": "metricPointType field", "type": "string" }, "min": { "description": "min field", "type": "string" }, "name": { "description": "name field", "type": "string" }, "negativeBucketCounts": { "description": "negativeBucketCounts field", "type": "string" }, "negativeOffset": { "description": "negativeOffset field", "type": "string" }, "positiveBucketCounts": { "description": "positiveBucketCounts field", "type": "string" }, "positiveOffset": { "description": "positiveOffset field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "scale": { "description": "scale field", "type": "string" }, "serviceEntityKey": { "description": "serviceEntityKey field", "type": "string" }, "spanId": { "description": "spanId field", "type": "string" }, "startTime": { "description": "startTime field", "type": "string" }, "startTimeUnixNano": { "description": "startTimeUnixNano field", "type": "string" }, "sum": { "description": "sum field", "type": "string" }, "summaryQuantiles": { "description": "summaryQuantiles field", "type": "string" }, "summaryValues": { "description": "summaryValues field", "type": "string" }, "time": { "description": "time field", "type": "string" }, "timeUnixNano": { "description": "timeUnixNano field", "type": "string" }, "traceId": { "description": "traceId field", "type": "string" }, "value": { "description": "value field", "type": "string" }, "zeroCount": { "description": "zeroCount field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "count_metrics", "outputSchema": null }, { "description": "Count Monitor Logs telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "logBody": { "description": "logBody field", "type": "string" }, "monitorId": { "description": "monitorId field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "time": { "description": "time field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "count_monitor_logs", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "endsAt": { "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "isOwnerNotified": { "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "monitorId": { "description": "Query operators for monitorId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "monitorStatusId": { "description": "Query operators for monitorStatusId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "rootCause": { "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "startsAt": { "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "statusChangeLog": { "description": "Query operators for statusChangeLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_monitor_status_events", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "color": { "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isOfflineState": { "description": "Query operators for isOfflineState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isOperationalState": { "description": "Query operators for isOperationalState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "priority": { "description": "Query operators for priority field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_monitor_statuses", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "archivedAt": { "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "archivedByUserId": { "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "autoProvisionedNetworkDeviceId": { "description": "Query operators for autoProvisionedNetworkDeviceId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "cephClusters": { "description": "Query operators for cephClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "currentMonitorStatusId": { "description": "Query operators for currentMonitorStatusId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "customFields": { "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "databaseServers": { "description": "Query operators for databaseServers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "dependsOnMonitors": { "description": "Query operators for dependsOnMonitors field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "description": { "description": "Query operators for description field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "disableActiveMonitoring": { "description": "Query operators for disableActiveMonitoring field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "disableActiveMonitoringBecauseOfManualIncident": { "description": "Query operators for disableActiveMonitoringBecauseOfManualIncident field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "disableActiveMonitoringBecauseOfScheduledMaintenanceEvent": { "description": "Query operators for disableActiveMonitoringBecauseOfScheduledMaintenanceEvent field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "dockerHosts": { "description": "Query operators for dockerHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerSwarmClusters": { "description": "Query operators for dockerSwarmClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "hosts": { "description": "Query operators for hosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "incomingEmailCustomLocalPart": { "description": "Query operators for incomingEmailCustomLocalPart field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "incomingEmailMonitorHeartbeatCheckedAt": { "description": "Query operators for incomingEmailMonitorHeartbeatCheckedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "incomingEmailMonitorLastEmailReceivedAt": { "description": "Query operators for incomingEmailMonitorLastEmailReceivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "incomingEmailMonitorRequest": { "description": "Query operators for incomingEmailMonitorRequest field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "incomingEmailSecretKey": { "description": "Query operators for incomingEmailSecretKey field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "incomingMonitorRequest": { "description": "Query operators for incomingMonitorRequest field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "incomingRequestMonitorHeartbeatCheckedAt": { "description": "Query operators for incomingRequestMonitorHeartbeatCheckedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "incomingRequestSecretKey": { "description": "Query operators for incomingRequestSecretKey field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "iotFleets": { "description": "Query operators for iotFleets field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isAllProbesDisconnectedFromThisMonitor": { "description": "Query operators for isAllProbesDisconnectedFromThisMonitor field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isArchived": { "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isNoProbeEnabledOnThisMonitor": { "description": "Query operators for isNoProbeEnabledOnThisMonitor field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isOwnerNotifiedOfResourceCreation": { "description": "Query operators for isOwnerNotifiedOfResourceCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "kubernetesClusters": { "description": "Query operators for kubernetesClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "labels": { "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "minimumProbeAgreement": { "description": "Query operators for minimumProbeAgreement field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "monitorSteps": { "description": "Query operators for monitorSteps field of type Monitor Steps. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "monitorTemplateId": { "description": "Query operators for monitorTemplateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "monitorType": { "description": "Query operators for monitorType field of type Monitor Type. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "monitoringInterval": { "description": "Query operators for monitoringInterval field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "networkAlertPolicyId": { "description": "Query operators for networkAlertPolicyId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "podmanHosts": { "description": "Query operators for podmanHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postUpdatesToWorkspaceChannels": { "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "proxmoxClusters": { "description": "Query operators for proxmoxClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "serverMonitorRequestReceivedAt": { "description": "Query operators for serverMonitorRequestReceivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "serverMonitorResponse": { "description": "Query operators for serverMonitorResponse field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "serverMonitorSecretKey": { "description": "Query operators for serverMonitorSecretKey field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "services": { "description": "Query operators for services field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "storageArrays": { "description": "Query operators for storageArrays field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "suppressAlertsWhenParentMonitorStatuses": { "description": "Query operators for suppressAlertsWhenParentMonitorStatuses field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "telemetryMonitorLastMonitorAt": { "description": "Query operators for telemetryMonitorLastMonitorAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "telemetryMonitorNextMonitorAt": { "description": "Query operators for telemetryMonitorNextMonitorAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "vmwareVCenters": { "description": "Query operators for vmwareVCenters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_monitors", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "archivedAt": { "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "archivedByUserId": { "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "customFields": { "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isArchived": { "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "labels": { "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "postUpdatesToWorkspaceChannels": { "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "repeatPolicyIfNoOneAcknowledges": { "description": "Query operators for repeatPolicyIfNoOneAcknowledges field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "repeatPolicyIfNoOneAcknowledgesNoOfTimes": { "description": "Query operators for repeatPolicyIfNoOneAcknowledgesNoOfTimes field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_on_call_duty_policies", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "cephClusters": { "description": "Query operators for cephClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "changeMonitorStatusToId": { "description": "Query operators for changeMonitorStatusToId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "currentScheduledMaintenanceStateId": { "description": "Query operators for currentScheduledMaintenanceStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "customFields": { "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "databaseServers": { "description": "Query operators for databaseServers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerHosts": { "description": "Query operators for dockerHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerSwarmClusters": { "description": "Query operators for dockerSwarmClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "enableReminders": { "description": "Query operators for enableReminders field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "endsAt": { "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "hosts": { "description": "Query operators for hosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "iotFleets": { "description": "Query operators for iotFleets field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isOwnerNotifiedOfResourceCreation": { "description": "Query operators for isOwnerNotifiedOfResourceCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isVisibleOnStatusPage": { "description": "Query operators for isVisibleOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "kubernetesClusters": { "description": "Query operators for kubernetesClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "labels": { "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "monitors": { "description": "Query operators for monitors field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "networkSites": { "description": "Query operators for networkSites field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "nextReminderNotificationAt": { "description": "Query operators for nextReminderNotificationAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "nextSubscriberNotificationBeforeTheEventAt": { "description": "Query operators for nextSubscriberNotificationBeforeTheEventAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "podmanHosts": { "description": "Query operators for podmanHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postUpdatesToWorkspaceChannels": { "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "proxmoxClusters": { "description": "Query operators for proxmoxClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "reminderNotificationSentCount": { "description": "Query operators for reminderNotificationSentCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "scheduledMaintenanceNumber": { "description": "Query operators for scheduledMaintenanceNumber field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "scheduledMaintenanceNumberWithPrefix": { "description": "Query operators for scheduledMaintenanceNumberWithPrefix field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "sendSubscriberNotificationsOnBeforeTheEvent": { "description": "Query operators for sendSubscriberNotificationsOnBeforeTheEvent field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "services": { "description": "Query operators for services field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "shouldStatusPageSubscribersBeNotifiedOnEventCreated": { "description": "Query operators for shouldStatusPageSubscribersBeNotifiedOnEventCreated field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded": { "description": "Query operators for shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing": { "description": "Query operators for shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "startsAt": { "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "statusPages": { "description": "Query operators for statusPages field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "storageArrays": { "description": "Query operators for storageArrays field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatusMessage": { "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatusOnEventScheduled": { "description": "Query operators for subscriberNotificationStatusOnEventScheduled field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "title": { "description": "Query operators for title field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "vmwareVCenters": { "description": "Query operators for vmwareVCenters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_scheduled_maintenance_events", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "endsAt": { "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "isOwnerNotified": { "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "scheduledMaintenanceId": { "description": "Query operators for scheduledMaintenanceId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "scheduledMaintenanceStateId": { "description": "Query operators for scheduledMaintenanceStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "shouldStatusPageSubscribersBeNotified": { "description": "Query operators for shouldStatusPageSubscribersBeNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "startsAt": { "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "subscriberNotificationStatus": { "description": "Query operators for subscriberNotificationStatus field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "subscriberNotificationStatusMessage": { "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_scheduled_maintenance_state_timelines", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "color": { "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isEndedState": { "description": "Query operators for isEndedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isOngoingState": { "description": "Query operators for isOngoingState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isResolvedState": { "description": "Query operators for isResolvedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isScheduledState": { "description": "Query operators for isScheduledState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "order": { "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 10 }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_scheduled_maintenance_states", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "note": { "description": "Query operators for note field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "securityCaseId": { "description": "Query operators for securityCaseId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_security_case_notes", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "acknowledgedAt": { "description": "Query operators for acknowledgedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "assignedToTeamId": { "description": "Query operators for assignedToTeamId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "assignedToUserId": { "description": "Query operators for assignedToUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "caseNumber": { "description": "Query operators for caseNumber field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "caseNumberWithPrefix": { "description": "Query operators for caseNumberWithPrefix field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "closedAt": { "description": "Query operators for closedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "closedByUserId": { "description": "Query operators for closedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "closingNote": { "description": "Query operators for closingNote field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "containedAt": { "description": "Query operators for containedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "detectionCount": { "description": "Query operators for detectionCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "entities": { "description": "Query operators for entities field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "firstDetectedAt": { "description": "Query operators for firstDetectedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "groupingKey": { "description": "Query operators for groupingKey field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "incidentId": { "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "labels": { "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "lastDetectedAt": { "description": "Query operators for lastDetectedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "mitreTactics": { "description": "Query operators for mitreTactics field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "mitreTechniques": { "description": "Query operators for mitreTechniques field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "priority": { "description": "Query operators for priority field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "source": { "description": "Query operators for source field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "status": { "description": "Query operators for status field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "title": { "description": "Query operators for title field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "verdict": { "description": "Query operators for verdict field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_security_cases", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "detectionRuleId": { "description": "Query operators for detectionRuleId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "entities": { "description": "Query operators for entities field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "eventCount": { "description": "Query operators for eventCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "eventUid": { "description": "Query operators for eventUid field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "fingerprint": { "description": "Query operators for fingerprint field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "fireCount": { "description": "Query operators for fireCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "firstSeenAt": { "description": "Query operators for firstSeenAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "groupValue": { "description": "Query operators for groupValue field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "lastSeenAt": { "description": "Query operators for lastSeenAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "mitreTactics": { "description": "Query operators for mitreTactics field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "mitreTechniques": { "description": "Query operators for mitreTechniques field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "ruleName": { "description": "Query operators for ruleName field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "sampleMessage": { "description": "Query operators for sampleMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "securityCaseId": { "description": "Query operators for securityCaseId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "securityEventConnectionId": { "description": "Query operators for securityEventConnectionId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "severity": { "description": "Query operators for severity field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "source": { "description": "Query operators for source field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "threatIntelFeedId": { "description": "Query operators for threatIntelFeedId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "title": { "description": "Query operators for title field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_security_detections", "outputSchema": null }, { "description": "Count Security Events telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "activityName": { "description": "activityName field", "type": "string" }, "attributeKeys": { "description": "attributeKeys field", "type": "string" }, "attributes": { "description": "attributes field", "type": "string" }, "categoryName": { "description": "categoryName field", "type": "string" }, "categoryUid": { "description": "categoryUid field", "type": "string" }, "className": { "description": "className field", "type": "string" }, "classUid": { "description": "classUid field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "eventUid": { "description": "eventUid field", "type": "string" }, "message": { "description": "message field", "type": "string" }, "mitreTactics": { "description": "mitreTactics field", "type": "string" }, "mitreTechniques": { "description": "mitreTechniques field", "type": "string" }, "observables": { "description": "observables field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "principalHost": { "description": "principalHost field", "type": "string" }, "principalIp": { "description": "principalIp field", "type": "string" }, "principalProcess": { "description": "principalProcess field", "type": "string" }, "principalUser": { "description": "principalUser field", "type": "string" }, "productName": { "description": "productName field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "ruleId": { "description": "ruleId field", "type": "string" }, "ruleName": { "description": "ruleName field", "type": "string" }, "severityId": { "description": "severityId field", "type": "string" }, "severityName": { "description": "severityName field", "type": "string" }, "statusName": { "description": "statusName field", "type": "string" }, "targetHost": { "description": "targetHost field", "type": "string" }, "targetIp": { "description": "targetIp field", "type": "string" }, "targetPort": { "description": "targetPort field", "type": "string" }, "targetResource": { "description": "targetResource field", "type": "string" }, "targetUser": { "description": "targetUser field", "type": "string" }, "time": { "description": "time field", "type": "string" }, "vendorName": { "description": "vendorName field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "count_security_events", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "detectionRuleIds": { "description": "Query operators for detectionRuleIds field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "detectionSource": { "description": "Query operators for detectionSource field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "isEnabled": { "description": "Query operators for isEnabled field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "lastRunAt": { "description": "Query operators for lastRunAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "minimumPriority": { "description": "Query operators for minimumPriority field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "name": { "description": "Query operators for name field of type Name. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "runCount": { "description": "Query operators for runCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "steps": { "description": "Query operators for steps field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "trigger": { "description": "Query operators for trigger field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_security_playbooks", "outputSchema": null }, { "description": "Count Spans telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "attributeKeys": { "description": "attributeKeys field", "type": "string" }, "attributes": { "description": "attributes field", "type": "string" }, "containerEntityKey": { "description": "containerEntityKey field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "durationUnixNano": { "description": "durationUnixNano field", "type": "string" }, "endTime": { "description": "endTime field", "type": "string" }, "endTimeUnixNano": { "description": "endTimeUnixNano field", "type": "string" }, "entityKeys": { "description": "entityKeys field", "type": "string" }, "events": { "description": "events field", "type": "string" }, "hasException": { "description": "hasException field", "type": "string" }, "hostEntityKey": { "description": "hostEntityKey field", "type": "string" }, "isLlmSpan": { "description": "isLlmSpan field", "type": "string" }, "isRootSpan": { "description": "isRootSpan field", "type": "string" }, "k8sClusterEntityKey": { "description": "k8sClusterEntityKey field", "type": "string" }, "k8sNodeEntityKey": { "description": "k8sNodeEntityKey field", "type": "string" }, "k8sPodEntityKey": { "description": "k8sPodEntityKey field", "type": "string" }, "kind": { "description": "kind field", "type": "string" }, "links": { "description": "links field", "type": "string" }, "llmAgentName": { "description": "llmAgentName field", "type": "string" }, "llmCallKind": { "description": "llmCallKind field", "type": "string" }, "llmConversationId": { "description": "llmConversationId field", "type": "string" }, "llmCost": { "description": "llmCost field", "type": "string" }, "llmInputTokens": { "description": "llmInputTokens field", "type": "string" }, "llmIssues": { "description": "llmIssues field", "type": "string" }, "llmOperation": { "description": "llmOperation field", "type": "string" }, "llmOutputTokens": { "description": "llmOutputTokens field", "type": "string" }, "llmRequestModel": { "description": "llmRequestModel field", "type": "string" }, "llmResponseModel": { "description": "llmResponseModel field", "type": "string" }, "llmSystem": { "description": "llmSystem field", "type": "string" }, "llmTeam": { "description": "llmTeam field", "type": "string" }, "llmToolName": { "description": "llmToolName field", "type": "string" }, "llmTotalTokens": { "description": "llmTotalTokens field", "type": "string" }, "llmUserEmail": { "description": "llmUserEmail field", "type": "string" }, "llmUserId": { "description": "llmUserId field", "type": "string" }, "llmUserMessagePreview": { "description": "llmUserMessagePreview field", "type": "string" }, "name": { "description": "name field", "type": "string" }, "parentSpanId": { "description": "parentSpanId field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "serviceEntityKey": { "description": "serviceEntityKey field", "type": "string" }, "sessionId": { "description": "sessionId field", "type": "string" }, "spanId": { "description": "spanId field", "type": "string" }, "startTime": { "description": "startTime field", "type": "string" }, "startTimeUnixNano": { "description": "startTimeUnixNano field", "type": "string" }, "statusCode": { "description": "statusCode field", "type": "string" }, "statusMessage": { "description": "statusMessage field", "type": "string" }, "traceId": { "description": "traceId field", "type": "string" }, "traceState": { "description": "traceState field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "count_spans", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "attachments": { "description": "Query operators for attachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "endAnnouncementAt": { "description": "Query operators for endAnnouncementAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "isOwnerNotified": { "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "monitors": { "description": "Query operators for monitors field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "shouldStatusPageSubscribersBeNotified": { "description": "Query operators for shouldStatusPageSubscribersBeNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showAnnouncementAt": { "description": "Query operators for showAnnouncementAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "statusPages": { "description": "Query operators for statusPages field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatus": { "description": "Query operators for subscriberNotificationStatus field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "subscriberNotificationStatusMessage": { "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatusMessageOnAnnouncementUpdated": { "description": "Query operators for subscriberNotificationStatusMessageOnAnnouncementUpdated field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatusOnAnnouncementUpdated": { "description": "Query operators for subscriberNotificationStatusOnAnnouncementUpdated field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "title": { "description": "Query operators for title field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_status_page_announcements", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "allowSubscribersToChooseEventTypes": { "description": "Query operators for allowSubscribersToChooseEventTypes field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "allowSubscribersToChooseResources": { "description": "Query operators for allowSubscribersToChooseResources field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "allowedSubscriberEmailDomains": { "description": "Query operators for allowedSubscriberEmailDomains field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "archivedAt": { "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "archivedByUserId": { "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "callSmsConfigId": { "description": "Query operators for callSmsConfigId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "copyrightText": { "description": "Query operators for copyrightText field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "coverImageAltText": { "description": "Query operators for coverImageAltText field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "coverImageFileId": { "description": "Query operators for coverImageFileId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "customCSS": { "description": "Query operators for customCSS field of type CSS. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "customFields": { "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "customJavaScript": { "description": "Query operators for customJavaScript field of type JavaSCript. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "defaultBarColor": { "description": "Query operators for defaultBarColor field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "defaultLanguage": { "description": "Query operators for defaultLanguage field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "downtimeMonitorStatuses": { "description": "Query operators for downtimeMonitorStatuses field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "embeddedOverallStatusToken": { "description": "Query operators for embeddedOverallStatusToken field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "enableCustomSubscriberEmailNotificationFooterText": { "description": "Query operators for enableCustomSubscriberEmailNotificationFooterText field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableEmailSubscribers": { "description": "Query operators for enableEmailSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableEmbeddedOverallStatus": { "description": "Query operators for enableEmbeddedOverallStatus field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableMasterPassword": { "description": "Query operators for enableMasterPassword field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableMcpServer": { "description": "Query operators for enableMcpServer field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableMicrosoftTeamsSubscribers": { "description": "Query operators for enableMicrosoftTeamsSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableSearchEngineIndexing": { "description": "Query operators for enableSearchEngineIndexing field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableSlackSubscribers": { "description": "Query operators for enableSlackSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableSmsSubscribers": { "description": "Query operators for enableSmsSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableWebhookSubscribers": { "description": "Query operators for enableWebhookSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enabledLanguages": { "description": "Query operators for enabledLanguages field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "faviconFileId": { "description": "Query operators for faviconFileId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "footerHTML": { "description": "Query operators for footerHTML field of type HTML. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "headerHTML": { "description": "Query operators for headerHTML field of type HTML. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "hidePoweredByOneUptimeBranding": { "description": "Query operators for hidePoweredByOneUptimeBranding field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "ipWhitelist": { "description": "Query operators for ipWhitelist field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isArchived": { "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isOwnerNotifiedOfResourceCreation": { "description": "Query operators for isOwnerNotifiedOfResourceCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isPublicStatusPage": { "description": "Query operators for isPublicStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isReportEnabled": { "description": "Query operators for isReportEnabled field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "labels": { "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "limitSubscribersToPrivateUsers": { "description": "Query operators for limitSubscribersToPrivateUsers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "logoAltText": { "description": "Query operators for logoAltText field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "logoFileId": { "description": "Query operators for logoFileId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "masterPassword": { "description": "Query operators for masterPassword field of type Hashed String. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "masterPasswordSalt": { "description": "Query operators for masterPasswordSalt field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "onlyShowScopedIncidents": { "description": "Query operators for onlyShowScopedIncidents field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "overallUptimePercentPrecision": { "description": "Query operators for overallUptimePercentPrecision field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "overviewPageDescription": { "description": "Query operators for overviewPageDescription field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "pageDescription": { "description": "Query operators for pageDescription field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "pageTitle": { "description": "Query operators for pageTitle field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "privateUserSessionLengthInHours": { "description": "Query operators for privateUserSessionLengthInHours field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "reportDataInDays": { "description": "Query operators for reportDataInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "reportPeriodType": { "description": "Query operators for reportPeriodType field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "reportRecurringInterval": { "description": "Query operators for reportRecurringInterval field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "reportStartDateTime": { "description": "Query operators for reportStartDateTime field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "reportTimezone": { "description": "Query operators for reportTimezone field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "requireSsoForLogin": { "description": "Query operators for requireSsoForLogin field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "sendNextReportBy": { "description": "Query operators for sendNextReportBy field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "sendSubscriberNotifications": { "description": "Query operators for sendSubscriberNotifications field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showAnnouncementHistoryInDays": { "description": "Query operators for showAnnouncementHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "showAnnouncementsOnStatusPage": { "description": "Query operators for showAnnouncementsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showEpisodeHistoryInDays": { "description": "Query operators for showEpisodeHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "showEpisodeLabelsOnStatusPage": { "description": "Query operators for showEpisodeLabelsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showEpisodesOnStatusPage": { "description": "Query operators for showEpisodesOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showIncidentHistoryInDays": { "description": "Query operators for showIncidentHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "showIncidentLabelsOnStatusPage": { "description": "Query operators for showIncidentLabelsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showIncidentsOnStatusPage": { "description": "Query operators for showIncidentsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showOverallUptimePercentOnStatusPage": { "description": "Query operators for showOverallUptimePercentOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showScheduledEventHistoryInDays": { "description": "Query operators for showScheduledEventHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "showScheduledEventLabelsOnStatusPage": { "description": "Query operators for showScheduledEventLabelsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showScheduledMaintenanceEventsOnStatusPage": { "description": "Query operators for showScheduledMaintenanceEventsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showSubscriberPageOnStatusPage": { "description": "Query operators for showSubscriberPageOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showUptimeHistoryInDays": { "description": "Query operators for showUptimeHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "smtpConfigId": { "description": "Query operators for smtpConfigId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "subscriberEmailNotificationFooterText": { "description": "Query operators for subscriberEmailNotificationFooterText field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberTimezones": { "description": "Query operators for subscriberTimezones field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "theme": { "description": "Query operators for theme field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_status_pages", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "customFields": { "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isPermissionsEditable": { "description": "Query operators for isPermissionsEditable field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isTeamDeleteable": { "description": "Query operators for isTeamDeleteable field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isTeamEditable": { "description": "Query operators for isTeamEditable field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "shouldHaveAtLeastOneMember": { "description": "Query operators for shouldHaveAtLeastOneMember field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" } }, "type": "object" }, "name": "count_teams", "outputSchema": null }, { "description": "Count Threat Intel Indicators telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.", "inputSchema": { "additionalProperties": false, "properties": { "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "confidence": { "description": "confidence field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "feedId": { "description": "feedId field", "type": "string" }, "feedName": { "description": "feedName field", "type": "string" }, "indicatorName": { "description": "indicatorName field", "type": "string" }, "indicatorType": { "description": "indicatorType field", "type": "string" }, "indicatorValue": { "description": "indicatorValue field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "revoked": { "description": "revoked field", "type": "string" }, "stixId": { "description": "stixId field", "type": "string" }, "stixLabels": { "description": "stixLabels field", "type": "string" }, "validFrom": { "description": "validFrom field", "type": "string" }, "validUntil": { "description": "validUntil field", "type": "string" }, "version": { "description": "version field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "count_threat_intel_indicators", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "alertSeverityId": { "description": "Alert Severity ID.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "cephClusters": { "description": "List of Ceph clusters affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "currentAlertStateId": { "description": "Current Alert State ID.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "customFields": { "description": "Custom Fields on this resource.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "databaseServers": { "description": "List of databases affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "Short description of this alert. This will be visible on the status page. This is in markdown.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "dockerHosts": { "description": "List of Docker hosts affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "dockerResources": { "description": "List of Docker resources (containers, images, networks, volumes) affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "dockerSwarmClusters": { "description": "List of Docker Swarm clusters affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "enableReminders": { "default": 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.", "example": true, "type": "boolean" }, "hosts": { "description": "List of hosts affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "impactStartedAt": { "description": "When customer impact actually began. Left blank until someone records it - never inferred, because a guessed value is worse than no value.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "iotFleets": { "description": "List of IoT fleets affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "isPrivate": { "default": false, "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.", "example": true, "type": "boolean" }, "kubernetesClusters": { "description": "List of Kubernetes clusters affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "kubernetesContainers": { "description": "List of Kubernetes containers affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "kubernetesResources": { "description": "List of Kubernetes resources (pods, deployments, nodes, etc.) affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "labels": { "description": "Relation to Labels Array where this object is categorized in.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "monitorId": { "description": "ID of the monitor this alert belongs to.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "monitorStatusWhenThisAlertWasCreatedId": { "description": "Monitor Status ID when this alert was created.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "onCallDutyPolicies": { "description": "List of on-call duty policies affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "podmanHosts": { "description": "List of Podman hosts affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "podmanResources": { "description": "List of Podman resources (containers, images, networks, volumes) affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "proxmoxClusters": { "description": "List of Proxmox clusters affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "remediationNotes": { "description": "Notes on how to remediate this alert. This is in markdown.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "rootCause": { "description": "What is the root cause of this alert?", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "serviceLevelObjectives": { "description": "List of Service Level Objectives (SLOs) affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "services": { "description": "List of services affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "storageArrays": { "description": "List of storage arrays affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "telemetryQuery": { "description": "Telemetry query for this alert.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "title": { "description": "Title of this alert.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "vmwareVCenters": { "description": "List of vCenters affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "title", "alertSeverityId" ], "type": "object" }, "name": "create_alert", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "alertId": { "description": "Relation to Alert ID in which this resource belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "attachments": { "description": "Files attached to this note.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "note": { "description": "Notes in markdown.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "postedAt": { "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.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "postedFromSlackMessageId": { "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.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" } }, "required": [ "alertId" ], "type": "object" }, "name": "create_alert_internal_note", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "color": { "description": "Color of this resource in Hex (#32a852 for example).", "example": { "_type": "Color", "value": "#ff0000" }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "order": { "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.", "example": 10, "type": "integer" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" } }, "required": [ "name", "color" ], "type": "object" }, "name": "create_alert_severity", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "color": { "description": "Color of this resource in Hex (#32a852 for example).", "example": { "_type": "Color", "value": "#ff0000" }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "isAcknowledgedState": { "description": "Is it the acknowledged state of the alert?", "example": true, "type": "boolean" }, "isCreatedState": { "description": "Is it the created state of the alert?", "example": true, "type": "boolean" }, "isResolvedState": { "description": "Is it the resolved state of the alert?", "example": true, "type": "boolean" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "order": { "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.", "example": 10, "type": "integer" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" } }, "required": [ "name", "color" ], "type": "object" }, "name": "create_alert_state", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "alertId": { "description": "Relation to Alert ID in which this resource belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "alertStateId": { "description": "Alert State ID Relation. Which alert state does this alert change to?", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "endsAt": { "description": "When did this status change end?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "rootCause": { "description": "What is the root cause of this status change?", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "startsAt": { "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.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" } }, "required": [ "alertId", "alertStateId" ], "type": "object" }, "name": "create_alert_state_timeline", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "cephClusters": { "description": "List of Ceph clusters affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "changeMonitorStatusToId": { "description": "Relation to Monitor Status Object ID. All monitors connected to this incident will be changed to this status when the incident is created.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "currentIncidentStateId": { "description": "Current Incident State ID.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "customFields": { "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.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "databaseServers": { "description": "List of databases affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "declaredAt": { "description": "Date and time when this incident was declared.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "description": { "description": "Short description of this incident. This is in markdown and will be visible on the status page.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "dockerHosts": { "description": "List of Docker hosts affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "dockerResources": { "description": "List of Docker resources (containers, images, networks, volumes) affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "dockerSwarmClusters": { "description": "List of Docker Swarm clusters affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "enableReminders": { "default": 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.", "example": true, "type": "boolean" }, "hosts": { "description": "List of hosts affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "impactStartedAt": { "description": "When customer impact actually began. Left blank until someone records it - never inferred, because a guessed value is worse than no value.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "incidentSeverityId": { "description": "Incident Severity ID.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "iotFleets": { "description": "List of IoT fleets affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "isPrivate": { "default": false, "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.", "example": true, "type": "boolean" }, "isVisibleOnStatusPage": { "default": true, "description": "Should this incident be visible on the status page?", "example": true, "type": "boolean" }, "kubernetesClusters": { "description": "List of Kubernetes clusters affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "kubernetesContainers": { "description": "List of Kubernetes containers affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "kubernetesResources": { "description": "List of Kubernetes resources (pods, deployments, nodes, etc.) affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "labels": { "description": "Relation to Labels Array where this object is categorized in.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "monitors": { "description": "List of monitors affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "notifySubscribersOnPostmortemPublished": { "default": true, "description": "Should subscribers be notified when the postmortem is published?", "example": true, "type": "boolean" }, "onCallDutyPolicies": { "description": "List of on-call duty policies affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "podmanHosts": { "description": "List of Podman hosts affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "podmanResources": { "description": "List of Podman resources (containers, images, networks, volumes) affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "postmortemAttachments": { "description": "Files that accompany the postmortem note and can be shared publicly when enabled.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "postmortemNote": { "description": "Document the postmortem summary for this incident.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "postmortemPostedAt": { "description": "Timestamp that will be shown alongside the published postmortem on the status page.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "proxmoxClusters": { "description": "List of Proxmox clusters affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "remediationNotes": { "description": "Notes on how to remediate this incident. This is in markdown.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "rootCause": { "description": "What is the root cause of this incident?", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "serviceLevelObjectives": { "description": "List of Service Level Objectives (SLOs) affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "services": { "description": "List of services affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "shouldStatusPageSubscribersBeNotifiedOnIncidentCreated": { "default": true, "description": "Should subscribers be notified about this incident?", "example": true, "type": "boolean" }, "showPostmortemOnStatusPage": { "default": false, "description": "Should the postmortem note and attachments be visible on the status page once published?", "example": true, "type": "boolean" }, "statusPages": { "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.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "storageArrays": { "description": "List of storage arrays affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "telemetryQuery": { "description": "Telemetry query for this incident.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "title": { "description": "Title of this incident.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "vmwareVCenters": { "description": "List of vCenters affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "title", "incidentSeverityId" ], "type": "object" }, "name": "create_incident", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "alertId": { "description": "ID of the Alert that is linked to the incident.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "incidentId": { "description": "ID of the Incident this alert is linked to.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" } }, "required": [ "incidentId", "alertId" ], "type": "object" }, "name": "create_incident_alert", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "attachments": { "description": "Files attached to this note.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "incidentId": { "description": "Relation to Incident ID in which this resource belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "note": { "description": "Notes in markdown.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "postedAt": { "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.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "postedFromSlackMessageId": { "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.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" } }, "required": [ "incidentId" ], "type": "object" }, "name": "create_incident_internal_note", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "attachments": { "description": "Files attached to this note.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "incidentId": { "description": "Relation to Incident ID in which this resource belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "note": { "description": "Notes in markdown.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "postedAt": { "description": "Date and time when the note was posted.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "postedFromSlackMessageId": { "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.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "shouldStatusPageSubscribersBeNotifiedOnNoteCreated": { "description": "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.", "example": true, "type": "boolean" } }, "required": [ "incidentId" ], "type": "object" }, "name": "create_incident_public_note", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "color": { "description": "Color of this resource in Hex (#32a852 for example).", "example": { "_type": "Color", "value": "#ff0000" }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "order": { "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.", "example": 10, "type": "integer" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" } }, "required": [ "name", "color" ], "type": "object" }, "name": "create_incident_severity", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "color": { "description": "Color of this resource in Hex (#32a852 for example).", "example": { "_type": "Color", "value": "#ff0000" }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "isAcknowledgedState": { "description": "Is it the acknowledged state of the incident?", "example": true, "type": "boolean" }, "isCreatedState": { "description": "Is it the created state of the incident?", "example": true, "type": "boolean" }, "isResolvedState": { "description": "Is it the resolved state of the incident?", "example": true, "type": "boolean" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "order": { "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.", "example": 10, "type": "integer" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" } }, "required": [ "name", "color" ], "type": "object" }, "name": "create_incident_state", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "endsAt": { "description": "When did this status change end?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "incidentId": { "description": "Relation to Incident ID in which this resource belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "incidentStateId": { "description": "Incident State ID Relation. Which incident state does this incident change to?", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "rootCause": { "description": "What is the root cause of this status change?", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "shouldStatusPageSubscribersBeNotified": { "default": true, "description": "Should subscribers be notified about this state change?", "example": true, "type": "boolean" }, "startsAt": { "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.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" } }, "required": [ "incidentId", "incidentStateId" ], "type": "object" }, "name": "create_incident_state_timeline", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "color": { "description": "Color of this resource in Hex (#32a852 for example).", "example": { "_type": "Color", "value": "#ff0000" }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" } }, "required": [ "name", "color" ], "type": "object" }, "name": "create_label", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "cephClusters": { "description": "Ceph clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "currentMonitorStatusId": { "description": "Whats the current status ID of this monitor?", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "customFields": { "description": "Custom Fields on this resource.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "databaseServers": { "description": "Databases this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "dependsOnMonitors": { "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.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "Friendly description that will help you remember.", "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.", "type": "string" }, "disableActiveMonitoring": { "default": false, "description": "Disable active monitoring for this resource?", "example": true, "type": "boolean" }, "dockerHosts": { "description": "Docker hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "dockerSwarmClusters": { "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.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "hosts": { "description": "Hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "incomingMonitorRequest": { "description": "Incoming Monitor Request for Incoming Request Monitor.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "incomingRequestMonitorHeartbeatCheckedAt": { "description": "This field is for Incoming Request monitor only. When was the last time we checked the heartbeat?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "iotFleets": { "description": "IoT fleets this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "isArchived": { "default": false, "description": "Archived monitors are hidden from monitor lists and status pages, are not checked, and open no incidents or alerts. Unarchiving resumes monitoring.", "example": true, "type": "boolean" }, "kubernetesClusters": { "description": "Kubernetes clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "labels": { "description": "Relation to Labels Array where this object is categorized in.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "minimumProbeAgreement": { "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.", "example": 42, "type": "number" }, "monitorSteps": { "description": "What would you like to monitor and what is the criteria?", "example": { "_type": "MonitorSteps", "value": { "monitorStepsInstanceArray": [] } }, "type": "object" }, "monitorTemplateId": { "description": "ID of the Monitor Template this monitor was created from. Null for monitors not created from a template.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "monitorType": { "description": "What is the type of this monitor? Website? API? etc.", "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" ], "example": "HTTP", "type": "string" }, "monitoringInterval": { "description": "How often would you like OneUptime to monitor this resource? A 5-field cron expression, not a label: \"*/5 * * * *\" is every five minutes.", "example": "Example short text", "type": "string" }, "name": { "description": "Any friendly name for this monitor.", "example": "Example short text", "type": "string" }, "podmanHosts": { "description": "Podman hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "proxmoxClusters": { "description": "Proxmox clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "serverMonitorRequestReceivedAt": { "description": "This field is for Server Monitor only. When was the last time we received a request?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "serverMonitorResponse": { "description": "Server Monitor Response for Server Monitor.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "services": { "description": "Services this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "storageArrays": { "description": "Storage arrays this monitor watches. Incidents and alerts it creates are linked to them.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "suppressAlertsWhenParentMonitorStatuses": { "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.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "telemetryMonitorLastMonitorAt": { "description": "This field is for Telemetry Monitor only. When was the last time we monitored?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "telemetryMonitorNextMonitorAt": { "description": "This field is for Telemetry Monitor only. When is the next time we should monitor?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "vmwareVCenters": { "description": "VMware vCenters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "name", "monitorType" ], "type": "object" }, "name": "create_monitor", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "color": { "description": "Color of this resource in Hex (#32a852 for example).", "example": { "_type": "Color", "value": "#ff0000" }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "isOfflineState": { "default": false, "description": "Is this monitor in offline state?", "example": true, "type": "boolean" }, "isOperationalState": { "default": false, "description": "Is this monitor in operational state?", "example": true, "type": "boolean" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "priority": { "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.", "example": 42, "type": "number" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" } }, "required": [ "name", "color" ], "type": "object" }, "name": "create_monitor_status", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "endsAt": { "description": "When did this status change end?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "monitorId": { "description": "Relation to Monitor ID Resource in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "monitorStatusId": { "description": "Relation to Monitor Status ID Resource in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "rootCause": { "description": "What is the root cause of this status change?", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "startsAt": { "description": "When did this status change?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" } }, "required": [ "monitorId", "monitorStatusId" ], "type": "object" }, "name": "create_monitor_status_event", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "customFields": { "description": "Custom Fields on this resource.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "isArchived": { "default": false, "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.", "example": true, "type": "boolean" }, "labels": { "description": "Relation to Labels Array where this object is categorized in.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "repeatPolicyIfNoOneAcknowledges": { "default": false, "description": "Repeat the policy if no one acknowledges the alert.", "example": true, "type": "boolean" }, "repeatPolicyIfNoOneAcknowledgesNoOfTimes": { "default": 0, "description": "Repeat the policy X number of times if no one acknowledges the alert.", "example": 42, "type": "number" } }, "required": [ "name" ], "type": "object" }, "name": "create_on_call_policy", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "cephClusters": { "description": "List of Ceph clusters affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "changeMonitorStatusToId": { "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.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "currentScheduledMaintenanceStateId": { "description": "Scheduled Maintenance State ID. The state the event currently is in.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "customFields": { "description": "Custom Fields on this resource.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "databaseServers": { "description": "List of databases affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "Description of this scheduled event that will show up on Status Page. This is in markdown.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "dockerHosts": { "description": "List of Docker hosts affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "dockerSwarmClusters": { "description": "List of Docker Swarm clusters affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "enableReminders": { "default": 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.", "example": true, "type": "boolean" }, "endsAt": { "description": "When does this event end?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "hosts": { "description": "List of hosts affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "iotFleets": { "description": "List of IoT fleets affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "isVisibleOnStatusPage": { "default": true, "description": "Should this incident be visible on the status page?", "example": true, "type": "boolean" }, "kubernetesClusters": { "description": "List of Kubernetes clusters affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "labels": { "description": "Relation to Labels Array where this object is categorized in.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "monitors": { "description": "List of monitors attached to this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "networkSites": { "description": "List of network sites affected by this event. Their descendants are covered too.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "nextSubscriberNotificationBeforeTheEventAt": { "description": "When will the next notification to subscribers be sent out?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "podmanHosts": { "description": "List of Podman hosts affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "proxmoxClusters": { "description": "List of Proxmox clusters affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "sendSubscriberNotificationsOnBeforeTheEvent": { "description": "Should subscribers be notified before the event?", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "services": { "description": "List of services affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "shouldStatusPageSubscribersBeNotifiedOnEventCreated": { "default": true, "description": "Should subscribers be notified about this event creation?", "example": true, "type": "boolean" }, "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded": { "default": true, "description": "Should subscribers be notified about this event event is changed to ended?", "example": true, "type": "boolean" }, "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing": { "default": true, "description": "Should subscribers be notified about this event event is changed to ongoing?", "example": true, "type": "boolean" }, "startsAt": { "description": "When does this event start?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "statusPages": { "description": "List of status pages to show this event on.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "storageArrays": { "description": "List of storage arrays affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "title": { "description": "Title of this scheduled event.", "example": "Example short text", "type": "string" }, "vmwareVCenters": { "description": "List of vCenters affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "title", "startsAt", "endsAt" ], "type": "object" }, "name": "create_scheduled_maintenance_event", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "color": { "description": "Color of this resource in Hex (#32a852 for example).", "example": { "_type": "Color", "value": "#ff0000" }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "isEndedState": { "default": false, "description": "Is this state a ended state?", "example": true, "type": "boolean" }, "isOngoingState": { "default": false, "description": "Is this state a ongoing state?", "example": true, "type": "boolean" }, "isResolvedState": { "default": false, "description": "Is this state a resolved state?", "example": true, "type": "boolean" }, "isScheduledState": { "default": false, "description": "Is this state a scheduled state?", "example": true, "type": "boolean" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "order": { "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.", "example": 10, "type": "integer" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" } }, "required": [ "name", "color" ], "type": "object" }, "name": "create_scheduled_maintenance_state", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "endsAt": { "description": "When did this status change end?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "scheduledMaintenanceId": { "description": "ID of Scheduled Maintenance this resource belongs to.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "scheduledMaintenanceStateId": { "description": " Scheduled Maintenance State ID. Which state does this event belongs to?", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "shouldStatusPageSubscribersBeNotified": { "description": "Should subscribers be notified about this state change?", "example": true, "type": "boolean" }, "startsAt": { "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.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" } }, "required": [ "scheduledMaintenanceId", "scheduledMaintenanceStateId" ], "type": "object" }, "name": "create_scheduled_maintenance_state_timeline", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "assignedToTeamId": { "description": "ID of the team whose queue the case is in.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "assignedToUserId": { "description": "ID of the person working the case.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "closingNote": { "description": "Why the case was closed the way it was, in Markdown: what was found and what was done.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "description": { "description": "What is known about the threat, in Markdown. A case opened by a detection starts with the detection's description.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "entities": { "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.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "labels": { "description": "Labels to filter and report on cases by.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "mitreTactics": { "description": "ATT&CK tactic ids (TA0006) the case's detections are tagged with.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "mitreTechniques": { "description": "ATT&CK technique ids (T1110) the case's detections are tagged with.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "priority": { "default": "Medium", "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.", "example": "Example short text", "type": "string" }, "projectId": { "description": "ID of the project this case belongs to.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "status": { "default": "New", "description": "New, Investigating, Contained or Closed. Every case starts New; closing it records a verdict.", "example": "Example short text", "type": "string" }, "title": { "description": "What the case is about, in a line.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "verdict": { "description": "What the case turned out to be, set when it is closed: True Positive, Benign Positive, False Positive or Undetermined.", "example": "Example short text", "type": "string" } }, "required": [ "title" ], "type": "object" }, "name": "create_security_case", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "note": { "description": "The note, in Markdown.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "projectId": { "description": "ID of the project this note belongs to.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "securityCaseId": { "description": "ID of the case this note is on.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" } }, "required": [ "securityCaseId", "note" ], "type": "object" }, "name": "create_security_case_note", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": {}, "required": [], "type": "object" }, "name": "create_security_detection", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "description": { "description": "When to use the playbook and what it is for.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "detectionRuleIds": { "description": "Run only on cases with a detection from one of these detection rules. Empty runs on cases from any rule.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "detectionSource": { "description": "Run only on cases raised by this source: a Detection Rule, Threat Intel or a Connected Product. Empty runs on every source.", "example": "Example short text", "type": "string" }, "isEnabled": { "default": true, "description": "Whether the playbook runs on its own. A disabled playbook can still be run by hand from a case.", "example": true, "type": "boolean" }, "minimumPriority": { "description": "Run only on cases at this priority or above. Empty runs on every priority.", "example": "Example short text", "type": "string" }, "name": { "description": "What the playbook does, in a few words.", "example": { "_type": "Name", "value": "John Doe" }, "type": "object" }, "projectId": { "description": "ID of the project this playbook belongs to.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "steps": { "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.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "trigger": { "default": "Case Opened", "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).", "example": "Example short text", "type": "string" } }, "required": [ "name" ], "type": "object" }, "name": "create_security_playbook", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "allowSubscribersToChooseEventTypes": { "default": false, "description": "Can subscribers choose which event type like Announcements, Incidents, Scheduled Events to subscribe to?", "example": true, "type": "boolean" }, "allowSubscribersToChooseResources": { "default": false, "description": "Can subscribers choose which resources to subscribe to?", "example": true, "type": "boolean" }, "allowedSubscriberEmailDomains": { "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.", "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.", "type": "string" }, "callSmsConfigId": { "description": "ID of your Call/SMS Config Resource which is used to send SMS to subscribers.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "copyrightText": { "description": "Copyright Text.", "example": "Example short text", "type": "string" }, "coverImageAltText": { "description": "Alternative text for the cover image, read by screen readers for accessibility. Leave blank if the cover image is purely decorative.", "example": "Example short text", "type": "string" }, "coverImageFileId": { "description": "Status Page Cover Image ID.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "customCSS": { "description": "Status Page Custom CSS. Served only from a verified custom domain.", "example": "body { color: #333; margin: 0; }", "type": "string" }, "customFields": { "description": "Custom Fields on this resource.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "customJavaScript": { "description": "Status Page Custom JavaScript. This runs when the status page is loaded from a verified custom domain.", "example": "function example() { return true; }", "type": "string" }, "defaultBarColor": { "description": "Default color of the bar on the overview page.", "example": { "_type": "Color", "value": "#ff0000" }, "type": "object" }, "defaultLanguage": { "default": "en", "description": "Default language that the status page is shown in when a visitor arrives for the first time.", "example": "Example short text", "type": "string" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "embeddedOverallStatusToken": { "description": "Security token required to access the embedded overall status badge. This token must be provided in the URL.", "example": "Example short text", "type": "string" }, "enableCustomSubscriberEmailNotificationFooterText": { "default": false, "description": "Enable custom footer text in subscriber email notifications.", "example": true, "type": "boolean" }, "enableEmailSubscribers": { "default": true, "description": "Can email subscribers subscribe to this Status Page?", "example": true, "type": "boolean" }, "enableEmbeddedOverallStatus": { "default": false, "description": "Enable embedded overall status badge that can be displayed on external websites?", "example": true, "type": "boolean" }, "enableMasterPassword": { "default": false, "description": "Require visitors to enter a master password before viewing a private status page.", "example": true, "type": "boolean" }, "enableMcpServer": { "default": 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.", "example": true, "type": "boolean" }, "enableMicrosoftTeamsSubscribers": { "default": false, "description": "Can Microsoft Teams subscribers subscribe to this Status Page?", "example": true, "type": "boolean" }, "enableSearchEngineIndexing": { "default": 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.", "example": true, "type": "boolean" }, "enableSlackSubscribers": { "default": false, "description": "Can Slack subscribers subscribe to this Status Page?", "example": true, "type": "boolean" }, "enableSmsSubscribers": { "default": false, "description": "Can SMS subscribers subscribe to this Status Page?", "example": true, "type": "boolean" }, "enableWebhookSubscribers": { "default": false, "description": "Can Webhook subscribers subscribe to this Status Page?", "example": true, "type": "boolean" }, "enabledLanguages": { "description": "Languages offered in the footer language switcher. Leave empty to offer all supported languages.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "faviconFileId": { "description": "Status Page Favicon File ID.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "footerHTML": { "description": "Status Page Custom HTML Footer. Served only from a verified custom domain.", "example": "<div><h1>Title</h1><p>Content</p></div>", "type": "string" }, "headerHTML": { "description": "Status Page Custom HTML Header. Served only from a verified custom domain.", "example": "<div><h1>Title</h1><p>Content</p></div>", "type": "string" }, "hidePoweredByOneUptimeBranding": { "default": false, "description": "Hide Powered By OneUptime Branding?", "example": true, "type": "boolean" }, "ipWhitelist": { "description": "IP Whitelist for this Status Page. One IP per line. Only used if the status page is private.", "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.", "type": "string" }, "isArchived": { "default": false, "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.", "example": true, "type": "boolean" }, "isPublicStatusPage": { "default": true, "description": "Is this status page public?", "example": true, "type": "boolean" }, "isReportEnabled": { "default": false, "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.", "example": true, "type": "boolean" }, "labels": { "description": "Relation to Labels Array where this object is categorized in.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "limitSubscribersToPrivateUsers": { "default": false, "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.", "example": true, "type": "boolean" }, "logoAltText": { "description": "Alternative text for the logo image, read by screen readers for accessibility.", "example": "Example short text", "type": "string" }, "logoFileId": { "description": "Status Page Logo File ID.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "masterPassword": { "description": "Password required to unlock a private status page. This value is stored as a secure hash.", "example": "hashed_string_value", "format": "password", "type": "string" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "onlyShowScopedIncidents": { "default": false, "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.", "example": true, "type": "boolean" }, "overallUptimePercentPrecision": { "default": "99.99% (Two Decimal)", "description": "Overall Precision of uptime percent for this status page.", "example": "Example short text", "type": "string" }, "overviewPageDescription": { "description": "Overview Page description for your status page. This is a markdown field.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "pageDescription": { "description": "Description of your Status Page. This is used for SEO.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "pageTitle": { "description": "Title of your Status Page. This is used for SEO.", "example": "Example short text", "type": "string" }, "privateUserSessionLengthInHours": { "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.", "example": 42, "type": "number" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "reportDataInDays": { "default": 30, "description": "How many days of data should be included in the report?", "example": 42, "type": "number" }, "reportPeriodType": { "default": "Rolling", "description": "Should the report cover a rolling number of days, or the previous whole calendar period?", "example": "Example short text", "type": "string" }, "reportRecurringInterval": { "description": "How often a report goes out. Left out when reports are turned on, it is every month.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "reportStartDateTime": { "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.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "reportTimezone": { "default": "UTC", "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.", "example": "Example short text", "type": "string" }, "requireSsoForLogin": { "default": false, "description": "Should SSO be required to login to Private Status Page.", "example": true, "type": "boolean" }, "sendNextReportBy": { "description": "When the next report goes out. The server works it out from the schedule.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "sendSubscriberNotifications": { "default": 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.", "example": true, "type": "boolean" }, "showAnnouncementHistoryInDays": { "default": 14, "description": "How many days of announcement history should be shown on the status page (in days)?", "example": 42, "type": "number" }, "showAnnouncementsOnStatusPage": { "default": true, "description": "Show Announcements on Status Page?", "example": true, "type": "boolean" }, "showEpisodeHistoryInDays": { "default": 14, "description": "How many days of episode history to show on the status page.", "example": 42, "type": "number" }, "showEpisodeLabelsOnStatusPage": { "default": false, "description": "Show Episode Labels on Status Page?", "example": true, "type": "boolean" }, "showEpisodesOnStatusPage": { "default": true, "description": "Show Incident Episodes on Status Page?", "example": true, "type": "boolean" }, "showIncidentHistoryInDays": { "default": 14, "description": "How many days of incident history should be shown on the status page (in days)?", "example": 42, "type": "number" }, "showIncidentLabelsOnStatusPage": { "default": false, "description": "Show Incident Labels on Status Page?", "example": true, "type": "boolean" }, "showIncidentsOnStatusPage": { "default": true, "description": "Show Incidents on Status Page?", "example": true, "type": "boolean" }, "showOverallUptimePercentOnStatusPage": { "default": false, "description": "Show Overall Uptime Percent on Status Page?", "example": true, "type": "boolean" }, "showScheduledEventHistoryInDays": { "default": 14, "description": "How many days of scheduled event history should be shown on the status page (in days)?", "example": 42, "type": "number" }, "showScheduledEventLabelsOnStatusPage": { "default": false, "description": "Show Scheduled Event Labels on Status Page?", "example": true, "type": "boolean" }, "showScheduledMaintenanceEventsOnStatusPage": { "default": true, "description": "Show Scheduled Maintenance Events on Status Page?", "example": true, "type": "boolean" }, "showSubscriberPageOnStatusPage": { "default": true, "description": "Show Subscriber Page on Status Page?", "example": true, "type": "boolean" }, "showUptimeHistoryInDays": { "default": 90, "description": "How many days of uptime history should be shown on the status page? Maximum is 90 days.", "example": 42, "type": "number" }, "smtpConfigId": { "description": "ID of your SMTP Config Resource which is used to send email to subscribers.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "subscriberEmailNotificationFooterText": { "description": "Text to send to subscribers in the footer of the email.", "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.", "type": "string" }, "subscriberTimezones": { "description": "Timezones of subscribers to this status page.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "theme": { "default": "Light", "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.", "example": "Example short text", "type": "string" } }, "required": [ "name" ], "type": "object" }, "name": "create_status_page", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "attachments": { "description": "Files attached to this announcement.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "Text of the announcement. This can be in Markdown format.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "endAnnouncementAt": { "description": "When should this announcement hidden?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "monitors": { "description": "List of monitors affected by this announcement. If none are selected, all subscribers will be notified.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "shouldStatusPageSubscribersBeNotified": { "default": true, "description": "Should subscribers be notified about this announcement?", "example": true, "type": "boolean" }, "showAnnouncementAt": { "description": "When should this announcement be shown?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "statusPages": { "description": "Status Pages to show show this announcement on.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "title": { "description": "Title of this resource.", "example": "Example short text", "type": "string" } }, "required": [ "title", "showAnnouncementAt", "description" ], "type": "object" }, "name": "create_status_page_announcement", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "customFields": { "description": "Custom Fields on this resource.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "projectId": { "description": "ID of your OneUptime Project in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" } }, "required": [ "name" ], "type": "object" }, "name": "create_team", "outputSchema": null }, { "description": "Permanently delete a Alert from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Alert to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_alert", "outputSchema": null }, { "description": "Permanently delete a Alert Internal Note from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Alert Internal Note to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_alert_internal_note", "outputSchema": null }, { "description": "Permanently delete a Alert Severity from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Alert Severity to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_alert_severity", "outputSchema": null }, { "description": "Permanently delete a Alert State from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Alert State to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_alert_state", "outputSchema": null }, { "description": "Permanently delete a Alert State Timeline from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Alert State Timeline to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_alert_state_timeline", "outputSchema": null }, { "description": "Permanently delete a Incident from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Incident to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_incident", "outputSchema": null }, { "description": "Permanently delete a Incident Alert from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Incident Alert to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_incident_alert", "outputSchema": null }, { "description": "Permanently delete a Incident Internal Note from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Incident Internal Note to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_incident_internal_note", "outputSchema": null }, { "description": "Permanently delete a Incident Public Note from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Incident Public Note to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_incident_public_note", "outputSchema": null }, { "description": "Permanently delete a Incident Severity from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Incident Severity to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_incident_severity", "outputSchema": null }, { "description": "Permanently delete a Incident State from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Incident State to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_incident_state", "outputSchema": null }, { "description": "Permanently delete a Incident State Timeline from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Incident State Timeline to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_incident_state_timeline", "outputSchema": null }, { "description": "Permanently delete a Label from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Label to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_label", "outputSchema": null }, { "description": "Permanently delete a Monitor from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Monitor to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_monitor", "outputSchema": null }, { "description": "Permanently delete a Monitor Status from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Monitor Status to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_monitor_status", "outputSchema": null }, { "description": "Permanently delete a Monitor Status Event from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Monitor Status Event to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_monitor_status_event", "outputSchema": null }, { "description": "Permanently delete a On-Call Policy from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the On-Call Policy to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_on_call_policy", "outputSchema": null }, { "description": "Permanently delete a Scheduled Maintenance Event from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Scheduled Maintenance Event to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_scheduled_maintenance_event", "outputSchema": null }, { "description": "Permanently delete a Scheduled Maintenance State from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Scheduled Maintenance State to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_scheduled_maintenance_state", "outputSchema": null }, { "description": "Permanently delete a Scheduled Maintenance State Timeline from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Scheduled Maintenance State Timeline to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_scheduled_maintenance_state_timeline", "outputSchema": null }, { "description": "Permanently delete a Security Case from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Security Case to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_security_case", "outputSchema": null }, { "description": "Permanently delete a Security Case Note from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Security Case Note to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_security_case_note", "outputSchema": null }, { "description": "Permanently delete a Security Detection from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Security Detection to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_security_detection", "outputSchema": null }, { "description": "Permanently delete a Security Playbook from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Security Playbook to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_security_playbook", "outputSchema": null }, { "description": "Permanently delete a Status Page from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Status Page to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_status_page", "outputSchema": null }, { "description": "Permanently delete a Status Page Announcement from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Status Page Announcement to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_status_page_announcement", "outputSchema": null }, { "description": "Permanently delete a Team from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Team to delete. This action is irreversible.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "delete_team", "outputSchema": null }, { "description": "Retrieve a single Alert by its unique ID from OneUptime. Use list_alerts first if you need to find the ID.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Alert to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_alert", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Alert Internal Note to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_alert_internal_note", "outputSchema": null }, { "description": "Retrieve a single Alert Severity by its unique ID from OneUptime. Use list_alert_severities first if you need to find the ID.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Alert Severity to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "description": "Optional: field names to return for each Alert Severity (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_alert_severity", "outputSchema": null }, { "description": "Retrieve a single Alert State by its unique ID from OneUptime. Use list_alert_states first if you need to find the ID.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Alert State to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "description": "Optional: field names to return for each Alert State (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_alert_state", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Alert State Timeline to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_alert_state_timeline", "outputSchema": null }, { "description": "Retrieve a single Incident by its unique ID from OneUptime. Use list_incidents first if you need to find the ID.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Incident to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_incident", "outputSchema": null }, { "description": "Retrieve a single Incident Alert by its unique ID from OneUptime. Use list_incident_alerts first if you need to find the ID.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Incident Alert to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "description": "Optional: field names to return for each Incident Alert (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_incident_alert", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Incident Internal Note to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_incident_internal_note", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Incident Public Note to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_incident_public_note", "outputSchema": null }, { "description": "Retrieve a single Incident Severity by its unique ID from OneUptime. Use list_incident_severities first if you need to find the ID.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Incident Severity to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "description": "Optional: field names to return for each Incident Severity (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_incident_severity", "outputSchema": null }, { "description": "Retrieve a single Incident State by its unique ID from OneUptime. Use list_incident_states first if you need to find the ID.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Incident State to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "description": "Optional: field names to return for each Incident State (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_incident_state", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Incident State Timeline to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_incident_state_timeline", "outputSchema": null }, { "description": "Retrieve a single Label by its unique ID from OneUptime. Use list_labels first if you need to find the ID.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Label to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "description": "Optional: field names to return for each Label (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_label", "outputSchema": null }, { "description": "Retrieve a single Monitor by its unique ID from OneUptime. Use list_monitors first if you need to find the ID.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Monitor to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_monitor", "outputSchema": null }, { "description": "Retrieve a single Monitor Status by its unique ID from OneUptime. Use list_monitor_statuses first if you need to find the ID.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Monitor Status to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "description": "Optional: field names to return for each Monitor Status (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_monitor_status", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Monitor Status Event to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_monitor_status_event", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the On-Call Policy to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_on_call_policy", "outputSchema": null }, { "description": "Get announcements from a public status page.\n\nThis tool does NOT require an API key and works with public status pages.\n\nStatus 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.\n\nUSAGE:\n- By domain: statusPageIdOrDomain = \"status.company.com\"\n- By ID: statusPageIdOrDomain = \"550e8400-e29b-41d4-a716-446655440000\"\n\nRETURNS:\n- List of active announcements\n- Announcement details (title, description, dates)", "inputSchema": { "additionalProperties": false, "properties": { "announcementId": { "description": "Optional: Specific announcement ID to fetch details for", "type": "string" }, "statusPageIdOrDomain": { "description": "The status page ID (UUID) or domain name (e.g., 'status.company.com')", "type": "string" } }, "required": [ "statusPageIdOrDomain" ], "type": "object" }, "name": "get_public_status_page_announcements", "outputSchema": null }, { "description": "Get incidents from a public status page.\n\nThis tool does NOT require an API key and works with public status pages.\n\nStatus 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.\n\nUSAGE:\n- By domain: statusPageIdOrDomain = \"status.company.com\"\n- By ID: statusPageIdOrDomain = \"550e8400-e29b-41d4-a716-446655440000\"\n\nRETURNS:\n- List of incidents (active and recent history)\n- Incident details (title, description, severity)\n- Incident timeline and state changes\n- Public notes/updates for each incident", "inputSchema": { "additionalProperties": false, "properties": { "incidentId": { "description": "Optional: Specific incident ID to fetch details for", "type": "string" }, "statusPageIdOrDomain": { "description": "The status page ID (UUID) or domain name (e.g., 'status.company.com')", "type": "string" } }, "required": [ "statusPageIdOrDomain" ], "type": "object" }, "name": "get_public_status_page_incidents", "outputSchema": null }, { "description": "Get the complete overview of a public status page including current status, resources, active incidents, scheduled maintenance, and announcements.\n\nThis tool does NOT require an API key and works with public status pages.\n\nStatus 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.\n\nUSAGE:\n- By domain: statusPageIdOrDomain = \"status.company.com\"\n- By ID: statusPageIdOrDomain = \"550e8400-e29b-41d4-a716-446655440000\"\n\nRETURNS:\n- Status page metadata (name, description, branding)\n- Resources and their current status\n- Active incidents\n- Upcoming scheduled maintenance\n- Active announcements\n- Monitor status history", "inputSchema": { "additionalProperties": false, "properties": { "statusPageIdOrDomain": { "description": "The status page ID (UUID) or domain name (e.g., 'status.company.com'). Use domain for public status pages with custom domains.", "type": "string" } }, "required": [ "statusPageIdOrDomain" ], "type": "object" }, "name": "get_public_status_page_overview", "outputSchema": null }, { "description": "Get scheduled maintenance events from a public status page.\n\nThis tool does NOT require an API key and works with public status pages.\n\nStatus 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.\n\nUSAGE:\n- By domain: statusPageIdOrDomain = \"status.company.com\"\n- By ID: statusPageIdOrDomain = \"550e8400-e29b-41d4-a716-446655440000\"\n\nRETURNS:\n- List of scheduled maintenance events (upcoming and ongoing)\n- Maintenance details (title, description, scheduled times)\n- Maintenance timeline and state changes\n- Public notes/updates for each maintenance event", "inputSchema": { "additionalProperties": false, "properties": { "scheduledMaintenanceId": { "description": "Optional: Specific scheduled maintenance ID to fetch details for", "type": "string" }, "statusPageIdOrDomain": { "description": "The status page ID (UUID) or domain name (e.g., 'status.company.com')", "type": "string" } }, "required": [ "statusPageIdOrDomain" ], "type": "object" }, "name": "get_public_status_page_scheduled_maintenance", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Scheduled Maintenance Event to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_scheduled_maintenance_event", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Scheduled Maintenance State to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "description": "Optional: field names to return for each Scheduled Maintenance State (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_scheduled_maintenance_state", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Scheduled Maintenance State Timeline to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_scheduled_maintenance_state_timeline", "outputSchema": null }, { "description": "Retrieve a single Security Case by its unique ID from OneUptime. Use list_security_cases first if you need to find the ID.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Security Case to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_security_case", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Security Case Note to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "description": "Optional: field names to return for each Security Case Note (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_security_case_note", "outputSchema": null }, { "description": "Retrieve a single Security Detection by its unique ID from OneUptime. Use list_security_detections first if you need to find the ID.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Security Detection to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_security_detection", "outputSchema": null }, { "description": "Retrieve a single Security Playbook by its unique ID from OneUptime. Use list_security_playbooks first if you need to find the ID.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Security Playbook to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_security_playbook", "outputSchema": null }, { "description": "Retrieve a single Status Page by its unique ID from OneUptime. Use list_status_pages first if you need to find the ID.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Status Page to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_status_page", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Status Page Announcement to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_status_page_announcement", "outputSchema": null }, { "description": "Retrieve a single Team by its unique ID from OneUptime. Use list_teams first if you need to find the ID.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Team to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\"", "type": "string" }, "select": { "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "get_team", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "alertId": { "description": "Query operators for alertId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "attachments": { "description": "Query operators for attachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "isOwnerNotified": { "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "note": { "description": "Query operators for note field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postedAt": { "description": "Query operators for postedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "postedFromSlackMessageId": { "description": "Query operators for postedFromSlackMessageId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "savedFromChatMessage": { "description": "Query operators for savedFromChatMessage field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "alertId": { "description": "Sort order for alertId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isOwnerNotified": { "description": "Sort order for isOwnerNotified field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "postedAt": { "description": "Sort order for postedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "postedFromSlackMessageId": { "description": "Sort order for postedFromSlackMessageId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_alert_internal_notes", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "color": { "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "order": { "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 10 }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "description": "Optional: field names to return for each Alert Severity (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "description": { "description": "Sort order for description field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "name": { "description": "Sort order for name field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "slug": { "description": "Sort order for slug field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_alert_severities", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "alertId": { "description": "Query operators for alertId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "alertStateId": { "description": "Query operators for alertStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "endsAt": { "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "isOwnerNotified": { "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "rootCause": { "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "startsAt": { "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "stateChangeLog": { "description": "Query operators for stateChangeLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "alertId": { "description": "Sort order for alertId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "alertStateId": { "description": "Sort order for alertStateId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "endsAt": { "description": "Sort order for endsAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isOwnerNotified": { "description": "Sort order for isOwnerNotified field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "startsAt": { "description": "Sort order for startsAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_alert_state_timelines", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "color": { "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isAcknowledgedState": { "description": "Query operators for isAcknowledgedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isCreatedState": { "description": "Query operators for isCreatedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isResolvedState": { "description": "Query operators for isResolvedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "order": { "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 10 }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "description": "Optional: field names to return for each Alert State (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "description": { "description": "Sort order for description field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isAcknowledgedState": { "description": "Sort order for isAcknowledgedState field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isCreatedState": { "description": "Sort order for isCreatedState field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isResolvedState": { "description": "Sort order for isResolvedState field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "name": { "description": "Sort order for name field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_alert_states", "outputSchema": null }, { "description": "List and search Alerts from OneUptime with optional filtering, pagination, and sorting. Returns an array of Alert objects plus the total matching count.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "aiInvestigationDecision": { "description": "Query operators for aiInvestigationDecision field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "alertEpisodeId": { "description": "Query operators for alertEpisodeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "alertNumber": { "description": "Query operators for alertNumber field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "alertNumberWithPrefix": { "description": "Query operators for alertNumberWithPrefix field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "alertSeverityId": { "description": "Query operators for alertSeverityId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "cephClusters": { "description": "Query operators for cephClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByProbeId": { "description": "Query operators for createdByProbeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdCriteriaId": { "description": "Query operators for createdCriteriaId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdStateLog": { "description": "Query operators for createdStateLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "currentAlertStateId": { "description": "Query operators for currentAlertStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "customFields": { "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "databaseServers": { "description": "Query operators for databaseServers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerHosts": { "description": "Query operators for dockerHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerResources": { "description": "Query operators for dockerResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerSwarmClusters": { "description": "Query operators for dockerSwarmClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "enableReminders": { "description": "Query operators for enableReminders field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "hosts": { "description": "Query operators for hosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "impactStartedAt": { "description": "Query operators for impactStartedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "iotFleets": { "description": "Query operators for iotFleets field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isCreatedAutomatically": { "description": "Query operators for isCreatedAutomatically field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isOwnerNotifiedOfAlertCreation": { "description": "Query operators for isOwnerNotifiedOfAlertCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isPrivate": { "description": "Query operators for isPrivate field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "kubernetesClusters": { "description": "Query operators for kubernetesClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "kubernetesContainers": { "description": "Query operators for kubernetesContainers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "kubernetesResources": { "description": "Query operators for kubernetesResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "labels": { "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "monitorId": { "description": "Query operators for monitorId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "monitorStatusWhenThisAlertWasCreatedId": { "description": "Query operators for monitorStatusWhenThisAlertWasCreatedId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "monitorSummary": { "description": "Query operators for monitorSummary field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "nextReminderNotificationAt": { "description": "Query operators for nextReminderNotificationAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "onCallDutyPolicies": { "description": "Query operators for onCallDutyPolicies field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "podmanHosts": { "description": "Query operators for podmanHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "podmanResources": { "description": "Query operators for podmanResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postUpdatesToWorkspaceChannels": { "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "proxmoxClusters": { "description": "Query operators for proxmoxClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "remediationNotes": { "description": "Query operators for remediationNotes field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "reminderNotificationSentCount": { "description": "Query operators for reminderNotificationSentCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "rootCause": { "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "seriesFingerprint": { "description": "Query operators for seriesFingerprint field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "seriesLabels": { "description": "Query operators for seriesLabels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "serviceLevelObjectives": { "description": "Query operators for serviceLevelObjectives field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "services": { "description": "Query operators for services field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "storageArrays": { "description": "Query operators for storageArrays field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "telemetryQuery": { "description": "Query operators for telemetryQuery field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "title": { "description": "Query operators for title field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "vmwareVCenters": { "description": "Query operators for vmwareVCenters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "alertEpisodeId": { "description": "Sort order for alertEpisodeId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "alertNumber": { "description": "Sort order for alertNumber field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "alertNumberWithPrefix": { "description": "Sort order for alertNumberWithPrefix field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "alertSeverityId": { "description": "Sort order for alertSeverityId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByProbeId": { "description": "Sort order for createdByProbeId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdCriteriaId": { "description": "Sort order for createdCriteriaId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "currentAlertStateId": { "description": "Sort order for currentAlertStateId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "enableReminders": { "description": "Sort order for enableReminders field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "impactStartedAt": { "description": "Sort order for impactStartedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isCreatedAutomatically": { "description": "Sort order for isCreatedAutomatically field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isOwnerNotifiedOfAlertCreation": { "description": "Sort order for isOwnerNotifiedOfAlertCreation field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isPrivate": { "description": "Sort order for isPrivate field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "monitorId": { "description": "Sort order for monitorId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "monitorStatusWhenThisAlertWasCreatedId": { "description": "Sort order for monitorStatusWhenThisAlertWasCreatedId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "nextReminderNotificationAt": { "description": "Sort order for nextReminderNotificationAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "reminderNotificationSentCount": { "description": "Sort order for reminderNotificationSentCount field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "seriesFingerprint": { "description": "Sort order for seriesFingerprint field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "title": { "description": "Sort order for title field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_alerts", "outputSchema": null }, { "description": "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\"}}.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "attributeKeys": { "description": "attributeKeys field", "type": "string" }, "attributes": { "description": "attributes field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "description": { "description": "description field", "type": "string" }, "eventType": { "description": "eventType field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "time": { "description": "time field", "type": "string" }, "title": { "description": "title field", "type": "string" } }, "type": "object" }, "select": { "additionalProperties": false, "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.", "properties": { "_id": { "description": "Select _id field in the response", "example": true, "type": "boolean" }, "attributeKeys": { "description": "Select attributeKeys field in the response", "example": true, "type": "boolean" }, "attributes": { "description": "Select attributes field in the response", "example": true, "type": "boolean" }, "createdAt": { "description": "Select createdAt field in the response", "example": true, "type": "boolean" }, "description": { "description": "Select description field in the response", "example": true, "type": "boolean" }, "eventType": { "description": "Select eventType field in the response", "example": true, "type": "boolean" }, "primaryEntityId": { "description": "Select primaryEntityId field in the response", "example": true, "type": "boolean" }, "primaryEntityType": { "description": "Select primaryEntityType field in the response", "example": true, "type": "boolean" }, "projectId": { "description": "Select projectId field in the response", "example": true, "type": "boolean" }, "retentionDate": { "description": "Select retentionDate field in the response", "example": true, "type": "boolean" }, "time": { "description": "Select time field in the response", "example": true, "type": "boolean" }, "title": { "description": "Select title field in the response", "example": true, "type": "boolean" } }, "type": "object" }, "skip": { "description": "Number of records to skip. Default: 0.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.", "properties": { "_id": { "description": "_id field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "description": { "description": "description field", "type": "string" }, "eventType": { "description": "eventType field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "title": { "description": "title field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_change_events", "outputSchema": null }, { "description": "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\"}}.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "attributeKeys": { "description": "attributeKeys field", "type": "string" }, "attributes": { "description": "attributes field", "type": "string" }, "containerEntityKey": { "description": "containerEntityKey field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "entityKeys": { "description": "entityKeys field", "type": "string" }, "environment": { "description": "environment field", "type": "string" }, "escaped": { "description": "escaped field", "type": "string" }, "exceptionType": { "description": "exceptionType field", "type": "string" }, "fingerprint": { "description": "fingerprint field", "type": "string" }, "hostEntityKey": { "description": "hostEntityKey field", "type": "string" }, "k8sClusterEntityKey": { "description": "k8sClusterEntityKey field", "type": "string" }, "k8sNodeEntityKey": { "description": "k8sNodeEntityKey field", "type": "string" }, "k8sPodEntityKey": { "description": "k8sPodEntityKey field", "type": "string" }, "message": { "description": "message field", "type": "string" }, "parsedFrames": { "description": "parsedFrames field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "release": { "description": "release field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "serviceEntityKey": { "description": "serviceEntityKey field", "type": "string" }, "sessionId": { "description": "sessionId field", "type": "string" }, "spanId": { "description": "spanId field", "type": "string" }, "spanName": { "description": "spanName field", "type": "string" }, "spanStatusCode": { "description": "spanStatusCode field", "type": "string" }, "stackTrace": { "description": "stackTrace field", "type": "string" }, "time": { "description": "time field", "type": "string" }, "timeUnixNano": { "description": "timeUnixNano field", "type": "string" }, "traceId": { "description": "traceId field", "type": "string" } }, "type": "object" }, "select": { "additionalProperties": false, "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.", "properties": { "_id": { "description": "Select _id field in the response", "example": true, "type": "boolean" }, "attributeKeys": { "description": "Select attributeKeys field in the response", "example": true, "type": "boolean" }, "attributes": { "description": "Select attributes field in the response", "example": true, "type": "boolean" }, "containerEntityKey": { "description": "Select containerEntityKey field in the response", "example": true, "type": "boolean" }, "createdAt": { "description": "Select createdAt field in the response", "example": true, "type": "boolean" }, "entityKeys": { "description": "Select entityKeys field in the response", "example": true, "type": "boolean" }, "environment": { "description": "Select environment field in the response", "example": true, "type": "boolean" }, "escaped": { "description": "Select escaped field in the response", "example": true, "type": "boolean" }, "exceptionType": { "description": "Select exceptionType field in the response", "example": true, "type": "boolean" }, "fingerprint": { "description": "Select fingerprint field in the response", "example": true, "type": "boolean" }, "hostEntityKey": { "description": "Select hostEntityKey field in the response", "example": true, "type": "boolean" }, "k8sClusterEntityKey": { "description": "Select k8sClusterEntityKey field in the response", "example": true, "type": "boolean" }, "k8sNodeEntityKey": { "description": "Select k8sNodeEntityKey field in the response", "example": true, "type": "boolean" }, "k8sPodEntityKey": { "description": "Select k8sPodEntityKey field in the response", "example": true, "type": "boolean" }, "message": { "description": "Select message field in the response", "example": true, "type": "boolean" }, "parsedFrames": { "description": "Select parsedFrames field in the response", "example": true, "type": "boolean" }, "primaryEntityId": { "description": "Select primaryEntityId field in the response", "example": true, "type": "boolean" }, "primaryEntityType": { "description": "Select primaryEntityType field in the response", "example": true, "type": "boolean" }, "projectId": { "description": "Select projectId field in the response", "example": true, "type": "boolean" }, "release": { "description": "Select release field in the response", "example": true, "type": "boolean" }, "retentionDate": { "description": "Select retentionDate field in the response", "example": true, "type": "boolean" }, "serviceEntityKey": { "description": "Select serviceEntityKey field in the response", "example": true, "type": "boolean" }, "sessionId": { "description": "Select sessionId field in the response", "example": true, "type": "boolean" }, "spanId": { "description": "Select spanId field in the response", "example": true, "type": "boolean" }, "spanName": { "description": "Select spanName field in the response", "example": true, "type": "boolean" }, "spanStatusCode": { "description": "Select spanStatusCode field in the response", "example": true, "type": "boolean" }, "stackTrace": { "description": "Select stackTrace field in the response", "example": true, "type": "boolean" }, "time": { "description": "Select time field in the response", "example": true, "type": "boolean" }, "timeUnixNano": { "description": "Select timeUnixNano field in the response", "example": true, "type": "boolean" }, "traceId": { "description": "Select traceId field in the response", "example": true, "type": "boolean" } }, "type": "object" }, "skip": { "description": "Number of records to skip. Default: 0.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.", "properties": { "_id": { "description": "_id field", "type": "string" }, "containerEntityKey": { "description": "containerEntityKey field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "environment": { "description": "environment field", "type": "string" }, "escaped": { "description": "escaped field", "type": "string" }, "exceptionType": { "description": "exceptionType field", "type": "string" }, "fingerprint": { "description": "fingerprint field", "type": "string" }, "hostEntityKey": { "description": "hostEntityKey field", "type": "string" }, "k8sClusterEntityKey": { "description": "k8sClusterEntityKey field", "type": "string" }, "k8sNodeEntityKey": { "description": "k8sNodeEntityKey field", "type": "string" }, "k8sPodEntityKey": { "description": "k8sPodEntityKey field", "type": "string" }, "message": { "description": "message field", "type": "string" }, "parsedFrames": { "description": "parsedFrames field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "release": { "description": "release field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "serviceEntityKey": { "description": "serviceEntityKey field", "type": "string" }, "sessionId": { "description": "sessionId field", "type": "string" }, "spanId": { "description": "spanId field", "type": "string" }, "spanName": { "description": "spanName field", "type": "string" }, "spanStatusCode": { "description": "spanStatusCode field", "type": "string" }, "stackTrace": { "description": "stackTrace field", "type": "string" }, "traceId": { "description": "traceId field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_exception_instances", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "alertId": { "description": "Query operators for alertId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "incidentId": { "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "description": "Optional: field names to return for each Incident Alert (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "alertId": { "description": "Sort order for alertId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "incidentId": { "description": "Sort order for incidentId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_incident_alerts", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "attachments": { "description": "Query operators for attachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "incidentId": { "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "isOwnerNotified": { "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "note": { "description": "Query operators for note field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postedAt": { "description": "Query operators for postedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "postedFromSlackMessageId": { "description": "Query operators for postedFromSlackMessageId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "savedFromChatMessage": { "description": "Query operators for savedFromChatMessage field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "incidentId": { "description": "Sort order for incidentId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isOwnerNotified": { "description": "Sort order for isOwnerNotified field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "postedAt": { "description": "Sort order for postedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "postedFromSlackMessageId": { "description": "Sort order for postedFromSlackMessageId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_incident_internal_notes", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "attachments": { "description": "Query operators for attachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "incidentId": { "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "isOwnerNotified": { "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "note": { "description": "Query operators for note field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postedAt": { "description": "Query operators for postedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "postedFromSlackMessageId": { "description": "Query operators for postedFromSlackMessageId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postedWithIncidentStateId": { "description": "Query operators for postedWithIncidentStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "savedFromChatMessage": { "description": "Query operators for savedFromChatMessage field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "shouldStatusPageSubscribersBeNotifiedOnNoteCreated": { "description": "Query operators for shouldStatusPageSubscribersBeNotifiedOnNoteCreated field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "subscriberNotificationStatusMessage": { "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatusMessageOnNoteUpdated": { "description": "Query operators for subscriberNotificationStatusMessageOnNoteUpdated field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatusOnNoteCreated": { "description": "Query operators for subscriberNotificationStatusOnNoteCreated field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "subscriberNotificationStatusOnNoteUpdated": { "description": "Query operators for subscriberNotificationStatusOnNoteUpdated field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "incidentId": { "description": "Sort order for incidentId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isOwnerNotified": { "description": "Sort order for isOwnerNotified field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "postedAt": { "description": "Sort order for postedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "postedFromSlackMessageId": { "description": "Sort order for postedFromSlackMessageId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "postedWithIncidentStateId": { "description": "Sort order for postedWithIncidentStateId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "shouldStatusPageSubscribersBeNotifiedOnNoteCreated": { "description": "Sort order for shouldStatusPageSubscribersBeNotifiedOnNoteCreated field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatusMessage": { "description": "Sort order for subscriberNotificationStatusMessage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatusMessageOnNoteUpdated": { "description": "Sort order for subscriberNotificationStatusMessageOnNoteUpdated field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatusOnNoteCreated": { "description": "Sort order for subscriberNotificationStatusOnNoteCreated field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatusOnNoteUpdated": { "description": "Sort order for subscriberNotificationStatusOnNoteUpdated field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_incident_public_notes", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "color": { "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "order": { "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 10 }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "description": "Optional: field names to return for each Incident Severity (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "description": { "description": "Sort order for description field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "name": { "description": "Sort order for name field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "slug": { "description": "Sort order for slug field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_incident_severities", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "endsAt": { "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "incidentId": { "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "incidentStateId": { "description": "Query operators for incidentStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "isOwnerNotified": { "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "rootCause": { "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "shouldStatusPageSubscribersBeNotified": { "description": "Query operators for shouldStatusPageSubscribersBeNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "startsAt": { "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "stateChangeLog": { "description": "Query operators for stateChangeLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatus": { "description": "Query operators for subscriberNotificationStatus field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "subscriberNotificationStatusMessage": { "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "endsAt": { "description": "Sort order for endsAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "incidentId": { "description": "Sort order for incidentId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "incidentStateId": { "description": "Sort order for incidentStateId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isOwnerNotified": { "description": "Sort order for isOwnerNotified field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "shouldStatusPageSubscribersBeNotified": { "description": "Sort order for shouldStatusPageSubscribersBeNotified field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "startsAt": { "description": "Sort order for startsAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatus": { "description": "Sort order for subscriberNotificationStatus field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatusMessage": { "description": "Sort order for subscriberNotificationStatusMessage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_incident_state_timelines", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "color": { "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isAcknowledgedState": { "description": "Query operators for isAcknowledgedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isCreatedState": { "description": "Query operators for isCreatedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isResolvedState": { "description": "Query operators for isResolvedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "order": { "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 10 }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "description": "Optional: field names to return for each Incident State (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "description": { "description": "Sort order for description field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isAcknowledgedState": { "description": "Sort order for isAcknowledgedState field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isCreatedState": { "description": "Sort order for isCreatedState field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isResolvedState": { "description": "Sort order for isResolvedState field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "name": { "description": "Sort order for name field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "slug": { "description": "Sort order for slug field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_incident_states", "outputSchema": null }, { "description": "List and search Incidents from OneUptime with optional filtering, pagination, and sorting. Returns an array of Incident objects plus the total matching count.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "aiInvestigationDecision": { "description": "Query operators for aiInvestigationDecision field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "cephClusters": { "description": "Query operators for cephClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "changeMonitorStatusToId": { "description": "Query operators for changeMonitorStatusToId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByProbeId": { "description": "Query operators for createdByProbeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdCriteriaId": { "description": "Query operators for createdCriteriaId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdIncidentTemplateId": { "description": "Query operators for createdIncidentTemplateId field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdStateLog": { "description": "Query operators for createdStateLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "currentIncidentStateId": { "description": "Query operators for currentIncidentStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "customFields": { "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "databaseServers": { "description": "Query operators for databaseServers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "declaredAt": { "description": "Query operators for declaredAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerHosts": { "description": "Query operators for dockerHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerResources": { "description": "Query operators for dockerResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerSwarmClusters": { "description": "Query operators for dockerSwarmClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "enableReminders": { "description": "Query operators for enableReminders field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "holdsMonitors": { "description": "Query operators for holdsMonitors field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "hosts": { "description": "Query operators for hosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "impactStartedAt": { "description": "Query operators for impactStartedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "incidentEpisodeId": { "description": "Query operators for incidentEpisodeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "incidentNumber": { "description": "Query operators for incidentNumber field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "incidentNumberWithPrefix": { "description": "Query operators for incidentNumberWithPrefix field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "incidentSeverityId": { "description": "Query operators for incidentSeverityId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "iotFleets": { "description": "Query operators for iotFleets field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isCreatedAutomatically": { "description": "Query operators for isCreatedAutomatically field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isOwnerNotifiedOfResourceCreation": { "description": "Query operators for isOwnerNotifiedOfResourceCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isPrivate": { "description": "Query operators for isPrivate field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isScopedToStatusPages": { "description": "Query operators for isScopedToStatusPages field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isVisibleOnStatusPage": { "description": "Query operators for isVisibleOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "kubernetesClusters": { "description": "Query operators for kubernetesClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "kubernetesContainers": { "description": "Query operators for kubernetesContainers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "kubernetesResources": { "description": "Query operators for kubernetesResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "labels": { "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "monitorSummary": { "description": "Query operators for monitorSummary field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "monitors": { "description": "Query operators for monitors field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "nextReminderNotificationAt": { "description": "Query operators for nextReminderNotificationAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "notifySubscribersOnPostmortemPublished": { "description": "Query operators for notifySubscribersOnPostmortemPublished field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "onCallDutyPolicies": { "description": "Query operators for onCallDutyPolicies field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "podmanHosts": { "description": "Query operators for podmanHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "podmanResources": { "description": "Query operators for podmanResources field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postUpdatesToWorkspaceChannels": { "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postmortemAttachments": { "description": "Query operators for postmortemAttachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postmortemNote": { "description": "Query operators for postmortemNote field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postmortemPostedAt": { "description": "Query operators for postmortemPostedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "proxmoxClusters": { "description": "Query operators for proxmoxClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "remediationNotes": { "description": "Query operators for remediationNotes field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "reminderNotificationSentCount": { "description": "Query operators for reminderNotificationSentCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "rootCause": { "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "seriesFingerprint": { "description": "Query operators for seriesFingerprint field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "seriesLabels": { "description": "Query operators for seriesLabels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "serviceLevelObjectives": { "description": "Query operators for serviceLevelObjectives field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "services": { "description": "Query operators for services field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "shouldStatusPageSubscribersBeNotifiedOnIncidentCreated": { "description": "Query operators for shouldStatusPageSubscribersBeNotifiedOnIncidentCreated field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showPostmortemOnStatusPage": { "description": "Query operators for showPostmortemOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "statusPages": { "description": "Query operators for statusPages field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "statusPagesNotifiedOnCreation": { "description": "Query operators for statusPagesNotifiedOnCreation field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "storageArrays": { "description": "Query operators for storageArrays field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationClaimedAtOnIncidentCreated": { "description": "Query operators for subscriberNotificationClaimedAtOnIncidentCreated field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "subscriberNotificationClaimedAtOnPostmortemPublished": { "description": "Query operators for subscriberNotificationClaimedAtOnPostmortemPublished field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "subscriberNotificationStatusMessage": { "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatusMessageOnPostmortemPublished": { "description": "Query operators for subscriberNotificationStatusMessageOnPostmortemPublished field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatusOnIncidentCreated": { "description": "Query operators for subscriberNotificationStatusOnIncidentCreated field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "subscriberNotificationStatusOnPostmortemPublished": { "description": "Query operators for subscriberNotificationStatusOnPostmortemPublished field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "telemetryQuery": { "description": "Query operators for telemetryQuery field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "title": { "description": "Query operators for title field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "vmwareVCenters": { "description": "Query operators for vmwareVCenters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "changeMonitorStatusToId": { "description": "Sort order for changeMonitorStatusToId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByProbeId": { "description": "Sort order for createdByProbeId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdCriteriaId": { "description": "Sort order for createdCriteriaId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdIncidentTemplateId": { "description": "Sort order for createdIncidentTemplateId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "currentIncidentStateId": { "description": "Sort order for currentIncidentStateId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "declaredAt": { "description": "Sort order for declaredAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "enableReminders": { "description": "Sort order for enableReminders field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "holdsMonitors": { "description": "Sort order for holdsMonitors field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "impactStartedAt": { "description": "Sort order for impactStartedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "incidentEpisodeId": { "description": "Sort order for incidentEpisodeId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "incidentNumber": { "description": "Sort order for incidentNumber field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "incidentNumberWithPrefix": { "description": "Sort order for incidentNumberWithPrefix field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "incidentSeverityId": { "description": "Sort order for incidentSeverityId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isCreatedAutomatically": { "description": "Sort order for isCreatedAutomatically field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isOwnerNotifiedOfResourceCreation": { "description": "Sort order for isOwnerNotifiedOfResourceCreation field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isPrivate": { "description": "Sort order for isPrivate field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isScopedToStatusPages": { "description": "Sort order for isScopedToStatusPages field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isVisibleOnStatusPage": { "description": "Sort order for isVisibleOnStatusPage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "nextReminderNotificationAt": { "description": "Sort order for nextReminderNotificationAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "notifySubscribersOnPostmortemPublished": { "description": "Sort order for notifySubscribersOnPostmortemPublished field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "postmortemPostedAt": { "description": "Sort order for postmortemPostedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "reminderNotificationSentCount": { "description": "Sort order for reminderNotificationSentCount field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "seriesFingerprint": { "description": "Sort order for seriesFingerprint field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "shouldStatusPageSubscribersBeNotifiedOnIncidentCreated": { "description": "Sort order for shouldStatusPageSubscribersBeNotifiedOnIncidentCreated field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "showPostmortemOnStatusPage": { "description": "Sort order for showPostmortemOnStatusPage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "slug": { "description": "Sort order for slug field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationClaimedAtOnIncidentCreated": { "description": "Sort order for subscriberNotificationClaimedAtOnIncidentCreated field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationClaimedAtOnPostmortemPublished": { "description": "Sort order for subscriberNotificationClaimedAtOnPostmortemPublished field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatusMessage": { "description": "Sort order for subscriberNotificationStatusMessage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatusMessageOnPostmortemPublished": { "description": "Sort order for subscriberNotificationStatusMessageOnPostmortemPublished field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatusOnIncidentCreated": { "description": "Sort order for subscriberNotificationStatusOnIncidentCreated field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatusOnPostmortemPublished": { "description": "Sort order for subscriberNotificationStatusOnPostmortemPublished field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "title": { "description": "Sort order for title field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_incidents", "outputSchema": null }, { "description": "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\"}}.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "clusterName": { "description": "clusterName field", "type": "string" }, "containerName": { "description": "containerName field", "type": "string" }, "controllerKind": { "description": "controllerKind field", "type": "string" }, "controllerName": { "description": "controllerName field", "type": "string" }, "cpuCoreHours": { "description": "cpuCoreHours field", "type": "string" }, "cpuCoreLimitAverage": { "description": "cpuCoreLimitAverage field", "type": "string" }, "cpuCoreRequestAverage": { "description": "cpuCoreRequestAverage field", "type": "string" }, "cpuCoreUsageAverage": { "description": "cpuCoreUsageAverage field", "type": "string" }, "cpuCost": { "description": "cpuCost field", "type": "string" }, "cpuEfficiency": { "description": "cpuEfficiency field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "currency": { "description": "currency field", "type": "string" }, "externalCost": { "description": "externalCost field", "type": "string" }, "gpuCost": { "description": "gpuCost field", "type": "string" }, "gpuHours": { "description": "gpuHours field", "type": "string" }, "k8sClusterEntityKey": { "description": "k8sClusterEntityKey field", "type": "string" }, "kubernetesClusterId": { "description": "kubernetesClusterId field", "type": "string" }, "labelKeys": { "description": "labelKeys field", "type": "string" }, "labels": { "description": "labels field", "type": "string" }, "loadBalancerCost": { "description": "loadBalancerCost field", "type": "string" }, "namespace": { "description": "namespace field", "type": "string" }, "networkCost": { "description": "networkCost field", "type": "string" }, "nodeName": { "description": "nodeName field", "type": "string" }, "podName": { "description": "podName field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "providerId": { "description": "providerId field", "type": "string" }, "pvByteHours": { "description": "pvByteHours field", "type": "string" }, "pvCost": { "description": "pvCost field", "type": "string" }, "ramByteHours": { "description": "ramByteHours field", "type": "string" }, "ramBytesLimitAverage": { "description": "ramBytesLimitAverage field", "type": "string" }, "ramBytesRequestAverage": { "description": "ramBytesRequestAverage field", "type": "string" }, "ramBytesUsageAverage": { "description": "ramBytesUsageAverage field", "type": "string" }, "ramBytesUsageMax": { "description": "ramBytesUsageMax field", "type": "string" }, "ramCost": { "description": "ramCost field", "type": "string" }, "ramEfficiency": { "description": "ramEfficiency field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "sharedCost": { "description": "sharedCost field", "type": "string" }, "shipmentChunk": { "description": "shipmentChunk field", "type": "string" }, "shipmentId": { "description": "shipmentId field", "type": "string" }, "totalCost": { "description": "totalCost field", "type": "string" }, "totalEfficiency": { "description": "totalEfficiency field", "type": "string" }, "windowEnd": { "description": "windowEnd field", "type": "string" }, "windowStart": { "description": "windowStart field", "type": "string" } }, "type": "object" }, "select": { "additionalProperties": false, "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.", "properties": { "_id": { "description": "Select _id field in the response", "example": true, "type": "boolean" }, "clusterName": { "description": "Select clusterName field in the response", "example": true, "type": "boolean" }, "containerName": { "description": "Select containerName field in the response", "example": true, "type": "boolean" }, "controllerKind": { "description": "Select controllerKind field in the response", "example": true, "type": "boolean" }, "controllerName": { "description": "Select controllerName field in the response", "example": true, "type": "boolean" }, "cpuCoreHours": { "description": "Select cpuCoreHours field in the response", "example": true, "type": "boolean" }, "cpuCoreLimitAverage": { "description": "Select cpuCoreLimitAverage field in the response", "example": true, "type": "boolean" }, "cpuCoreRequestAverage": { "description": "Select cpuCoreRequestAverage field in the response", "example": true, "type": "boolean" }, "cpuCoreUsageAverage": { "description": "Select cpuCoreUsageAverage field in the response", "example": true, "type": "boolean" }, "cpuCost": { "description": "Select cpuCost field in the response", "example": true, "type": "boolean" }, "cpuEfficiency": { "description": "Select cpuEfficiency field in the response", "example": true, "type": "boolean" }, "createdAt": { "description": "Select createdAt field in the response", "example": true, "type": "boolean" }, "currency": { "description": "Select currency field in the response", "example": true, "type": "boolean" }, "externalCost": { "description": "Select externalCost field in the response", "example": true, "type": "boolean" }, "gpuCost": { "description": "Select gpuCost field in the response", "example": true, "type": "boolean" }, "gpuHours": { "description": "Select gpuHours field in the response", "example": true, "type": "boolean" }, "k8sClusterEntityKey": { "description": "Select k8sClusterEntityKey field in the response", "example": true, "type": "boolean" }, "kubernetesClusterId": { "description": "Select kubernetesClusterId field in the response", "example": true, "type": "boolean" }, "labelKeys": { "description": "Select labelKeys field in the response", "example": true, "type": "boolean" }, "labels": { "description": "Select labels field in the response", "example": true, "type": "boolean" }, "loadBalancerCost": { "description": "Select loadBalancerCost field in the response", "example": true, "type": "boolean" }, "namespace": { "description": "Select namespace field in the response", "example": true, "type": "boolean" }, "networkCost": { "description": "Select networkCost field in the response", "example": true, "type": "boolean" }, "nodeName": { "description": "Select nodeName field in the response", "example": true, "type": "boolean" }, "podName": { "description": "Select podName field in the response", "example": true, "type": "boolean" }, "projectId": { "description": "Select projectId field in the response", "example": true, "type": "boolean" }, "providerId": { "description": "Select providerId field in the response", "example": true, "type": "boolean" }, "pvByteHours": { "description": "Select pvByteHours field in the response", "example": true, "type": "boolean" }, "pvCost": { "description": "Select pvCost field in the response", "example": true, "type": "boolean" }, "ramByteHours": { "description": "Select ramByteHours field in the response", "example": true, "type": "boolean" }, "ramBytesLimitAverage": { "description": "Select ramBytesLimitAverage field in the response", "example": true, "type": "boolean" }, "ramBytesRequestAverage": { "description": "Select ramBytesRequestAverage field in the response", "example": true, "type": "boolean" }, "ramBytesUsageAverage": { "description": "Select ramBytesUsageAverage field in the response", "example": true, "type": "boolean" }, "ramBytesUsageMax": { "description": "Select ramBytesUsageMax field in the response", "example": true, "type": "boolean" }, "ramCost": { "description": "Select ramCost field in the response", "example": true, "type": "boolean" }, "ramEfficiency": { "description": "Select ramEfficiency field in the response", "example": true, "type": "boolean" }, "retentionDate": { "description": "Select retentionDate field in the response", "example": true, "type": "boolean" }, "sharedCost": { "description": "Select sharedCost field in the response", "example": true, "type": "boolean" }, "shipmentChunk": { "description": "Select shipmentChunk field in the response", "example": true, "type": "boolean" }, "shipmentId": { "description": "Select shipmentId field in the response", "example": true, "type": "boolean" }, "totalCost": { "description": "Select totalCost field in the response", "example": true, "type": "boolean" }, "totalEfficiency": { "description": "Select totalEfficiency field in the response", "example": true, "type": "boolean" }, "windowEnd": { "description": "Select windowEnd field in the response", "example": true, "type": "boolean" }, "windowStart": { "description": "Select windowStart field in the response", "example": true, "type": "boolean" } }, "type": "object" }, "skip": { "description": "Number of records to skip. Default: 0.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.", "properties": { "_id": { "description": "_id field", "type": "string" }, "clusterName": { "description": "clusterName field", "type": "string" }, "containerName": { "description": "containerName field", "type": "string" }, "controllerKind": { "description": "controllerKind field", "type": "string" }, "controllerName": { "description": "controllerName field", "type": "string" }, "cpuCoreHours": { "description": "cpuCoreHours field", "type": "string" }, "cpuCoreLimitAverage": { "description": "cpuCoreLimitAverage field", "type": "string" }, "cpuCoreRequestAverage": { "description": "cpuCoreRequestAverage field", "type": "string" }, "cpuCoreUsageAverage": { "description": "cpuCoreUsageAverage field", "type": "string" }, "cpuCost": { "description": "cpuCost field", "type": "string" }, "cpuEfficiency": { "description": "cpuEfficiency field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "currency": { "description": "currency field", "type": "string" }, "externalCost": { "description": "externalCost field", "type": "string" }, "gpuCost": { "description": "gpuCost field", "type": "string" }, "gpuHours": { "description": "gpuHours field", "type": "string" }, "k8sClusterEntityKey": { "description": "k8sClusterEntityKey field", "type": "string" }, "kubernetesClusterId": { "description": "kubernetesClusterId field", "type": "string" }, "loadBalancerCost": { "description": "loadBalancerCost field", "type": "string" }, "namespace": { "description": "namespace field", "type": "string" }, "networkCost": { "description": "networkCost field", "type": "string" }, "nodeName": { "description": "nodeName field", "type": "string" }, "podName": { "description": "podName field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "providerId": { "description": "providerId field", "type": "string" }, "pvByteHours": { "description": "pvByteHours field", "type": "string" }, "pvCost": { "description": "pvCost field", "type": "string" }, "ramByteHours": { "description": "ramByteHours field", "type": "string" }, "ramBytesLimitAverage": { "description": "ramBytesLimitAverage field", "type": "string" }, "ramBytesRequestAverage": { "description": "ramBytesRequestAverage field", "type": "string" }, "ramBytesUsageAverage": { "description": "ramBytesUsageAverage field", "type": "string" }, "ramBytesUsageMax": { "description": "ramBytesUsageMax field", "type": "string" }, "ramCost": { "description": "ramCost field", "type": "string" }, "ramEfficiency": { "description": "ramEfficiency field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "sharedCost": { "description": "sharedCost field", "type": "string" }, "shipmentChunk": { "description": "shipmentChunk field", "type": "string" }, "shipmentId": { "description": "shipmentId field", "type": "string" }, "totalCost": { "description": "totalCost field", "type": "string" }, "totalEfficiency": { "description": "totalEfficiency field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_kubernetes_cost_allocations", "outputSchema": null }, { "description": "List and search Labels from OneUptime with optional filtering, pagination, and sorting. Returns an array of Label objects plus the total matching count.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "color": { "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "description": "Optional: field names to return for each Label (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "description": { "description": "Sort order for description field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "name": { "description": "Sort order for name field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "slug": { "description": "Sort order for slug field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_labels", "outputSchema": null }, { "description": "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\"}}.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "attributeKeys": { "description": "attributeKeys field", "type": "string" }, "attributes": { "description": "attributes field", "type": "string" }, "body": { "description": "body field", "type": "string" }, "containerEntityKey": { "description": "containerEntityKey field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "droppedAttributesCount": { "description": "droppedAttributesCount field", "type": "string" }, "entityKeys": { "description": "entityKeys field", "type": "string" }, "flags": { "description": "flags field", "type": "string" }, "hostEntityKey": { "description": "hostEntityKey field", "type": "string" }, "k8sClusterEntityKey": { "description": "k8sClusterEntityKey field", "type": "string" }, "k8sNodeEntityKey": { "description": "k8sNodeEntityKey field", "type": "string" }, "k8sPodEntityKey": { "description": "k8sPodEntityKey field", "type": "string" }, "observedTimeUnixNano": { "description": "observedTimeUnixNano field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "serviceEntityKey": { "description": "serviceEntityKey field", "type": "string" }, "sessionId": { "description": "sessionId field", "type": "string" }, "severityNumber": { "description": "severityNumber field", "type": "string" }, "severityText": { "description": "severityText field", "type": "string" }, "spanId": { "description": "spanId field", "type": "string" }, "time": { "description": "time field", "type": "string" }, "timeUnixNano": { "description": "timeUnixNano field", "type": "string" }, "traceId": { "description": "traceId field", "type": "string" } }, "type": "object" }, "select": { "additionalProperties": false, "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.", "properties": { "_id": { "description": "Select _id field in the response", "example": true, "type": "boolean" }, "attributeKeys": { "description": "Select attributeKeys field in the response", "example": true, "type": "boolean" }, "attributes": { "description": "Select attributes field in the response", "example": true, "type": "boolean" }, "body": { "description": "Select body field in the response", "example": true, "type": "boolean" }, "containerEntityKey": { "description": "Select containerEntityKey field in the response", "example": true, "type": "boolean" }, "createdAt": { "description": "Select createdAt field in the response", "example": true, "type": "boolean" }, "droppedAttributesCount": { "description": "Select droppedAttributesCount field in the response", "example": true, "type": "boolean" }, "entityKeys": { "description": "Select entityKeys field in the response", "example": true, "type": "boolean" }, "flags": { "description": "Select flags field in the response", "example": true, "type": "boolean" }, "hostEntityKey": { "description": "Select hostEntityKey field in the response", "example": true, "type": "boolean" }, "k8sClusterEntityKey": { "description": "Select k8sClusterEntityKey field in the response", "example": true, "type": "boolean" }, "k8sNodeEntityKey": { "description": "Select k8sNodeEntityKey field in the response", "example": true, "type": "boolean" }, "k8sPodEntityKey": { "description": "Select k8sPodEntityKey field in the response", "example": true, "type": "boolean" }, "observedTimeUnixNano": { "description": "Select observedTimeUnixNano field in the response", "example": true, "type": "boolean" }, "primaryEntityId": { "description": "Select primaryEntityId field in the response", "example": true, "type": "boolean" }, "primaryEntityType": { "description": "Select primaryEntityType field in the response", "example": true, "type": "boolean" }, "projectId": { "description": "Select projectId field in the response", "example": true, "type": "boolean" }, "retentionDate": { "description": "Select retentionDate field in the response", "example": true, "type": "boolean" }, "serviceEntityKey": { "description": "Select serviceEntityKey field in the response", "example": true, "type": "boolean" }, "sessionId": { "description": "Select sessionId field in the response", "example": true, "type": "boolean" }, "severityNumber": { "description": "Select severityNumber field in the response", "example": true, "type": "boolean" }, "severityText": { "description": "Select severityText field in the response", "example": true, "type": "boolean" }, "spanId": { "description": "Select spanId field in the response", "example": true, "type": "boolean" }, "time": { "description": "Select time field in the response", "example": true, "type": "boolean" }, "timeUnixNano": { "description": "Select timeUnixNano field in the response", "example": true, "type": "boolean" }, "traceId": { "description": "Select traceId field in the response", "example": true, "type": "boolean" } }, "type": "object" }, "skip": { "description": "Number of records to skip. Default: 0.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.", "properties": { "_id": { "description": "_id field", "type": "string" }, "body": { "description": "body field", "type": "string" }, "containerEntityKey": { "description": "containerEntityKey field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "droppedAttributesCount": { "description": "droppedAttributesCount field", "type": "string" }, "flags": { "description": "flags field", "type": "string" }, "hostEntityKey": { "description": "hostEntityKey field", "type": "string" }, "k8sClusterEntityKey": { "description": "k8sClusterEntityKey field", "type": "string" }, "k8sNodeEntityKey": { "description": "k8sNodeEntityKey field", "type": "string" }, "k8sPodEntityKey": { "description": "k8sPodEntityKey field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "serviceEntityKey": { "description": "serviceEntityKey field", "type": "string" }, "sessionId": { "description": "sessionId field", "type": "string" }, "severityNumber": { "description": "severityNumber field", "type": "string" }, "severityText": { "description": "severityText field", "type": "string" }, "spanId": { "description": "spanId field", "type": "string" }, "traceId": { "description": "traceId field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_logs", "outputSchema": null }, { "description": "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\"}}.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "aggregationTemporality": { "description": "aggregationTemporality field", "type": "string" }, "attributeKeys": { "description": "attributeKeys field", "type": "string" }, "attributes": { "description": "attributes field", "type": "string" }, "bucketCounts": { "description": "bucketCounts field", "type": "string" }, "containerEntityKey": { "description": "containerEntityKey field", "type": "string" }, "count": { "description": "count field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "entityKeys": { "description": "entityKeys field", "type": "string" }, "explicitBounds": { "description": "explicitBounds field", "type": "string" }, "hostEntityKey": { "description": "hostEntityKey field", "type": "string" }, "isMonotonic": { "description": "isMonotonic field", "type": "string" }, "k8sClusterEntityKey": { "description": "k8sClusterEntityKey field", "type": "string" }, "k8sNodeEntityKey": { "description": "k8sNodeEntityKey field", "type": "string" }, "k8sPodEntityKey": { "description": "k8sPodEntityKey field", "type": "string" }, "max": { "description": "max field", "type": "string" }, "metricPointType": { "description": "metricPointType field", "type": "string" }, "min": { "description": "min field", "type": "string" }, "name": { "description": "name field", "type": "string" }, "negativeBucketCounts": { "description": "negativeBucketCounts field", "type": "string" }, "negativeOffset": { "description": "negativeOffset field", "type": "string" }, "positiveBucketCounts": { "description": "positiveBucketCounts field", "type": "string" }, "positiveOffset": { "description": "positiveOffset field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "scale": { "description": "scale field", "type": "string" }, "serviceEntityKey": { "description": "serviceEntityKey field", "type": "string" }, "spanId": { "description": "spanId field", "type": "string" }, "startTime": { "description": "startTime field", "type": "string" }, "startTimeUnixNano": { "description": "startTimeUnixNano field", "type": "string" }, "sum": { "description": "sum field", "type": "string" }, "summaryQuantiles": { "description": "summaryQuantiles field", "type": "string" }, "summaryValues": { "description": "summaryValues field", "type": "string" }, "time": { "description": "time field", "type": "string" }, "timeUnixNano": { "description": "timeUnixNano field", "type": "string" }, "traceId": { "description": "traceId field", "type": "string" }, "value": { "description": "value field", "type": "string" }, "zeroCount": { "description": "zeroCount field", "type": "string" } }, "type": "object" }, "select": { "additionalProperties": false, "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.", "properties": { "_id": { "description": "Select _id field in the response", "example": true, "type": "boolean" }, "aggregationTemporality": { "description": "Select aggregationTemporality field in the response", "example": true, "type": "boolean" }, "attributeKeys": { "description": "Select attributeKeys field in the response", "example": true, "type": "boolean" }, "attributes": { "description": "Select attributes field in the response", "example": true, "type": "boolean" }, "bucketCounts": { "description": "Select bucketCounts field in the response", "example": true, "type": "boolean" }, "containerEntityKey": { "description": "Select containerEntityKey field in the response", "example": true, "type": "boolean" }, "count": { "description": "Select count field in the response", "example": true, "type": "boolean" }, "createdAt": { "description": "Select createdAt field in the response", "example": true, "type": "boolean" }, "entityKeys": { "description": "Select entityKeys field in the response", "example": true, "type": "boolean" }, "explicitBounds": { "description": "Select explicitBounds field in the response", "example": true, "type": "boolean" }, "hostEntityKey": { "description": "Select hostEntityKey field in the response", "example": true, "type": "boolean" }, "isMonotonic": { "description": "Select isMonotonic field in the response", "example": true, "type": "boolean" }, "k8sClusterEntityKey": { "description": "Select k8sClusterEntityKey field in the response", "example": true, "type": "boolean" }, "k8sNodeEntityKey": { "description": "Select k8sNodeEntityKey field in the response", "example": true, "type": "boolean" }, "k8sPodEntityKey": { "description": "Select k8sPodEntityKey field in the response", "example": true, "type": "boolean" }, "max": { "description": "Select max field in the response", "example": true, "type": "boolean" }, "metricPointType": { "description": "Select metricPointType field in the response", "example": true, "type": "boolean" }, "min": { "description": "Select min field in the response", "example": true, "type": "boolean" }, "name": { "description": "Select name field in the response", "example": true, "type": "boolean" }, "negativeBucketCounts": { "description": "Select negativeBucketCounts field in the response", "example": true, "type": "boolean" }, "negativeOffset": { "description": "Select negativeOffset field in the response", "example": true, "type": "boolean" }, "positiveBucketCounts": { "description": "Select positiveBucketCounts field in the response", "example": true, "type": "boolean" }, "positiveOffset": { "description": "Select positiveOffset field in the response", "example": true, "type": "boolean" }, "primaryEntityId": { "description": "Select primaryEntityId field in the response", "example": true, "type": "boolean" }, "primaryEntityType": { "description": "Select primaryEntityType field in the response", "example": true, "type": "boolean" }, "projectId": { "description": "Select projectId field in the response", "example": true, "type": "boolean" }, "retentionDate": { "description": "Select retentionDate field in the response", "example": true, "type": "boolean" }, "scale": { "description": "Select scale field in the response", "example": true, "type": "boolean" }, "serviceEntityKey": { "description": "Select serviceEntityKey field in the response", "example": true, "type": "boolean" }, "spanId": { "description": "Select spanId field in the response", "example": true, "type": "boolean" }, "startTime": { "description": "Select startTime field in the response", "example": true, "type": "boolean" }, "startTimeUnixNano": { "description": "Select startTimeUnixNano field in the response", "example": true, "type": "boolean" }, "sum": { "description": "Select sum field in the response", "example": true, "type": "boolean" }, "summaryQuantiles": { "description": "Select summaryQuantiles field in the response", "example": true, "type": "boolean" }, "summaryValues": { "description": "Select summaryValues field in the response", "example": true, "type": "boolean" }, "time": { "description": "Select time field in the response", "example": true, "type": "boolean" }, "timeUnixNano": { "description": "Select timeUnixNano field in the response", "example": true, "type": "boolean" }, "traceId": { "description": "Select traceId field in the response", "example": true, "type": "boolean" }, "value": { "description": "Select value field in the response", "example": true, "type": "boolean" }, "zeroCount": { "description": "Select zeroCount field in the response", "example": true, "type": "boolean" } }, "type": "object" }, "skip": { "description": "Number of records to skip. Default: 0.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.", "properties": { "_id": { "description": "_id field", "type": "string" }, "aggregationTemporality": { "description": "aggregationTemporality field", "type": "string" }, "containerEntityKey": { "description": "containerEntityKey field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "hostEntityKey": { "description": "hostEntityKey field", "type": "string" }, "isMonotonic": { "description": "isMonotonic field", "type": "string" }, "k8sClusterEntityKey": { "description": "k8sClusterEntityKey field", "type": "string" }, "k8sNodeEntityKey": { "description": "k8sNodeEntityKey field", "type": "string" }, "k8sPodEntityKey": { "description": "k8sPodEntityKey field", "type": "string" }, "max": { "description": "max field", "type": "string" }, "metricPointType": { "description": "metricPointType field", "type": "string" }, "min": { "description": "min field", "type": "string" }, "name": { "description": "name field", "type": "string" }, "negativeOffset": { "description": "negativeOffset field", "type": "string" }, "positiveOffset": { "description": "positiveOffset field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "scale": { "description": "scale field", "type": "string" }, "serviceEntityKey": { "description": "serviceEntityKey field", "type": "string" }, "spanId": { "description": "spanId field", "type": "string" }, "sum": { "description": "sum field", "type": "string" }, "traceId": { "description": "traceId field", "type": "string" }, "value": { "description": "value field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_metrics", "outputSchema": null }, { "description": "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\"}}.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "logBody": { "description": "logBody field", "type": "string" }, "monitorId": { "description": "monitorId field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "time": { "description": "time field", "type": "string" } }, "type": "object" }, "select": { "additionalProperties": false, "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.", "properties": { "_id": { "description": "Select _id field in the response", "example": true, "type": "boolean" }, "createdAt": { "description": "Select createdAt field in the response", "example": true, "type": "boolean" }, "logBody": { "description": "Select logBody field in the response", "example": true, "type": "boolean" }, "monitorId": { "description": "Select monitorId field in the response", "example": true, "type": "boolean" }, "projectId": { "description": "Select projectId field in the response", "example": true, "type": "boolean" }, "retentionDate": { "description": "Select retentionDate field in the response", "example": true, "type": "boolean" }, "time": { "description": "Select time field in the response", "example": true, "type": "boolean" } }, "type": "object" }, "skip": { "description": "Number of records to skip. Default: 0.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.", "properties": { "_id": { "description": "_id field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "monitorId": { "description": "monitorId field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_monitor_logs", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "endsAt": { "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "isOwnerNotified": { "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "monitorId": { "description": "Query operators for monitorId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "monitorStatusId": { "description": "Query operators for monitorStatusId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "rootCause": { "description": "Query operators for rootCause field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "startsAt": { "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "statusChangeLog": { "description": "Query operators for statusChangeLog field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "endsAt": { "description": "Sort order for endsAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isOwnerNotified": { "description": "Sort order for isOwnerNotified field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "monitorId": { "description": "Sort order for monitorId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "monitorStatusId": { "description": "Sort order for monitorStatusId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "startsAt": { "description": "Sort order for startsAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_monitor_status_events", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "color": { "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isOfflineState": { "description": "Query operators for isOfflineState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isOperationalState": { "description": "Query operators for isOperationalState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "priority": { "description": "Query operators for priority field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "description": "Optional: field names to return for each Monitor Status (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "description": { "description": "Sort order for description field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isOfflineState": { "description": "Sort order for isOfflineState field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isOperationalState": { "description": "Sort order for isOperationalState field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "name": { "description": "Sort order for name field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "priority": { "description": "Sort order for priority field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "slug": { "description": "Sort order for slug field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_monitor_statuses", "outputSchema": null }, { "description": "List and search Monitors from OneUptime with optional filtering, pagination, and sorting. Returns an array of Monitor objects plus the total matching count.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "archivedAt": { "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "archivedByUserId": { "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "autoProvisionedNetworkDeviceId": { "description": "Query operators for autoProvisionedNetworkDeviceId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "cephClusters": { "description": "Query operators for cephClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "currentMonitorStatusId": { "description": "Query operators for currentMonitorStatusId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "customFields": { "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "databaseServers": { "description": "Query operators for databaseServers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "dependsOnMonitors": { "description": "Query operators for dependsOnMonitors field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "description": { "description": "Query operators for description field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "disableActiveMonitoring": { "description": "Query operators for disableActiveMonitoring field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "disableActiveMonitoringBecauseOfManualIncident": { "description": "Query operators for disableActiveMonitoringBecauseOfManualIncident field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "disableActiveMonitoringBecauseOfScheduledMaintenanceEvent": { "description": "Query operators for disableActiveMonitoringBecauseOfScheduledMaintenanceEvent field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "dockerHosts": { "description": "Query operators for dockerHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerSwarmClusters": { "description": "Query operators for dockerSwarmClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "hosts": { "description": "Query operators for hosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "incomingEmailCustomLocalPart": { "description": "Query operators for incomingEmailCustomLocalPart field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "incomingEmailMonitorHeartbeatCheckedAt": { "description": "Query operators for incomingEmailMonitorHeartbeatCheckedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "incomingEmailMonitorLastEmailReceivedAt": { "description": "Query operators for incomingEmailMonitorLastEmailReceivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "incomingEmailMonitorRequest": { "description": "Query operators for incomingEmailMonitorRequest field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "incomingEmailSecretKey": { "description": "Query operators for incomingEmailSecretKey field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "incomingMonitorRequest": { "description": "Query operators for incomingMonitorRequest field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "incomingRequestMonitorHeartbeatCheckedAt": { "description": "Query operators for incomingRequestMonitorHeartbeatCheckedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "incomingRequestSecretKey": { "description": "Query operators for incomingRequestSecretKey field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "iotFleets": { "description": "Query operators for iotFleets field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isAllProbesDisconnectedFromThisMonitor": { "description": "Query operators for isAllProbesDisconnectedFromThisMonitor field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isArchived": { "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isNoProbeEnabledOnThisMonitor": { "description": "Query operators for isNoProbeEnabledOnThisMonitor field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isOwnerNotifiedOfResourceCreation": { "description": "Query operators for isOwnerNotifiedOfResourceCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "kubernetesClusters": { "description": "Query operators for kubernetesClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "labels": { "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "minimumProbeAgreement": { "description": "Query operators for minimumProbeAgreement field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "monitorSteps": { "description": "Query operators for monitorSteps field of type Monitor Steps. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "monitorTemplateId": { "description": "Query operators for monitorTemplateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "monitorType": { "description": "Query operators for monitorType field of type Monitor Type. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "monitoringInterval": { "description": "Query operators for monitoringInterval field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "networkAlertPolicyId": { "description": "Query operators for networkAlertPolicyId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "podmanHosts": { "description": "Query operators for podmanHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postUpdatesToWorkspaceChannels": { "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "proxmoxClusters": { "description": "Query operators for proxmoxClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "serverMonitorRequestReceivedAt": { "description": "Query operators for serverMonitorRequestReceivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "serverMonitorResponse": { "description": "Query operators for serverMonitorResponse field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "serverMonitorSecretKey": { "description": "Query operators for serverMonitorSecretKey field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "services": { "description": "Query operators for services field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "storageArrays": { "description": "Query operators for storageArrays field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "suppressAlertsWhenParentMonitorStatuses": { "description": "Query operators for suppressAlertsWhenParentMonitorStatuses field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "telemetryMonitorLastMonitorAt": { "description": "Query operators for telemetryMonitorLastMonitorAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "telemetryMonitorNextMonitorAt": { "description": "Query operators for telemetryMonitorNextMonitorAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "vmwareVCenters": { "description": "Query operators for vmwareVCenters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "archivedAt": { "description": "Sort order for archivedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "archivedByUserId": { "description": "Sort order for archivedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "autoProvisionedNetworkDeviceId": { "description": "Sort order for autoProvisionedNetworkDeviceId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "currentMonitorStatusId": { "description": "Sort order for currentMonitorStatusId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "description": { "description": "Sort order for description field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "disableActiveMonitoring": { "description": "Sort order for disableActiveMonitoring field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "disableActiveMonitoringBecauseOfManualIncident": { "description": "Sort order for disableActiveMonitoringBecauseOfManualIncident field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "disableActiveMonitoringBecauseOfScheduledMaintenanceEvent": { "description": "Sort order for disableActiveMonitoringBecauseOfScheduledMaintenanceEvent field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "incomingEmailCustomLocalPart": { "description": "Sort order for incomingEmailCustomLocalPart field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "incomingEmailMonitorHeartbeatCheckedAt": { "description": "Sort order for incomingEmailMonitorHeartbeatCheckedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "incomingEmailMonitorLastEmailReceivedAt": { "description": "Sort order for incomingEmailMonitorLastEmailReceivedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "incomingEmailSecretKey": { "description": "Sort order for incomingEmailSecretKey field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "incomingRequestMonitorHeartbeatCheckedAt": { "description": "Sort order for incomingRequestMonitorHeartbeatCheckedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "incomingRequestSecretKey": { "description": "Sort order for incomingRequestSecretKey field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isAllProbesDisconnectedFromThisMonitor": { "description": "Sort order for isAllProbesDisconnectedFromThisMonitor field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isArchived": { "description": "Sort order for isArchived field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isNoProbeEnabledOnThisMonitor": { "description": "Sort order for isNoProbeEnabledOnThisMonitor field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isOwnerNotifiedOfResourceCreation": { "description": "Sort order for isOwnerNotifiedOfResourceCreation field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "minimumProbeAgreement": { "description": "Sort order for minimumProbeAgreement field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "monitorTemplateId": { "description": "Sort order for monitorTemplateId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "monitoringInterval": { "description": "Sort order for monitoringInterval field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "name": { "description": "Sort order for name field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "networkAlertPolicyId": { "description": "Sort order for networkAlertPolicyId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "serverMonitorRequestReceivedAt": { "description": "Sort order for serverMonitorRequestReceivedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "serverMonitorSecretKey": { "description": "Sort order for serverMonitorSecretKey field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "slug": { "description": "Sort order for slug field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "telemetryMonitorLastMonitorAt": { "description": "Sort order for telemetryMonitorLastMonitorAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "telemetryMonitorNextMonitorAt": { "description": "Sort order for telemetryMonitorNextMonitorAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_monitors", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "archivedAt": { "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "archivedByUserId": { "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "customFields": { "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isArchived": { "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "labels": { "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "postUpdatesToWorkspaceChannels": { "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "repeatPolicyIfNoOneAcknowledges": { "description": "Query operators for repeatPolicyIfNoOneAcknowledges field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "repeatPolicyIfNoOneAcknowledgesNoOfTimes": { "description": "Query operators for repeatPolicyIfNoOneAcknowledgesNoOfTimes field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "archivedAt": { "description": "Sort order for archivedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "archivedByUserId": { "description": "Sort order for archivedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "description": { "description": "Sort order for description field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isArchived": { "description": "Sort order for isArchived field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "name": { "description": "Sort order for name field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "repeatPolicyIfNoOneAcknowledges": { "description": "Sort order for repeatPolicyIfNoOneAcknowledges field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "repeatPolicyIfNoOneAcknowledgesNoOfTimes": { "description": "Sort order for repeatPolicyIfNoOneAcknowledgesNoOfTimes field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "slug": { "description": "Sort order for slug field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_on_call_duty_policies", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "cephClusters": { "description": "Query operators for cephClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "changeMonitorStatusToId": { "description": "Query operators for changeMonitorStatusToId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "currentScheduledMaintenanceStateId": { "description": "Query operators for currentScheduledMaintenanceStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "customFields": { "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "databaseServers": { "description": "Query operators for databaseServers field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerHosts": { "description": "Query operators for dockerHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "dockerSwarmClusters": { "description": "Query operators for dockerSwarmClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "enableReminders": { "description": "Query operators for enableReminders field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "endsAt": { "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "hosts": { "description": "Query operators for hosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "iotFleets": { "description": "Query operators for iotFleets field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isOwnerNotifiedOfResourceCreation": { "description": "Query operators for isOwnerNotifiedOfResourceCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isVisibleOnStatusPage": { "description": "Query operators for isVisibleOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "kubernetesClusters": { "description": "Query operators for kubernetesClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "labels": { "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "monitors": { "description": "Query operators for monitors field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "networkSites": { "description": "Query operators for networkSites field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "nextReminderNotificationAt": { "description": "Query operators for nextReminderNotificationAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "nextSubscriberNotificationBeforeTheEventAt": { "description": "Query operators for nextSubscriberNotificationBeforeTheEventAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "podmanHosts": { "description": "Query operators for podmanHosts field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "postUpdatesToWorkspaceChannels": { "description": "Query operators for postUpdatesToWorkspaceChannels field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "proxmoxClusters": { "description": "Query operators for proxmoxClusters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "reminderNotificationSentCount": { "description": "Query operators for reminderNotificationSentCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "scheduledMaintenanceNumber": { "description": "Query operators for scheduledMaintenanceNumber field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "scheduledMaintenanceNumberWithPrefix": { "description": "Query operators for scheduledMaintenanceNumberWithPrefix field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "sendSubscriberNotificationsOnBeforeTheEvent": { "description": "Query operators for sendSubscriberNotificationsOnBeforeTheEvent field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "services": { "description": "Query operators for services field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "shouldStatusPageSubscribersBeNotifiedOnEventCreated": { "description": "Query operators for shouldStatusPageSubscribersBeNotifiedOnEventCreated field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded": { "description": "Query operators for shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing": { "description": "Query operators for shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "startsAt": { "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "statusPages": { "description": "Query operators for statusPages field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "storageArrays": { "description": "Query operators for storageArrays field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatusMessage": { "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatusOnEventScheduled": { "description": "Query operators for subscriberNotificationStatusOnEventScheduled field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "title": { "description": "Query operators for title field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "vmwareVCenters": { "description": "Query operators for vmwareVCenters field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "changeMonitorStatusToId": { "description": "Sort order for changeMonitorStatusToId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "currentScheduledMaintenanceStateId": { "description": "Sort order for currentScheduledMaintenanceStateId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "enableReminders": { "description": "Sort order for enableReminders field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "endsAt": { "description": "Sort order for endsAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isOwnerNotifiedOfResourceCreation": { "description": "Sort order for isOwnerNotifiedOfResourceCreation field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isVisibleOnStatusPage": { "description": "Sort order for isVisibleOnStatusPage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "nextReminderNotificationAt": { "description": "Sort order for nextReminderNotificationAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "nextSubscriberNotificationBeforeTheEventAt": { "description": "Sort order for nextSubscriberNotificationBeforeTheEventAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "reminderNotificationSentCount": { "description": "Sort order for reminderNotificationSentCount field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "scheduledMaintenanceNumber": { "description": "Sort order for scheduledMaintenanceNumber field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "scheduledMaintenanceNumberWithPrefix": { "description": "Sort order for scheduledMaintenanceNumberWithPrefix field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "shouldStatusPageSubscribersBeNotifiedOnEventCreated": { "description": "Sort order for shouldStatusPageSubscribersBeNotifiedOnEventCreated field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded": { "description": "Sort order for shouldStatusPageSubscribersBeNotifiedWhenEventChangedToEnded field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing": { "description": "Sort order for shouldStatusPageSubscribersBeNotifiedWhenEventChangedToOngoing field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "slug": { "description": "Sort order for slug field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "startsAt": { "description": "Sort order for startsAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatusMessage": { "description": "Sort order for subscriberNotificationStatusMessage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatusOnEventScheduled": { "description": "Sort order for subscriberNotificationStatusOnEventScheduled field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "title": { "description": "Sort order for title field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_scheduled_maintenance_events", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "endsAt": { "description": "Query operators for endsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "isOwnerNotified": { "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "scheduledMaintenanceId": { "description": "Query operators for scheduledMaintenanceId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "scheduledMaintenanceStateId": { "description": "Query operators for scheduledMaintenanceStateId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "shouldStatusPageSubscribersBeNotified": { "description": "Query operators for shouldStatusPageSubscribersBeNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "startsAt": { "description": "Query operators for startsAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "subscriberNotificationStatus": { "description": "Query operators for subscriberNotificationStatus field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "subscriberNotificationStatusMessage": { "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "endsAt": { "description": "Sort order for endsAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isOwnerNotified": { "description": "Sort order for isOwnerNotified field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "scheduledMaintenanceId": { "description": "Sort order for scheduledMaintenanceId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "scheduledMaintenanceStateId": { "description": "Sort order for scheduledMaintenanceStateId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "shouldStatusPageSubscribersBeNotified": { "description": "Sort order for shouldStatusPageSubscribersBeNotified field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "startsAt": { "description": "Sort order for startsAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatus": { "description": "Sort order for subscriberNotificationStatus field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatusMessage": { "description": "Sort order for subscriberNotificationStatusMessage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_scheduled_maintenance_state_timelines", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "color": { "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isEndedState": { "description": "Query operators for isEndedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isOngoingState": { "description": "Query operators for isOngoingState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isResolvedState": { "description": "Query operators for isResolvedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isScheduledState": { "description": "Query operators for isScheduledState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "order": { "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 10 }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "description": "Optional: field names to return for each Scheduled Maintenance State (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "description": { "description": "Sort order for description field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isEndedState": { "description": "Sort order for isEndedState field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isOngoingState": { "description": "Sort order for isOngoingState field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isResolvedState": { "description": "Sort order for isResolvedState field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isScheduledState": { "description": "Sort order for isScheduledState field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "name": { "description": "Sort order for name field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "slug": { "description": "Sort order for slug field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_scheduled_maintenance_states", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "note": { "description": "Query operators for note field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "securityCaseId": { "description": "Query operators for securityCaseId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "description": "Optional: field names to return for each Security Case Note (e.g. [\"_id\", \"name\"]). Omit to get all readable fields.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "securityCaseId": { "description": "Sort order for securityCaseId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_security_case_notes", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "acknowledgedAt": { "description": "Query operators for acknowledgedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "assignedToTeamId": { "description": "Query operators for assignedToTeamId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "assignedToUserId": { "description": "Query operators for assignedToUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "caseNumber": { "description": "Query operators for caseNumber field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "caseNumberWithPrefix": { "description": "Query operators for caseNumberWithPrefix field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "closedAt": { "description": "Query operators for closedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "closedByUserId": { "description": "Query operators for closedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "closingNote": { "description": "Query operators for closingNote field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "containedAt": { "description": "Query operators for containedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "detectionCount": { "description": "Query operators for detectionCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "entities": { "description": "Query operators for entities field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "firstDetectedAt": { "description": "Query operators for firstDetectedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "groupingKey": { "description": "Query operators for groupingKey field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "incidentId": { "description": "Query operators for incidentId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "labels": { "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "lastDetectedAt": { "description": "Query operators for lastDetectedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "mitreTactics": { "description": "Query operators for mitreTactics field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "mitreTechniques": { "description": "Query operators for mitreTechniques field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "priority": { "description": "Query operators for priority field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "source": { "description": "Query operators for source field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "status": { "description": "Query operators for status field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "title": { "description": "Query operators for title field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "verdict": { "description": "Query operators for verdict field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "acknowledgedAt": { "description": "Sort order for acknowledgedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "assignedToTeamId": { "description": "Sort order for assignedToTeamId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "assignedToUserId": { "description": "Sort order for assignedToUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "caseNumber": { "description": "Sort order for caseNumber field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "caseNumberWithPrefix": { "description": "Sort order for caseNumberWithPrefix field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "closedAt": { "description": "Sort order for closedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "closedByUserId": { "description": "Sort order for closedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "containedAt": { "description": "Sort order for containedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "detectionCount": { "description": "Sort order for detectionCount field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "firstDetectedAt": { "description": "Sort order for firstDetectedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "groupingKey": { "description": "Sort order for groupingKey field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "incidentId": { "description": "Sort order for incidentId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "lastDetectedAt": { "description": "Sort order for lastDetectedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "priority": { "description": "Sort order for priority field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "source": { "description": "Sort order for source field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "status": { "description": "Sort order for status field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "title": { "description": "Sort order for title field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "verdict": { "description": "Sort order for verdict field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_security_cases", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "detectionRuleId": { "description": "Query operators for detectionRuleId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "entities": { "description": "Query operators for entities field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "eventCount": { "description": "Query operators for eventCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "eventUid": { "description": "Query operators for eventUid field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "fingerprint": { "description": "Query operators for fingerprint field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "fireCount": { "description": "Query operators for fireCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "firstSeenAt": { "description": "Query operators for firstSeenAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "groupValue": { "description": "Query operators for groupValue field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "lastSeenAt": { "description": "Query operators for lastSeenAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "mitreTactics": { "description": "Query operators for mitreTactics field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "mitreTechniques": { "description": "Query operators for mitreTechniques field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "ruleName": { "description": "Query operators for ruleName field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "sampleMessage": { "description": "Query operators for sampleMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "securityCaseId": { "description": "Query operators for securityCaseId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "securityEventConnectionId": { "description": "Query operators for securityEventConnectionId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "severity": { "description": "Query operators for severity field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "source": { "description": "Query operators for source field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "threatIntelFeedId": { "description": "Query operators for threatIntelFeedId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "title": { "description": "Query operators for title field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "detectionRuleId": { "description": "Sort order for detectionRuleId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "eventCount": { "description": "Sort order for eventCount field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "eventUid": { "description": "Sort order for eventUid field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "fingerprint": { "description": "Sort order for fingerprint field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "fireCount": { "description": "Sort order for fireCount field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "firstSeenAt": { "description": "Sort order for firstSeenAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "groupValue": { "description": "Sort order for groupValue field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "lastSeenAt": { "description": "Sort order for lastSeenAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "ruleName": { "description": "Sort order for ruleName field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "sampleMessage": { "description": "Sort order for sampleMessage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "securityCaseId": { "description": "Sort order for securityCaseId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "securityEventConnectionId": { "description": "Sort order for securityEventConnectionId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "severity": { "description": "Sort order for severity field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "source": { "description": "Sort order for source field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "threatIntelFeedId": { "description": "Sort order for threatIntelFeedId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "title": { "description": "Sort order for title field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_security_detections", "outputSchema": null }, { "description": "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\"}}.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "activityName": { "description": "activityName field", "type": "string" }, "attributeKeys": { "description": "attributeKeys field", "type": "string" }, "attributes": { "description": "attributes field", "type": "string" }, "categoryName": { "description": "categoryName field", "type": "string" }, "categoryUid": { "description": "categoryUid field", "type": "string" }, "className": { "description": "className field", "type": "string" }, "classUid": { "description": "classUid field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "eventUid": { "description": "eventUid field", "type": "string" }, "message": { "description": "message field", "type": "string" }, "mitreTactics": { "description": "mitreTactics field", "type": "string" }, "mitreTechniques": { "description": "mitreTechniques field", "type": "string" }, "observables": { "description": "observables field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "principalHost": { "description": "principalHost field", "type": "string" }, "principalIp": { "description": "principalIp field", "type": "string" }, "principalProcess": { "description": "principalProcess field", "type": "string" }, "principalUser": { "description": "principalUser field", "type": "string" }, "productName": { "description": "productName field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "ruleId": { "description": "ruleId field", "type": "string" }, "ruleName": { "description": "ruleName field", "type": "string" }, "severityId": { "description": "severityId field", "type": "string" }, "severityName": { "description": "severityName field", "type": "string" }, "statusName": { "description": "statusName field", "type": "string" }, "targetHost": { "description": "targetHost field", "type": "string" }, "targetIp": { "description": "targetIp field", "type": "string" }, "targetPort": { "description": "targetPort field", "type": "string" }, "targetResource": { "description": "targetResource field", "type": "string" }, "targetUser": { "description": "targetUser field", "type": "string" }, "time": { "description": "time field", "type": "string" }, "vendorName": { "description": "vendorName field", "type": "string" } }, "type": "object" }, "select": { "additionalProperties": false, "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.", "properties": { "_id": { "description": "Select _id field in the response", "example": true, "type": "boolean" }, "activityName": { "description": "Select activityName field in the response", "example": true, "type": "boolean" }, "attributeKeys": { "description": "Select attributeKeys field in the response", "example": true, "type": "boolean" }, "attributes": { "description": "Select attributes field in the response", "example": true, "type": "boolean" }, "categoryName": { "description": "Select categoryName field in the response", "example": true, "type": "boolean" }, "categoryUid": { "description": "Select categoryUid field in the response", "example": true, "type": "boolean" }, "className": { "description": "Select className field in the response", "example": true, "type": "boolean" }, "classUid": { "description": "Select classUid field in the response", "example": true, "type": "boolean" }, "createdAt": { "description": "Select createdAt field in the response", "example": true, "type": "boolean" }, "eventUid": { "description": "Select eventUid field in the response", "example": true, "type": "boolean" }, "message": { "description": "Select message field in the response", "example": true, "type": "boolean" }, "mitreTactics": { "description": "Select mitreTactics field in the response", "example": true, "type": "boolean" }, "mitreTechniques": { "description": "Select mitreTechniques field in the response", "example": true, "type": "boolean" }, "observables": { "description": "Select observables field in the response", "example": true, "type": "boolean" }, "primaryEntityId": { "description": "Select primaryEntityId field in the response", "example": true, "type": "boolean" }, "primaryEntityType": { "description": "Select primaryEntityType field in the response", "example": true, "type": "boolean" }, "principalHost": { "description": "Select principalHost field in the response", "example": true, "type": "boolean" }, "principalIp": { "description": "Select principalIp field in the response", "example": true, "type": "boolean" }, "principalProcess": { "description": "Select principalProcess field in the response", "example": true, "type": "boolean" }, "principalUser": { "description": "Select principalUser field in the response", "example": true, "type": "boolean" }, "productName": { "description": "Select productName field in the response", "example": true, "type": "boolean" }, "projectId": { "description": "Select projectId field in the response", "example": true, "type": "boolean" }, "retentionDate": { "description": "Select retentionDate field in the response", "example": true, "type": "boolean" }, "ruleId": { "description": "Select ruleId field in the response", "example": true, "type": "boolean" }, "ruleName": { "description": "Select ruleName field in the response", "example": true, "type": "boolean" }, "severityId": { "description": "Select severityId field in the response", "example": true, "type": "boolean" }, "severityName": { "description": "Select severityName field in the response", "example": true, "type": "boolean" }, "statusName": { "description": "Select statusName field in the response", "example": true, "type": "boolean" }, "targetHost": { "description": "Select targetHost field in the response", "example": true, "type": "boolean" }, "targetIp": { "description": "Select targetIp field in the response", "example": true, "type": "boolean" }, "targetPort": { "description": "Select targetPort field in the response", "example": true, "type": "boolean" }, "targetResource": { "description": "Select targetResource field in the response", "example": true, "type": "boolean" }, "targetUser": { "description": "Select targetUser field in the response", "example": true, "type": "boolean" }, "time": { "description": "Select time field in the response", "example": true, "type": "boolean" }, "vendorName": { "description": "Select vendorName field in the response", "example": true, "type": "boolean" } }, "type": "object" }, "skip": { "description": "Number of records to skip. Default: 0.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.", "properties": { "_id": { "description": "_id field", "type": "string" }, "activityName": { "description": "activityName field", "type": "string" }, "categoryName": { "description": "categoryName field", "type": "string" }, "categoryUid": { "description": "categoryUid field", "type": "string" }, "className": { "description": "className field", "type": "string" }, "classUid": { "description": "classUid field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "eventUid": { "description": "eventUid field", "type": "string" }, "message": { "description": "message field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "principalHost": { "description": "principalHost field", "type": "string" }, "principalIp": { "description": "principalIp field", "type": "string" }, "principalProcess": { "description": "principalProcess field", "type": "string" }, "principalUser": { "description": "principalUser field", "type": "string" }, "productName": { "description": "productName field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "ruleId": { "description": "ruleId field", "type": "string" }, "ruleName": { "description": "ruleName field", "type": "string" }, "severityId": { "description": "severityId field", "type": "string" }, "severityName": { "description": "severityName field", "type": "string" }, "statusName": { "description": "statusName field", "type": "string" }, "targetHost": { "description": "targetHost field", "type": "string" }, "targetIp": { "description": "targetIp field", "type": "string" }, "targetPort": { "description": "targetPort field", "type": "string" }, "targetResource": { "description": "targetResource field", "type": "string" }, "targetUser": { "description": "targetUser field", "type": "string" }, "vendorName": { "description": "vendorName field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_security_events", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "detectionRuleIds": { "description": "Query operators for detectionRuleIds field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "detectionSource": { "description": "Query operators for detectionSource field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "isEnabled": { "description": "Query operators for isEnabled field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "lastRunAt": { "description": "Query operators for lastRunAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "minimumPriority": { "description": "Query operators for minimumPriority field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "name": { "description": "Query operators for name field of type Name. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "runCount": { "description": "Query operators for runCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "steps": { "description": "Query operators for steps field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "trigger": { "description": "Query operators for trigger field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "description": { "description": "Sort order for description field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "detectionSource": { "description": "Sort order for detectionSource field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isEnabled": { "description": "Sort order for isEnabled field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "lastRunAt": { "description": "Sort order for lastRunAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "minimumPriority": { "description": "Sort order for minimumPriority field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "runCount": { "description": "Sort order for runCount field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "trigger": { "description": "Sort order for trigger field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_security_playbooks", "outputSchema": null }, { "description": "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\"}}.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "attributeKeys": { "description": "attributeKeys field", "type": "string" }, "attributes": { "description": "attributes field", "type": "string" }, "containerEntityKey": { "description": "containerEntityKey field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "durationUnixNano": { "description": "durationUnixNano field", "type": "string" }, "endTime": { "description": "endTime field", "type": "string" }, "endTimeUnixNano": { "description": "endTimeUnixNano field", "type": "string" }, "entityKeys": { "description": "entityKeys field", "type": "string" }, "events": { "description": "events field", "type": "string" }, "hasException": { "description": "hasException field", "type": "string" }, "hostEntityKey": { "description": "hostEntityKey field", "type": "string" }, "isLlmSpan": { "description": "isLlmSpan field", "type": "string" }, "isRootSpan": { "description": "isRootSpan field", "type": "string" }, "k8sClusterEntityKey": { "description": "k8sClusterEntityKey field", "type": "string" }, "k8sNodeEntityKey": { "description": "k8sNodeEntityKey field", "type": "string" }, "k8sPodEntityKey": { "description": "k8sPodEntityKey field", "type": "string" }, "kind": { "description": "kind field", "type": "string" }, "links": { "description": "links field", "type": "string" }, "llmAgentName": { "description": "llmAgentName field", "type": "string" }, "llmCallKind": { "description": "llmCallKind field", "type": "string" }, "llmConversationId": { "description": "llmConversationId field", "type": "string" }, "llmCost": { "description": "llmCost field", "type": "string" }, "llmInputTokens": { "description": "llmInputTokens field", "type": "string" }, "llmIssues": { "description": "llmIssues field", "type": "string" }, "llmOperation": { "description": "llmOperation field", "type": "string" }, "llmOutputTokens": { "description": "llmOutputTokens field", "type": "string" }, "llmRequestModel": { "description": "llmRequestModel field", "type": "string" }, "llmResponseModel": { "description": "llmResponseModel field", "type": "string" }, "llmSystem": { "description": "llmSystem field", "type": "string" }, "llmTeam": { "description": "llmTeam field", "type": "string" }, "llmToolName": { "description": "llmToolName field", "type": "string" }, "llmTotalTokens": { "description": "llmTotalTokens field", "type": "string" }, "llmUserEmail": { "description": "llmUserEmail field", "type": "string" }, "llmUserId": { "description": "llmUserId field", "type": "string" }, "llmUserMessagePreview": { "description": "llmUserMessagePreview field", "type": "string" }, "name": { "description": "name field", "type": "string" }, "parentSpanId": { "description": "parentSpanId field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "serviceEntityKey": { "description": "serviceEntityKey field", "type": "string" }, "sessionId": { "description": "sessionId field", "type": "string" }, "spanId": { "description": "spanId field", "type": "string" }, "startTime": { "description": "startTime field", "type": "string" }, "startTimeUnixNano": { "description": "startTimeUnixNano field", "type": "string" }, "statusCode": { "description": "statusCode field", "type": "string" }, "statusMessage": { "description": "statusMessage field", "type": "string" }, "traceId": { "description": "traceId field", "type": "string" }, "traceState": { "description": "traceState field", "type": "string" } }, "type": "object" }, "select": { "additionalProperties": false, "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.", "properties": { "_id": { "description": "Select _id field in the response", "example": true, "type": "boolean" }, "attributeKeys": { "description": "Select attributeKeys field in the response", "example": true, "type": "boolean" }, "attributes": { "description": "Select attributes field in the response", "example": true, "type": "boolean" }, "containerEntityKey": { "description": "Select containerEntityKey field in the response", "example": true, "type": "boolean" }, "createdAt": { "description": "Select createdAt field in the response", "example": true, "type": "boolean" }, "durationUnixNano": { "description": "Select durationUnixNano field in the response", "example": true, "type": "boolean" }, "endTime": { "description": "Select endTime field in the response", "example": true, "type": "boolean" }, "endTimeUnixNano": { "description": "Select endTimeUnixNano field in the response", "example": true, "type": "boolean" }, "entityKeys": { "description": "Select entityKeys field in the response", "example": true, "type": "boolean" }, "events": { "description": "Select events field in the response", "example": true, "type": "boolean" }, "hasException": { "description": "Select hasException field in the response", "example": true, "type": "boolean" }, "hostEntityKey": { "description": "Select hostEntityKey field in the response", "example": true, "type": "boolean" }, "isLlmSpan": { "description": "Select isLlmSpan field in the response", "example": true, "type": "boolean" }, "isRootSpan": { "description": "Select isRootSpan field in the response", "example": true, "type": "boolean" }, "k8sClusterEntityKey": { "description": "Select k8sClusterEntityKey field in the response", "example": true, "type": "boolean" }, "k8sNodeEntityKey": { "description": "Select k8sNodeEntityKey field in the response", "example": true, "type": "boolean" }, "k8sPodEntityKey": { "description": "Select k8sPodEntityKey field in the response", "example": true, "type": "boolean" }, "kind": { "description": "Select kind field in the response", "example": true, "type": "boolean" }, "links": { "description": "Select links field in the response", "example": true, "type": "boolean" }, "llmAgentName": { "description": "Select llmAgentName field in the response", "example": true, "type": "boolean" }, "llmCallKind": { "description": "Select llmCallKind field in the response", "example": true, "type": "boolean" }, "llmConversationId": { "description": "Select llmConversationId field in the response", "example": true, "type": "boolean" }, "llmCost": { "description": "Select llmCost field in the response", "example": true, "type": "boolean" }, "llmInputTokens": { "description": "Select llmInputTokens field in the response", "example": true, "type": "boolean" }, "llmIssues": { "description": "Select llmIssues field in the response", "example": true, "type": "boolean" }, "llmOperation": { "description": "Select llmOperation field in the response", "example": true, "type": "boolean" }, "llmOutputTokens": { "description": "Select llmOutputTokens field in the response", "example": true, "type": "boolean" }, "llmRequestModel": { "description": "Select llmRequestModel field in the response", "example": true, "type": "boolean" }, "llmResponseModel": { "description": "Select llmResponseModel field in the response", "example": true, "type": "boolean" }, "llmSystem": { "description": "Select llmSystem field in the response", "example": true, "type": "boolean" }, "llmTeam": { "description": "Select llmTeam field in the response", "example": true, "type": "boolean" }, "llmToolName": { "description": "Select llmToolName field in the response", "example": true, "type": "boolean" }, "llmTotalTokens": { "description": "Select llmTotalTokens field in the response", "example": true, "type": "boolean" }, "llmUserEmail": { "description": "Select llmUserEmail field in the response", "example": true, "type": "boolean" }, "llmUserId": { "description": "Select llmUserId field in the response", "example": true, "type": "boolean" }, "llmUserMessagePreview": { "description": "Select llmUserMessagePreview field in the response", "example": true, "type": "boolean" }, "name": { "description": "Select name field in the response", "example": true, "type": "boolean" }, "parentSpanId": { "description": "Select parentSpanId field in the response", "example": true, "type": "boolean" }, "primaryEntityId": { "description": "Select primaryEntityId field in the response", "example": true, "type": "boolean" }, "primaryEntityType": { "description": "Select primaryEntityType field in the response", "example": true, "type": "boolean" }, "projectId": { "description": "Select projectId field in the response", "example": true, "type": "boolean" }, "retentionDate": { "description": "Select retentionDate field in the response", "example": true, "type": "boolean" }, "serviceEntityKey": { "description": "Select serviceEntityKey field in the response", "example": true, "type": "boolean" }, "sessionId": { "description": "Select sessionId field in the response", "example": true, "type": "boolean" }, "spanId": { "description": "Select spanId field in the response", "example": true, "type": "boolean" }, "startTime": { "description": "Select startTime field in the response", "example": true, "type": "boolean" }, "startTimeUnixNano": { "description": "Select startTimeUnixNano field in the response", "example": true, "type": "boolean" }, "statusCode": { "description": "Select statusCode field in the response", "example": true, "type": "boolean" }, "statusMessage": { "description": "Select statusMessage field in the response", "example": true, "type": "boolean" }, "traceId": { "description": "Select traceId field in the response", "example": true, "type": "boolean" }, "traceState": { "description": "Select traceState field in the response", "example": true, "type": "boolean" } }, "type": "object" }, "skip": { "description": "Number of records to skip. Default: 0.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.", "properties": { "_id": { "description": "_id field", "type": "string" }, "containerEntityKey": { "description": "containerEntityKey field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "durationUnixNano": { "description": "durationUnixNano field", "type": "string" }, "hasException": { "description": "hasException field", "type": "string" }, "hostEntityKey": { "description": "hostEntityKey field", "type": "string" }, "isLlmSpan": { "description": "isLlmSpan field", "type": "string" }, "isRootSpan": { "description": "isRootSpan field", "type": "string" }, "k8sClusterEntityKey": { "description": "k8sClusterEntityKey field", "type": "string" }, "k8sNodeEntityKey": { "description": "k8sNodeEntityKey field", "type": "string" }, "k8sPodEntityKey": { "description": "k8sPodEntityKey field", "type": "string" }, "kind": { "description": "kind field", "type": "string" }, "llmAgentName": { "description": "llmAgentName field", "type": "string" }, "llmCallKind": { "description": "llmCallKind field", "type": "string" }, "llmConversationId": { "description": "llmConversationId field", "type": "string" }, "llmCost": { "description": "llmCost field", "type": "string" }, "llmInputTokens": { "description": "llmInputTokens field", "type": "string" }, "llmOperation": { "description": "llmOperation field", "type": "string" }, "llmOutputTokens": { "description": "llmOutputTokens field", "type": "string" }, "llmRequestModel": { "description": "llmRequestModel field", "type": "string" }, "llmResponseModel": { "description": "llmResponseModel field", "type": "string" }, "llmSystem": { "description": "llmSystem field", "type": "string" }, "llmTeam": { "description": "llmTeam field", "type": "string" }, "llmToolName": { "description": "llmToolName field", "type": "string" }, "llmTotalTokens": { "description": "llmTotalTokens field", "type": "string" }, "llmUserEmail": { "description": "llmUserEmail field", "type": "string" }, "llmUserId": { "description": "llmUserId field", "type": "string" }, "llmUserMessagePreview": { "description": "llmUserMessagePreview field", "type": "string" }, "name": { "description": "name field", "type": "string" }, "parentSpanId": { "description": "parentSpanId field", "type": "string" }, "primaryEntityId": { "description": "primaryEntityId field", "type": "string" }, "primaryEntityType": { "description": "primaryEntityType field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "serviceEntityKey": { "description": "serviceEntityKey field", "type": "string" }, "sessionId": { "description": "sessionId field", "type": "string" }, "spanId": { "description": "spanId field", "type": "string" }, "statusCode": { "description": "statusCode field", "type": "string" }, "statusMessage": { "description": "statusMessage field", "type": "string" }, "traceId": { "description": "traceId field", "type": "string" }, "traceState": { "description": "traceState field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_spans", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "attachments": { "description": "Query operators for attachments field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "endAnnouncementAt": { "description": "Query operators for endAnnouncementAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "isOwnerNotified": { "description": "Query operators for isOwnerNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "monitors": { "description": "Query operators for monitors field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "shouldStatusPageSubscribersBeNotified": { "description": "Query operators for shouldStatusPageSubscribersBeNotified field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showAnnouncementAt": { "description": "Query operators for showAnnouncementAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "statusPages": { "description": "Query operators for statusPages field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatus": { "description": "Query operators for subscriberNotificationStatus field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "subscriberNotificationStatusMessage": { "description": "Query operators for subscriberNotificationStatusMessage field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatusMessageOnAnnouncementUpdated": { "description": "Query operators for subscriberNotificationStatusMessageOnAnnouncementUpdated field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberNotificationStatusOnAnnouncementUpdated": { "description": "Query operators for subscriberNotificationStatusOnAnnouncementUpdated field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "title": { "description": "Query operators for title field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "endAnnouncementAt": { "description": "Sort order for endAnnouncementAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isOwnerNotified": { "description": "Sort order for isOwnerNotified field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "shouldStatusPageSubscribersBeNotified": { "description": "Sort order for shouldStatusPageSubscribersBeNotified field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "showAnnouncementAt": { "description": "Sort order for showAnnouncementAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatus": { "description": "Sort order for subscriberNotificationStatus field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatusMessage": { "description": "Sort order for subscriberNotificationStatusMessage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatusMessageOnAnnouncementUpdated": { "description": "Sort order for subscriberNotificationStatusMessageOnAnnouncementUpdated field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberNotificationStatusOnAnnouncementUpdated": { "description": "Sort order for subscriberNotificationStatusOnAnnouncementUpdated field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "title": { "description": "Sort order for title field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_status_page_announcements", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "allowSubscribersToChooseEventTypes": { "description": "Query operators for allowSubscribersToChooseEventTypes field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "allowSubscribersToChooseResources": { "description": "Query operators for allowSubscribersToChooseResources field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "allowedSubscriberEmailDomains": { "description": "Query operators for allowedSubscriberEmailDomains field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "archivedAt": { "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "archivedByUserId": { "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "callSmsConfigId": { "description": "Query operators for callSmsConfigId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "copyrightText": { "description": "Query operators for copyrightText field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "coverImageAltText": { "description": "Query operators for coverImageAltText field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "coverImageFileId": { "description": "Query operators for coverImageFileId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "customCSS": { "description": "Query operators for customCSS field of type CSS. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "customFields": { "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "customJavaScript": { "description": "Query operators for customJavaScript field of type JavaSCript. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "defaultBarColor": { "description": "Query operators for defaultBarColor field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "defaultLanguage": { "description": "Query operators for defaultLanguage field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "downtimeMonitorStatuses": { "description": "Query operators for downtimeMonitorStatuses field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "embeddedOverallStatusToken": { "description": "Query operators for embeddedOverallStatusToken field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "enableCustomSubscriberEmailNotificationFooterText": { "description": "Query operators for enableCustomSubscriberEmailNotificationFooterText field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableEmailSubscribers": { "description": "Query operators for enableEmailSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableEmbeddedOverallStatus": { "description": "Query operators for enableEmbeddedOverallStatus field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableMasterPassword": { "description": "Query operators for enableMasterPassword field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableMcpServer": { "description": "Query operators for enableMcpServer field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableMicrosoftTeamsSubscribers": { "description": "Query operators for enableMicrosoftTeamsSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableSearchEngineIndexing": { "description": "Query operators for enableSearchEngineIndexing field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableSlackSubscribers": { "description": "Query operators for enableSlackSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableSmsSubscribers": { "description": "Query operators for enableSmsSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enableWebhookSubscribers": { "description": "Query operators for enableWebhookSubscribers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "enabledLanguages": { "description": "Query operators for enabledLanguages field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "faviconFileId": { "description": "Query operators for faviconFileId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "footerHTML": { "description": "Query operators for footerHTML field of type HTML. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "headerHTML": { "description": "Query operators for headerHTML field of type HTML. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "hidePoweredByOneUptimeBranding": { "description": "Query operators for hidePoweredByOneUptimeBranding field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "ipWhitelist": { "description": "Query operators for ipWhitelist field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isArchived": { "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isOwnerNotifiedOfResourceCreation": { "description": "Query operators for isOwnerNotifiedOfResourceCreation field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isPublicStatusPage": { "description": "Query operators for isPublicStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isReportEnabled": { "description": "Query operators for isReportEnabled field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "labels": { "description": "Query operators for labels field of type Entity Array. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "limitSubscribersToPrivateUsers": { "description": "Query operators for limitSubscribersToPrivateUsers field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "logoAltText": { "description": "Query operators for logoAltText field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "logoFileId": { "description": "Query operators for logoFileId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "masterPassword": { "description": "Query operators for masterPassword field of type Hashed String. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "masterPasswordSalt": { "description": "Query operators for masterPasswordSalt field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "onlyShowScopedIncidents": { "description": "Query operators for onlyShowScopedIncidents field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "overallUptimePercentPrecision": { "description": "Query operators for overallUptimePercentPrecision field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "overviewPageDescription": { "description": "Query operators for overviewPageDescription field of type Markdown. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "pageDescription": { "description": "Query operators for pageDescription field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "pageTitle": { "description": "Query operators for pageTitle field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "privateUserSessionLengthInHours": { "description": "Query operators for privateUserSessionLengthInHours field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "reportDataInDays": { "description": "Query operators for reportDataInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "reportPeriodType": { "description": "Query operators for reportPeriodType field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "reportRecurringInterval": { "description": "Query operators for reportRecurringInterval field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "reportStartDateTime": { "description": "Query operators for reportStartDateTime field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "reportTimezone": { "description": "Query operators for reportTimezone field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "requireSsoForLogin": { "description": "Query operators for requireSsoForLogin field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "sendNextReportBy": { "description": "Query operators for sendNextReportBy field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "sendSubscriberNotifications": { "description": "Query operators for sendSubscriberNotifications field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showAnnouncementHistoryInDays": { "description": "Query operators for showAnnouncementHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "showAnnouncementsOnStatusPage": { "description": "Query operators for showAnnouncementsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showEpisodeHistoryInDays": { "description": "Query operators for showEpisodeHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "showEpisodeLabelsOnStatusPage": { "description": "Query operators for showEpisodeLabelsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showEpisodesOnStatusPage": { "description": "Query operators for showEpisodesOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showIncidentHistoryInDays": { "description": "Query operators for showIncidentHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "showIncidentLabelsOnStatusPage": { "description": "Query operators for showIncidentLabelsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showIncidentsOnStatusPage": { "description": "Query operators for showIncidentsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showOverallUptimePercentOnStatusPage": { "description": "Query operators for showOverallUptimePercentOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showScheduledEventHistoryInDays": { "description": "Query operators for showScheduledEventHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "showScheduledEventLabelsOnStatusPage": { "description": "Query operators for showScheduledEventLabelsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showScheduledMaintenanceEventsOnStatusPage": { "description": "Query operators for showScheduledMaintenanceEventsOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showSubscriberPageOnStatusPage": { "description": "Query operators for showSubscriberPageOnStatusPage field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "showUptimeHistoryInDays": { "description": "Query operators for showUptimeHistoryInDays field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "smtpConfigId": { "description": "Query operators for smtpConfigId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "subscriberEmailNotificationFooterText": { "description": "Query operators for subscriberEmailNotificationFooterText field of type Very Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "subscriberTimezones": { "description": "Query operators for subscriberTimezones field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "theme": { "description": "Query operators for theme field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "allowSubscribersToChooseEventTypes": { "description": "Sort order for allowSubscribersToChooseEventTypes field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "allowSubscribersToChooseResources": { "description": "Sort order for allowSubscribersToChooseResources field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "allowedSubscriberEmailDomains": { "description": "Sort order for allowedSubscriberEmailDomains field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "archivedAt": { "description": "Sort order for archivedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "archivedByUserId": { "description": "Sort order for archivedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "callSmsConfigId": { "description": "Sort order for callSmsConfigId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "copyrightText": { "description": "Sort order for copyrightText field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "coverImageAltText": { "description": "Sort order for coverImageAltText field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "coverImageFileId": { "description": "Sort order for coverImageFileId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "defaultLanguage": { "description": "Sort order for defaultLanguage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "description": { "description": "Sort order for description field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "embeddedOverallStatusToken": { "description": "Sort order for embeddedOverallStatusToken field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "enableCustomSubscriberEmailNotificationFooterText": { "description": "Sort order for enableCustomSubscriberEmailNotificationFooterText field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "enableEmailSubscribers": { "description": "Sort order for enableEmailSubscribers field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "enableEmbeddedOverallStatus": { "description": "Sort order for enableEmbeddedOverallStatus field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "enableMasterPassword": { "description": "Sort order for enableMasterPassword field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "enableMcpServer": { "description": "Sort order for enableMcpServer field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "enableMicrosoftTeamsSubscribers": { "description": "Sort order for enableMicrosoftTeamsSubscribers field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "enableSearchEngineIndexing": { "description": "Sort order for enableSearchEngineIndexing field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "enableSlackSubscribers": { "description": "Sort order for enableSlackSubscribers field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "enableSmsSubscribers": { "description": "Sort order for enableSmsSubscribers field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "enableWebhookSubscribers": { "description": "Sort order for enableWebhookSubscribers field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "faviconFileId": { "description": "Sort order for faviconFileId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "hidePoweredByOneUptimeBranding": { "description": "Sort order for hidePoweredByOneUptimeBranding field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "ipWhitelist": { "description": "Sort order for ipWhitelist field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isArchived": { "description": "Sort order for isArchived field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isOwnerNotifiedOfResourceCreation": { "description": "Sort order for isOwnerNotifiedOfResourceCreation field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isPublicStatusPage": { "description": "Sort order for isPublicStatusPage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isReportEnabled": { "description": "Sort order for isReportEnabled field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "limitSubscribersToPrivateUsers": { "description": "Sort order for limitSubscribersToPrivateUsers field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "logoAltText": { "description": "Sort order for logoAltText field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "logoFileId": { "description": "Sort order for logoFileId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "masterPasswordSalt": { "description": "Sort order for masterPasswordSalt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "name": { "description": "Sort order for name field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "onlyShowScopedIncidents": { "description": "Sort order for onlyShowScopedIncidents field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "overallUptimePercentPrecision": { "description": "Sort order for overallUptimePercentPrecision field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "pageDescription": { "description": "Sort order for pageDescription field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "pageTitle": { "description": "Sort order for pageTitle field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "privateUserSessionLengthInHours": { "description": "Sort order for privateUserSessionLengthInHours field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "reportDataInDays": { "description": "Sort order for reportDataInDays field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "reportPeriodType": { "description": "Sort order for reportPeriodType field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "reportStartDateTime": { "description": "Sort order for reportStartDateTime field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "reportTimezone": { "description": "Sort order for reportTimezone field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "requireSsoForLogin": { "description": "Sort order for requireSsoForLogin field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "sendNextReportBy": { "description": "Sort order for sendNextReportBy field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "sendSubscriberNotifications": { "description": "Sort order for sendSubscriberNotifications field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "showAnnouncementHistoryInDays": { "description": "Sort order for showAnnouncementHistoryInDays field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "showAnnouncementsOnStatusPage": { "description": "Sort order for showAnnouncementsOnStatusPage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "showEpisodeHistoryInDays": { "description": "Sort order for showEpisodeHistoryInDays field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "showEpisodeLabelsOnStatusPage": { "description": "Sort order for showEpisodeLabelsOnStatusPage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "showEpisodesOnStatusPage": { "description": "Sort order for showEpisodesOnStatusPage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "showIncidentHistoryInDays": { "description": "Sort order for showIncidentHistoryInDays field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "showIncidentLabelsOnStatusPage": { "description": "Sort order for showIncidentLabelsOnStatusPage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "showIncidentsOnStatusPage": { "description": "Sort order for showIncidentsOnStatusPage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "showOverallUptimePercentOnStatusPage": { "description": "Sort order for showOverallUptimePercentOnStatusPage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "showScheduledEventHistoryInDays": { "description": "Sort order for showScheduledEventHistoryInDays field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "showScheduledEventLabelsOnStatusPage": { "description": "Sort order for showScheduledEventLabelsOnStatusPage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "showScheduledMaintenanceEventsOnStatusPage": { "description": "Sort order for showScheduledMaintenanceEventsOnStatusPage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "showSubscriberPageOnStatusPage": { "description": "Sort order for showSubscriberPageOnStatusPage field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "showUptimeHistoryInDays": { "description": "Sort order for showUptimeHistoryInDays field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "slug": { "description": "Sort order for slug field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "smtpConfigId": { "description": "Sort order for smtpConfigId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "subscriberEmailNotificationFooterText": { "description": "Sort order for subscriberEmailNotificationFooterText field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "theme": { "description": "Sort order for theme field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_status_pages", "outputSchema": null }, { "description": "List and search Teams from OneUptime with optional filtering, pagination, and sorting. Returns an array of Team objects plus the total matching count.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "createdAt": { "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "createdByUserId": { "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "customFields": { "description": "Query operators for customFields field of type JSON. Supported operators: EqualTo, NotEqual, IsNull, NotNull", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "deletedAt": { "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "deletedByUserId": { "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "description": { "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "isPermissionsEditable": { "description": "Query operators for isPermissionsEditable field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isTeamDeleteable": { "description": "Query operators for isTeamDeleteable field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "isTeamEditable": { "description": "Query operators for isTeamEditable field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "name": { "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes", "example": { "_type": "EqualTo", "value": "John Doe" }, "type": "object" }, "projectId": { "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, "type": "object" }, "shouldHaveAtLeastOneMember": { "description": "Query operators for shouldHaveAtLeastOneMember field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull", "example": { "_type": "EqualTo", "value": true }, "type": "object" }, "slug": { "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes", "example": { "_type": "EqualTo", "value": "example_value_1" }, "type": "object" }, "updatedAt": { "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": "2023-01-01T00:00:00.000Z" }, "type": "object" }, "version": { "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween", "example": { "_type": "EqualTo", "value": 50 }, "type": "object" } }, "type": "object" }, "select": { "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.", "items": { "type": "string" }, "type": "array" }, "skip": { "description": "Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first.", "properties": { "_id": { "description": "Sort order for _id field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdAt": { "description": "Sort order for createdAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "createdByUserId": { "description": "Sort order for createdByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedAt": { "description": "Sort order for deletedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "deletedByUserId": { "description": "Sort order for deletedByUserId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "description": { "description": "Sort order for description field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isPermissionsEditable": { "description": "Sort order for isPermissionsEditable field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isTeamDeleteable": { "description": "Sort order for isTeamDeleteable field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "isTeamEditable": { "description": "Sort order for isTeamEditable field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "name": { "description": "Sort order for name field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "projectId": { "description": "Sort order for projectId field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "shouldHaveAtLeastOneMember": { "description": "Sort order for shouldHaveAtLeastOneMember field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "slug": { "description": "Sort order for slug field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "updatedAt": { "description": "Sort order for updatedAt field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" }, "version": { "description": "Sort order for version field", "enum": [ "ASC", "DESC" ], "example": "ASC", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_teams", "outputSchema": null }, { "description": "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\"}}.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.", "type": "number" }, "query": { "additionalProperties": false, "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\"}}.", "properties": { "_id": { "description": "_id field", "type": "string" }, "confidence": { "description": "confidence field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "feedId": { "description": "feedId field", "type": "string" }, "feedName": { "description": "feedName field", "type": "string" }, "indicatorName": { "description": "indicatorName field", "type": "string" }, "indicatorType": { "description": "indicatorType field", "type": "string" }, "indicatorValue": { "description": "indicatorValue field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "revoked": { "description": "revoked field", "type": "string" }, "stixId": { "description": "stixId field", "type": "string" }, "stixLabels": { "description": "stixLabels field", "type": "string" }, "validFrom": { "description": "validFrom field", "type": "string" }, "validUntil": { "description": "validUntil field", "type": "string" }, "version": { "description": "version field", "type": "string" } }, "type": "object" }, "select": { "additionalProperties": false, "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.", "properties": { "_id": { "description": "Select _id field in the response", "example": true, "type": "boolean" }, "confidence": { "description": "Select confidence field in the response", "example": true, "type": "boolean" }, "createdAt": { "description": "Select createdAt field in the response", "example": true, "type": "boolean" }, "feedId": { "description": "Select feedId field in the response", "example": true, "type": "boolean" }, "feedName": { "description": "Select feedName field in the response", "example": true, "type": "boolean" }, "indicatorName": { "description": "Select indicatorName field in the response", "example": true, "type": "boolean" }, "indicatorType": { "description": "Select indicatorType field in the response", "example": true, "type": "boolean" }, "indicatorValue": { "description": "Select indicatorValue field in the response", "example": true, "type": "boolean" }, "projectId": { "description": "Select projectId field in the response", "example": true, "type": "boolean" }, "retentionDate": { "description": "Select retentionDate field in the response", "example": true, "type": "boolean" }, "revoked": { "description": "Select revoked field in the response", "example": true, "type": "boolean" }, "stixId": { "description": "Select stixId field in the response", "example": true, "type": "boolean" }, "stixLabels": { "description": "Select stixLabels field in the response", "example": true, "type": "boolean" }, "validFrom": { "description": "Select validFrom field in the response", "example": true, "type": "boolean" }, "validUntil": { "description": "Select validUntil field in the response", "example": true, "type": "boolean" }, "version": { "description": "Select version field in the response", "example": true, "type": "boolean" } }, "type": "object" }, "skip": { "description": "Number of records to skip. Default: 0.", "type": "number" }, "sort": { "additionalProperties": false, "description": "Sort order. Use \"ASC\" or \"DESC\". Example: {\"time\": \"DESC\"} for most recent first.", "properties": { "_id": { "description": "_id field", "type": "string" }, "confidence": { "description": "confidence field", "type": "string" }, "createdAt": { "description": "createdAt field", "type": "string" }, "feedId": { "description": "feedId field", "type": "string" }, "feedName": { "description": "feedName field", "type": "string" }, "indicatorName": { "description": "indicatorName field", "type": "string" }, "indicatorType": { "description": "indicatorType field", "type": "string" }, "indicatorValue": { "description": "indicatorValue field", "type": "string" }, "projectId": { "description": "projectId field", "type": "string" }, "retentionDate": { "description": "retentionDate field", "type": "string" }, "revoked": { "description": "revoked field", "type": "string" }, "stixId": { "description": "stixId field", "type": "string" } }, "type": "object" } }, "type": "object" }, "name": "list_threat_intel_indicators", "outputSchema": null }, { "description": "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.\n\nAVAILABLE RESOURCES:\n- Teams: Groups of users with shared access to project resources.\n- Labels: Labels for organizing and filtering project resources.\n- Security Cases: Manages Security Case resources in OneUptime.\n- Security Case Notes: Manages Security Case Note resources in OneUptime.\n- Security Detections: Manages Security Detection resources in OneUptime.\n- Security Playbooks: Manages Security Playbook resources in OneUptime.\n- Status Pages: Public-facing page showing the status of your services to your customers.\n- On-Call Duty Policies: Defines escalation rules and schedules for incident response.\n- Monitors: Defines what to monitor (websites, APIs, servers) and how to check their health and availability.\n- Monitor Statuses: Represents the health states of monitors (e.g., Operational, Degraded, Offline).\n- Incident States: Represents the lifecycle states of incidents (e.g., Created, Acknowledged, Resolved).\n- Incidents: Represents service disruptions or issues affecting your systems. Track incident lifecycle from creation to resolution.\n- Incident State Timelines: History of state changes for incidents. Creating an entry changes the incident's state (this is how acknowledge/resolve work).\n- Incident Internal Notes: Internal team-only notes on incidents.\n- Incident Public Notes: Status-page-visible notes on incidents, seen by customers and subscribers.\n- Incident Severities: Severity levels for incidents (e.g., Critical, Major, Minor). List these to find the incidentSeverityId required by create_incident.\n- Alert States: Lifecycle states of alerts (e.g., Created, Acknowledged, Resolved).\n- Alerts: Notifications triggered when monitors detect issues. Configures who gets notified and how.\n- Alert State Timelines: History of state changes for alerts. Creating an entry changes the alert's state.\n- Alert Internal Notes: Internal team-only notes on alerts.\n- Alert Severities: Severity levels for alerts. List these to find the alertSeverityId required by create_alert.\n- 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.\n- Monitor Status Events: History of monitor status changes — useful for investigating when a monitor went down or recovered.\n- Status Page Announcements: Announcements posted to your status pages.\n- Scheduled Maintenance States: Lifecycle states for maintenance events (e.g., Scheduled, Ongoing, Completed).\n- Scheduled Maintenance Events: Manages Scheduled Maintenance Event resources in OneUptime.\n- Scheduled Maintenance State Timelines: Manages Scheduled Maintenance State Timeline resources in OneUptime.\n- Logs: OpenTelemetry log records from your services. Filter by time range and service.\n- Spans: OpenTelemetry trace spans from your services.\n- Metrics: OpenTelemetry metrics from your services.\n- Exception Instances: Application exceptions captured via telemetry.\n- Monitor Logs: Raw probe results for monitors — explains why a monitor check passed or failed.\n- Kubernetes Cost Allocations: Manages Kubernetes Cost Allocation resources in OneUptime.\n- Security Events: Manages Security Event resources in OneUptime.\n- Change Events: Manages Change Event resources in OneUptime.\n- Threat Intel Indicators: Manages Threat Intel Indicator resources in OneUptime.\n- Acknowledge Incident: Manages Acknowledge Incident resources in OneUptime.\n\nCOMMON WORKFLOWS:\n1. Orient yourself: Use oneuptime_whoami to see your project\n2. List incidents: Use list_incidents to see current incidents\n3. Respond: Use acknowledge_incident / resolve_incident / add_incident_note\n4. Investigate: Use list_logs, list_metrics, list_spans, list_monitor_logs (always with a time-range filter)\n5. Create incident: Use list_incident_severities to get a severity ID, then create_incident", "inputSchema": { "additionalProperties": false, "properties": { "topic": { "description": "Optional topic to get help on: 'resources', 'incidents', 'monitors', 'alerts', 'workflows', or 'examples'", "enum": [ "resources", "incidents", "monitors", "alerts", "workflows", "examples" ], "type": "string" } }, "type": "object" }, "name": "oneuptime_help", "outputSchema": null }, { "description": "List all available OneUptime resources and their supported operations. Use this to discover what resources you can manage through the MCP server.", "inputSchema": { "additionalProperties": false, "properties": {}, "type": "object" }, "name": "oneuptime_list_resources", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": {}, "type": "object" }, "name": "oneuptime_whoami", "outputSchema": null }, { "description": "Resolve an alert: moves it to the project's 'Resolved' state.", "inputSchema": { "additionalProperties": false, "properties": { "alertId": { "description": "UUID of the alert to resolve. Use list_alerts to find it.", "type": "string" } }, "required": [ "alertId" ], "type": "object" }, "name": "resolve_alert", "outputSchema": null }, { "description": "Resolve an incident: moves it to the project's 'Resolved' state. Equivalent to pressing 'Resolve' in the OneUptime dashboard.", "inputSchema": { "additionalProperties": false, "properties": { "incidentId": { "description": "UUID of the incident to resolve. Use list_incidents to find it.", "type": "string" } }, "required": [ "incidentId" ], "type": "object" }, "name": "resolve_incident", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "alertSeverityId": { "description": "Alert Severity ID.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "cephClusters": { "description": "List of Ceph clusters affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "currentAlertStateId": { "description": "Current Alert State ID.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "customFields": { "description": "Custom Fields on this resource.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "databaseServers": { "description": "List of databases affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "Short description of this alert. This will be visible on the status page. This is in markdown.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "dockerHosts": { "description": "List of Docker hosts affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "dockerResources": { "description": "List of Docker resources (containers, images, networks, volumes) affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "dockerSwarmClusters": { "description": "List of Docker Swarm clusters affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "enableReminders": { "default": 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.", "example": true, "type": "boolean" }, "hosts": { "description": "List of hosts affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "id": { "description": "The unique identifier (UUID) of the Alert to update. Required. Use list_alerts to find IDs.", "type": "string" }, "impactStartedAt": { "description": "When customer impact actually began. Left blank until someone records it - never inferred, because a guessed value is worse than no value.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "iotFleets": { "description": "List of IoT fleets affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "isPrivate": { "default": false, "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.", "example": true, "type": "boolean" }, "kubernetesClusters": { "description": "List of Kubernetes clusters affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "kubernetesContainers": { "description": "List of Kubernetes containers affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "kubernetesResources": { "description": "List of Kubernetes resources (pods, deployments, nodes, etc.) affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "labels": { "description": "Relation to Labels Array where this object is categorized in.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "monitorId": { "description": "ID of the monitor this alert belongs to.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "monitorStatusWhenThisAlertWasCreatedId": { "description": "Monitor Status ID when this alert was created.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "onCallDutyPolicies": { "description": "List of on-call duty policies affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "podmanHosts": { "description": "List of Podman hosts affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "podmanResources": { "description": "List of Podman resources (containers, images, networks, volumes) affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "proxmoxClusters": { "description": "List of Proxmox clusters affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "remediationNotes": { "description": "Notes on how to remediate this alert. This is in markdown.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "serviceLevelObjectives": { "description": "List of Service Level Objectives (SLOs) affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "services": { "description": "List of services affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "storageArrays": { "description": "List of storage arrays affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "telemetryQuery": { "description": "Telemetry query for this alert.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "title": { "description": "Title of this alert.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "vmwareVCenters": { "description": "List of vCenters affected by this alert.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "update_alert", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "attachments": { "description": "Files attached to this note.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "id": { "description": "The unique identifier (UUID) of the Alert Internal Note to update. Required. Use list_alert_internal_notes to find IDs.", "type": "string" }, "note": { "description": "Notes in markdown.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "postedAt": { "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.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" } }, "required": [ "id" ], "type": "object" }, "name": "update_alert_internal_note", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "color": { "description": "Color of this resource in Hex (#32a852 for example).", "example": { "_type": "Color", "value": "#ff0000" }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "id": { "description": "The unique identifier (UUID) of the Alert Severity to update. Required. Use list_alert_severities to find IDs.", "type": "string" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "order": { "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.", "example": 10, "type": "integer" } }, "required": [ "id" ], "type": "object" }, "name": "update_alert_severity", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "color": { "description": "Color of this resource in Hex (#32a852 for example).", "example": { "_type": "Color", "value": "#ff0000" }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "id": { "description": "The unique identifier (UUID) of the Alert State to update. Required. Use list_alert_states to find IDs.", "type": "string" }, "isAcknowledgedState": { "description": "Is it the acknowledged state of the alert?", "example": true, "type": "boolean" }, "isCreatedState": { "description": "Is it the created state of the alert?", "example": true, "type": "boolean" }, "isResolvedState": { "description": "Is it the resolved state of the alert?", "example": true, "type": "boolean" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "order": { "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.", "example": 10, "type": "integer" } }, "required": [ "id" ], "type": "object" }, "name": "update_alert_state", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "alertStateId": { "description": "Alert State ID Relation. Which alert state does this alert change to?", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "id": { "description": "The unique identifier (UUID) of the Alert State Timeline to update. Required. Use list_alert_state_timelines to find IDs.", "type": "string" }, "startsAt": { "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.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" } }, "required": [ "id" ], "type": "object" }, "name": "update_alert_state_timeline", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "cephClusters": { "description": "List of Ceph clusters affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "changeMonitorStatusToId": { "description": "Relation to Monitor Status Object ID. All monitors connected to this incident will be changed to this status when the incident is created.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "currentIncidentStateId": { "description": "Current Incident State ID.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "customFields": { "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.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "databaseServers": { "description": "List of databases affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "declaredAt": { "description": "Date and time when this incident was declared.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "description": { "description": "Short description of this incident. This is in markdown and will be visible on the status page.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "dockerHosts": { "description": "List of Docker hosts affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "dockerResources": { "description": "List of Docker resources (containers, images, networks, volumes) affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "dockerSwarmClusters": { "description": "List of Docker Swarm clusters affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "enableReminders": { "default": 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.", "example": true, "type": "boolean" }, "hosts": { "description": "List of hosts affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "id": { "description": "The unique identifier (UUID) of the Incident to update. Required. Use list_incidents to find IDs.", "type": "string" }, "impactStartedAt": { "description": "When customer impact actually began. Left blank until someone records it - never inferred, because a guessed value is worse than no value.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "incidentSeverityId": { "description": "Incident Severity ID.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "iotFleets": { "description": "List of IoT fleets affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "isPrivate": { "default": false, "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.", "example": true, "type": "boolean" }, "isVisibleOnStatusPage": { "default": true, "description": "Should this incident be visible on the status page?", "example": true, "type": "boolean" }, "kubernetesClusters": { "description": "List of Kubernetes clusters affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "kubernetesContainers": { "description": "List of Kubernetes containers affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "kubernetesResources": { "description": "List of Kubernetes resources (pods, deployments, nodes, etc.) affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "labels": { "description": "Relation to Labels Array where this object is categorized in.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "monitors": { "description": "List of monitors affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "notifySubscribersOnPostmortemPublished": { "default": true, "description": "Should subscribers be notified when the postmortem is published?", "example": true, "type": "boolean" }, "onCallDutyPolicies": { "description": "List of on-call duty policies affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "podmanHosts": { "description": "List of Podman hosts affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "podmanResources": { "description": "List of Podman resources (containers, images, networks, volumes) affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "postmortemAttachments": { "description": "Files that accompany the postmortem note and can be shared publicly when enabled.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "postmortemNote": { "description": "Document the postmortem summary for this incident.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "postmortemPostedAt": { "description": "Timestamp that will be shown alongside the published postmortem on the status page.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "proxmoxClusters": { "description": "List of Proxmox clusters affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "remediationNotes": { "description": "Notes on how to remediate this incident. This is in markdown.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "rootCause": { "description": "What is the root cause of this incident?", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "serviceLevelObjectives": { "description": "List of Service Level Objectives (SLOs) affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "services": { "description": "List of services affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "showPostmortemOnStatusPage": { "default": false, "description": "Should the postmortem note and attachments be visible on the status page once published?", "example": true, "type": "boolean" }, "statusPages": { "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.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "storageArrays": { "description": "List of storage arrays affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "telemetryQuery": { "description": "Telemetry query for this incident.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "title": { "description": "Title of this incident.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "vmwareVCenters": { "description": "List of vCenters affected by this incident.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "update_incident", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Incident Alert to update. Required. Use list_incident_alerts to find IDs.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "update_incident_alert", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "attachments": { "description": "Files attached to this note.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "id": { "description": "The unique identifier (UUID) of the Incident Internal Note to update. Required. Use list_incident_internal_notes to find IDs.", "type": "string" }, "note": { "description": "Notes in markdown.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "postedAt": { "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.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" } }, "required": [ "id" ], "type": "object" }, "name": "update_incident_internal_note", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "attachments": { "description": "Files attached to this note.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "id": { "description": "The unique identifier (UUID) of the Incident Public Note to update. Required. Use list_incident_public_notes to find IDs.", "type": "string" }, "note": { "description": "Notes in markdown.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "postedAt": { "description": "Date and time when the note was posted.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" } }, "required": [ "id" ], "type": "object" }, "name": "update_incident_public_note", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "color": { "description": "Color of this resource in Hex (#32a852 for example).", "example": { "_type": "Color", "value": "#ff0000" }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "id": { "description": "The unique identifier (UUID) of the Incident Severity to update. Required. Use list_incident_severities to find IDs.", "type": "string" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "order": { "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.", "example": 10, "type": "integer" } }, "required": [ "id" ], "type": "object" }, "name": "update_incident_severity", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "color": { "description": "Color of this resource in Hex (#32a852 for example).", "example": { "_type": "Color", "value": "#ff0000" }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "id": { "description": "The unique identifier (UUID) of the Incident State to update. Required. Use list_incident_states to find IDs.", "type": "string" }, "isAcknowledgedState": { "description": "Is it the acknowledged state of the incident?", "example": true, "type": "boolean" }, "isCreatedState": { "description": "Is it the created state of the incident?", "example": true, "type": "boolean" }, "isResolvedState": { "description": "Is it the resolved state of the incident?", "example": true, "type": "boolean" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "order": { "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.", "example": 10, "type": "integer" } }, "required": [ "id" ], "type": "object" }, "name": "update_incident_state", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Incident State Timeline to update. Required. Use list_incident_state_timelines to find IDs.", "type": "string" }, "incidentStateId": { "description": "Incident State ID Relation. Which incident state does this incident change to?", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "startsAt": { "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.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" } }, "required": [ "id" ], "type": "object" }, "name": "update_incident_state_timeline", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "color": { "description": "Color of this resource in Hex (#32a852 for example).", "example": { "_type": "Color", "value": "#ff0000" }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "id": { "description": "The unique identifier (UUID) of the Label to update. Required. Use list_labels to find IDs.", "type": "string" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "update_label", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "cephClusters": { "description": "Ceph clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "currentMonitorStatusId": { "description": "Whats the current status ID of this monitor?", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "customFields": { "description": "Custom Fields on this resource.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "databaseServers": { "description": "Databases this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "dependsOnMonitors": { "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.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "Friendly description that will help you remember.", "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.", "type": "string" }, "disableActiveMonitoring": { "default": false, "description": "Disable active monitoring for this resource?", "example": true, "type": "boolean" }, "dockerHosts": { "description": "Docker hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "dockerSwarmClusters": { "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.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "hosts": { "description": "Hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "id": { "description": "The unique identifier (UUID) of the Monitor to update. Required. Use list_monitors to find IDs.", "type": "string" }, "incomingEmailCustomLocalPart": { "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.", "example": "Example short text", "type": "string" }, "iotFleets": { "description": "IoT fleets this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "isArchived": { "default": false, "description": "Archived monitors are hidden from monitor lists and status pages, are not checked, and open no incidents or alerts. Unarchiving resumes monitoring.", "example": true, "type": "boolean" }, "kubernetesClusters": { "description": "Kubernetes clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "labels": { "description": "Relation to Labels Array where this object is categorized in.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "minimumProbeAgreement": { "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.", "example": 42, "type": "number" }, "monitorSteps": { "description": "What would you like to monitor and what is the criteria?", "example": { "_type": "MonitorSteps", "value": { "monitorStepsInstanceArray": [] } }, "type": "object" }, "monitorTemplateId": { "description": "ID of the Monitor Template this monitor was created from. Null for monitors not created from a template.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "monitoringInterval": { "description": "How often would you like OneUptime to monitor this resource? A 5-field cron expression, not a label: \"*/5 * * * *\" is every five minutes.", "example": "Example short text", "type": "string" }, "name": { "description": "Any friendly name for this monitor.", "example": "Example short text", "type": "string" }, "podmanHosts": { "description": "Podman hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "proxmoxClusters": { "description": "Proxmox clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "services": { "description": "Services this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "storageArrays": { "description": "Storage arrays this monitor watches. Incidents and alerts it creates are linked to them.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "suppressAlertsWhenParentMonitorStatuses": { "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.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "vmwareVCenters": { "description": "VMware vCenters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "update_monitor", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "color": { "description": "Color of this resource in Hex (#32a852 for example).", "example": { "_type": "Color", "value": "#ff0000" }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "id": { "description": "The unique identifier (UUID) of the Monitor Status to update. Required. Use list_monitor_statuses to find IDs.", "type": "string" }, "isOfflineState": { "default": false, "description": "Is this monitor in offline state?", "example": true, "type": "boolean" }, "isOperationalState": { "default": false, "description": "Is this monitor in operational state?", "example": true, "type": "boolean" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "priority": { "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.", "example": 42, "type": "number" } }, "required": [ "id" ], "type": "object" }, "name": "update_monitor_status", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Monitor Status Event to update. Required. Use list_monitor_status_events to find IDs.", "type": "string" }, "monitorStatusId": { "description": "Relation to Monitor Status ID Resource in which this object belongs.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "update_monitor_status_event", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "customFields": { "description": "Custom Fields on this resource.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "id": { "description": "The unique identifier (UUID) of the On-Call Policy to update. Required. Use list_on_call_duty_policies to find IDs.", "type": "string" }, "isArchived": { "default": false, "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.", "example": true, "type": "boolean" }, "labels": { "description": "Relation to Labels Array where this object is categorized in.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "repeatPolicyIfNoOneAcknowledges": { "default": false, "description": "Repeat the policy if no one acknowledges the alert.", "example": true, "type": "boolean" }, "repeatPolicyIfNoOneAcknowledgesNoOfTimes": { "default": 0, "description": "Repeat the policy X number of times if no one acknowledges the alert.", "example": 42, "type": "number" } }, "required": [ "id" ], "type": "object" }, "name": "update_on_call_policy", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "cephClusters": { "description": "List of Ceph clusters affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "changeMonitorStatusToId": { "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.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "currentScheduledMaintenanceStateId": { "description": "Scheduled Maintenance State ID. The state the event currently is in.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "customFields": { "description": "Custom Fields on this resource.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "databaseServers": { "description": "List of databases affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "Description of this scheduled event that will show up on Status Page. This is in markdown.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "dockerHosts": { "description": "List of Docker hosts affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "dockerSwarmClusters": { "description": "List of Docker Swarm clusters affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "enableReminders": { "default": 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.", "example": true, "type": "boolean" }, "endsAt": { "description": "When does this event end?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "hosts": { "description": "List of hosts affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "id": { "description": "The unique identifier (UUID) of the Scheduled Maintenance Event to update. Required. Use list_scheduled_maintenance_events to find IDs.", "type": "string" }, "iotFleets": { "description": "List of IoT fleets affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "isVisibleOnStatusPage": { "default": true, "description": "Should this incident be visible on the status page?", "example": true, "type": "boolean" }, "kubernetesClusters": { "description": "List of Kubernetes clusters affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "labels": { "description": "Relation to Labels Array where this object is categorized in.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "monitors": { "description": "List of monitors attached to this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "networkSites": { "description": "List of network sites affected by this event. Their descendants are covered too.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "nextSubscriberNotificationBeforeTheEventAt": { "description": "When will the next notification to subscribers be sent out?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "podmanHosts": { "description": "List of Podman hosts affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "proxmoxClusters": { "description": "List of Proxmox clusters affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "sendSubscriberNotificationsOnBeforeTheEvent": { "description": "Should subscribers be notified before the event?", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "services": { "description": "List of services affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "startsAt": { "description": "When does this event start?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "statusPages": { "description": "List of status pages to show this event on.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "storageArrays": { "description": "List of storage arrays affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "title": { "description": "Title of this scheduled event.", "example": "Example short text", "type": "string" }, "vmwareVCenters": { "description": "List of vCenters affected by this event.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "name": "update_scheduled_maintenance_event", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "color": { "description": "Color of this resource in Hex (#32a852 for example).", "example": { "_type": "Color", "value": "#ff0000" }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "id": { "description": "The unique identifier (UUID) of the Scheduled Maintenance State to update. Required. Use list_scheduled_maintenance_states to find IDs.", "type": "string" }, "isEndedState": { "default": false, "description": "Is this state a ended state?", "example": true, "type": "boolean" }, "isOngoingState": { "default": false, "description": "Is this state a ongoing state?", "example": true, "type": "boolean" }, "isResolvedState": { "default": false, "description": "Is this state a resolved state?", "example": true, "type": "boolean" }, "isScheduledState": { "default": false, "description": "Is this state a scheduled state?", "example": true, "type": "boolean" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "order": { "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.", "example": 10, "type": "integer" } }, "required": [ "id" ], "type": "object" }, "name": "update_scheduled_maintenance_state", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Scheduled Maintenance State Timeline to update. Required. Use list_scheduled_maintenance_state_timelines to find IDs.", "type": "string" }, "scheduledMaintenanceStateId": { "description": " Scheduled Maintenance State ID. Which state does this event belongs to?", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "startsAt": { "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.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" } }, "required": [ "id" ], "type": "object" }, "name": "update_scheduled_maintenance_state_timeline", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "assignedToTeamId": { "description": "ID of the team whose queue the case is in.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "assignedToUserId": { "description": "ID of the person working the case.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "closingNote": { "description": "Why the case was closed the way it was, in Markdown: what was found and what was done.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "description": { "description": "What is known about the threat, in Markdown. A case opened by a detection starts with the detection's description.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "entities": { "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.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "id": { "description": "The unique identifier (UUID) of the Security Case to update. Required. Use list_security_cases to find IDs.", "type": "string" }, "labels": { "description": "Labels to filter and report on cases by.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "mitreTactics": { "description": "ATT&CK tactic ids (TA0006) the case's detections are tagged with.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "mitreTechniques": { "description": "ATT&CK technique ids (T1110) the case's detections are tagged with.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "priority": { "default": "Medium", "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.", "example": "Example short text", "type": "string" }, "status": { "default": "New", "description": "New, Investigating, Contained or Closed. Every case starts New; closing it records a verdict.", "example": "Example short text", "type": "string" }, "title": { "description": "What the case is about, in a line.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "verdict": { "description": "What the case turned out to be, set when it is closed: True Positive, Benign Positive, False Positive or Undetermined.", "example": "Example short text", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "update_security_case", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Security Case Note to update. Required. Use list_security_case_notes to find IDs.", "type": "string" }, "note": { "description": "The note, in Markdown.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "update_security_case_note", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "id": { "description": "The unique identifier (UUID) of the Security Detection to update. Required. Use list_security_detections to find IDs.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "update_security_detection", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "description": { "description": "When to use the playbook and what it is for.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "detectionRuleIds": { "description": "Run only on cases with a detection from one of these detection rules. Empty runs on cases from any rule.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "detectionSource": { "description": "Run only on cases raised by this source: a Detection Rule, Threat Intel or a Connected Product. Empty runs on every source.", "example": "Example short text", "type": "string" }, "id": { "description": "The unique identifier (UUID) of the Security Playbook to update. Required. Use list_security_playbooks to find IDs.", "type": "string" }, "isEnabled": { "default": true, "description": "Whether the playbook runs on its own. A disabled playbook can still be run by hand from a case.", "example": true, "type": "boolean" }, "minimumPriority": { "description": "Run only on cases at this priority or above. Empty runs on every priority.", "example": "Example short text", "type": "string" }, "name": { "description": "What the playbook does, in a few words.", "example": { "_type": "Name", "value": "John Doe" }, "type": "object" }, "steps": { "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.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "trigger": { "default": "Case Opened", "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).", "example": "Example short text", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "update_security_playbook", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "allowSubscribersToChooseEventTypes": { "default": false, "description": "Can subscribers choose which event type like Announcements, Incidents, Scheduled Events to subscribe to?", "example": true, "type": "boolean" }, "allowSubscribersToChooseResources": { "default": false, "description": "Can subscribers choose which resources to subscribe to?", "example": true, "type": "boolean" }, "allowedSubscriberEmailDomains": { "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.", "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.", "type": "string" }, "callSmsConfigId": { "description": "ID of your Call/SMS Config Resource which is used to send SMS to subscribers.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "copyrightText": { "description": "Copyright Text.", "example": "Example short text", "type": "string" }, "coverImageAltText": { "description": "Alternative text for the cover image, read by screen readers for accessibility. Leave blank if the cover image is purely decorative.", "example": "Example short text", "type": "string" }, "coverImageFileId": { "description": "Status Page Cover Image ID.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "customCSS": { "description": "Status Page Custom CSS. Served only from a verified custom domain.", "example": "body { color: #333; margin: 0; }", "type": "string" }, "customFields": { "description": "Custom Fields on this resource.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "customJavaScript": { "description": "Status Page Custom JavaScript. This runs when the status page is loaded from a verified custom domain.", "example": "function example() { return true; }", "type": "string" }, "defaultBarColor": { "description": "Default color of the bar on the overview page.", "example": { "_type": "Color", "value": "#ff0000" }, "type": "object" }, "defaultLanguage": { "default": "en", "description": "Default language that the status page is shown in when a visitor arrives for the first time.", "example": "Example short text", "type": "string" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "embeddedOverallStatusToken": { "description": "Security token required to access the embedded overall status badge. This token must be provided in the URL.", "example": "Example short text", "type": "string" }, "enableCustomSubscriberEmailNotificationFooterText": { "default": false, "description": "Enable custom footer text in subscriber email notifications.", "example": true, "type": "boolean" }, "enableEmailSubscribers": { "default": true, "description": "Can email subscribers subscribe to this Status Page?", "example": true, "type": "boolean" }, "enableEmbeddedOverallStatus": { "default": false, "description": "Enable embedded overall status badge that can be displayed on external websites?", "example": true, "type": "boolean" }, "enableMasterPassword": { "default": false, "description": "Require visitors to enter a master password before viewing a private status page.", "example": true, "type": "boolean" }, "enableMcpServer": { "default": 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.", "example": true, "type": "boolean" }, "enableMicrosoftTeamsSubscribers": { "default": false, "description": "Can Microsoft Teams subscribers subscribe to this Status Page?", "example": true, "type": "boolean" }, "enableSearchEngineIndexing": { "default": 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.", "example": true, "type": "boolean" }, "enableSlackSubscribers": { "default": false, "description": "Can Slack subscribers subscribe to this Status Page?", "example": true, "type": "boolean" }, "enableSmsSubscribers": { "default": false, "description": "Can SMS subscribers subscribe to this Status Page?", "example": true, "type": "boolean" }, "enableWebhookSubscribers": { "default": false, "description": "Can Webhook subscribers subscribe to this Status Page?", "example": true, "type": "boolean" }, "enabledLanguages": { "description": "Languages offered in the footer language switcher. Leave empty to offer all supported languages.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "faviconFileId": { "description": "Status Page Favicon File ID.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "footerHTML": { "description": "Status Page Custom HTML Footer. Served only from a verified custom domain.", "example": "<div><h1>Title</h1><p>Content</p></div>", "type": "string" }, "headerHTML": { "description": "Status Page Custom HTML Header. Served only from a verified custom domain.", "example": "<div><h1>Title</h1><p>Content</p></div>", "type": "string" }, "hidePoweredByOneUptimeBranding": { "default": false, "description": "Hide Powered By OneUptime Branding?", "example": true, "type": "boolean" }, "id": { "description": "The unique identifier (UUID) of the Status Page to update. Required. Use list_status_pages to find IDs.", "type": "string" }, "ipWhitelist": { "description": "IP Whitelist for this Status Page. One IP per line. Only used if the status page is private.", "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.", "type": "string" }, "isArchived": { "default": false, "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.", "example": true, "type": "boolean" }, "isPublicStatusPage": { "default": true, "description": "Is this status page public?", "example": true, "type": "boolean" }, "isReportEnabled": { "default": false, "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.", "example": true, "type": "boolean" }, "labels": { "description": "Relation to Labels Array where this object is categorized in.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "limitSubscribersToPrivateUsers": { "default": false, "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.", "example": true, "type": "boolean" }, "logoAltText": { "description": "Alternative text for the logo image, read by screen readers for accessibility.", "example": "Example short text", "type": "string" }, "logoFileId": { "description": "Status Page Logo File ID.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "masterPassword": { "description": "Password required to unlock a private status page. This value is stored as a secure hash.", "example": "hashed_string_value", "format": "password", "type": "string" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" }, "onlyShowScopedIncidents": { "default": false, "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.", "example": true, "type": "boolean" }, "overallUptimePercentPrecision": { "default": "99.99% (Two Decimal)", "description": "Overall Precision of uptime percent for this status page.", "example": "Example short text", "type": "string" }, "overviewPageDescription": { "description": "Overview Page description for your status page. This is a markdown field.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "pageDescription": { "description": "Description of your Status Page. This is used for SEO.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "pageTitle": { "description": "Title of your Status Page. This is used for SEO.", "example": "Example short text", "type": "string" }, "privateUserSessionLengthInHours": { "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.", "example": 42, "type": "number" }, "reportDataInDays": { "default": 30, "description": "How many days of data should be included in the report?", "example": 42, "type": "number" }, "reportPeriodType": { "default": "Rolling", "description": "Should the report cover a rolling number of days, or the previous whole calendar period?", "example": "Example short text", "type": "string" }, "reportRecurringInterval": { "description": "How often a report goes out. Left out when reports are turned on, it is every month.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "reportStartDateTime": { "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.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "reportTimezone": { "default": "UTC", "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.", "example": "Example short text", "type": "string" }, "requireSsoForLogin": { "default": false, "description": "Should SSO be required to login to Private Status Page.", "example": true, "type": "boolean" }, "sendNextReportBy": { "description": "When the next report goes out. The server works it out from the schedule.", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "sendSubscriberNotifications": { "default": 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.", "example": true, "type": "boolean" }, "showAnnouncementHistoryInDays": { "default": 14, "description": "How many days of announcement history should be shown on the status page (in days)?", "example": 42, "type": "number" }, "showAnnouncementsOnStatusPage": { "default": true, "description": "Show Announcements on Status Page?", "example": true, "type": "boolean" }, "showEpisodeHistoryInDays": { "default": 14, "description": "How many days of episode history to show on the status page.", "example": 42, "type": "number" }, "showEpisodeLabelsOnStatusPage": { "default": false, "description": "Show Episode Labels on Status Page?", "example": true, "type": "boolean" }, "showEpisodesOnStatusPage": { "default": true, "description": "Show Incident Episodes on Status Page?", "example": true, "type": "boolean" }, "showIncidentHistoryInDays": { "default": 14, "description": "How many days of incident history should be shown on the status page (in days)?", "example": 42, "type": "number" }, "showIncidentLabelsOnStatusPage": { "default": false, "description": "Show Incident Labels on Status Page?", "example": true, "type": "boolean" }, "showIncidentsOnStatusPage": { "default": true, "description": "Show Incidents on Status Page?", "example": true, "type": "boolean" }, "showOverallUptimePercentOnStatusPage": { "default": false, "description": "Show Overall Uptime Percent on Status Page?", "example": true, "type": "boolean" }, "showScheduledEventHistoryInDays": { "default": 14, "description": "How many days of scheduled event history should be shown on the status page (in days)?", "example": 42, "type": "number" }, "showScheduledEventLabelsOnStatusPage": { "default": false, "description": "Show Scheduled Event Labels on Status Page?", "example": true, "type": "boolean" }, "showScheduledMaintenanceEventsOnStatusPage": { "default": true, "description": "Show Scheduled Maintenance Events on Status Page?", "example": true, "type": "boolean" }, "showSubscriberPageOnStatusPage": { "default": true, "description": "Show Subscriber Page on Status Page?", "example": true, "type": "boolean" }, "showUptimeHistoryInDays": { "default": 90, "description": "How many days of uptime history should be shown on the status page? Maximum is 90 days.", "example": 42, "type": "number" }, "smtpConfigId": { "description": "ID of your SMTP Config Resource which is used to send email to subscribers.", "example": "123e4567-e89b-12d3-a456-426614174000", "format": "uuid", "type": "string" }, "subscriberEmailNotificationFooterText": { "description": "Text to send to subscribers in the footer of the email.", "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.", "type": "string" }, "subscriberTimezones": { "description": "Timezones of subscribers to this status page.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "theme": { "default": "Light", "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.", "example": "Example short text", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "update_status_page", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "attachments": { "description": "Files attached to this announcement.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "description": "Text of the announcement. This can be in Markdown format.", "example": "# Heading\n\nThis is **markdown** content", "type": "string" }, "endAnnouncementAt": { "description": "When should this announcement hidden?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "id": { "description": "The unique identifier (UUID) of the Status Page Announcement to update. Required. Use list_status_page_announcements to find IDs.", "type": "string" }, "monitors": { "description": "List of monitors affected by this announcement. If none are selected, all subscribers will be notified.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "showAnnouncementAt": { "description": "When should this announcement be shown?", "example": { "_type": "DateTime", "value": "2023-10-01T12:00:00Z" }, "type": "object" }, "statusPages": { "description": "Status Pages to show show this announcement on.", "example": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" }, "title": { "description": "Title of this resource.", "example": "Example short text", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "update_status_page_announcement", "outputSchema": null }, { "description": "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.", "inputSchema": { "additionalProperties": false, "properties": { "customFields": { "description": "Custom Fields on this resource.", "example": { "key": "value", "nested": { "data": 123 } }, "type": "object" }, "description": { "description": "Friendly description that will help you remember.", "example": "This is an example of longer text content that might be stored in this field.", "type": "string" }, "id": { "description": "The unique identifier (UUID) of the Team to update. Required. Use list_teams to find IDs.", "type": "string" }, "name": { "description": "Any friendly name of this object.", "example": "Example short text", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "update_team", "outputSchema": null } ] }
Verify it yourselfcurl -s https://api.teppi.xyz/v1/evidence/sha256:9632d559654a2bccb700fb1815dc409f517cc5353f93c48a943e4efefe9854df | sha256sum