Name: OneUptime
Author: oneuptime

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
name	string	yes	Any friendly name of this object.
description	string	no	Friendly description that will help you remember.
customFields	object	no	Custom Fields on this resource.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Team to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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.

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

Parameter	Type	Required	Notes
query	object	no	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, Gr
select	array	no	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.
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

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

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Team to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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, IsNul

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.

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

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

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

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

Parameter	Type	Required	Notes
query	object	no	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, G
select	array	no	Optional: field names to return for each Label (e.g. ["_id", "name"]). Omit to get all readable fields.
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

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

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Label to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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, IsNu

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of the project this case belongs to.
title	string	yes	What the case is about, in a line.
description	string	no	What is known about the threat, in Markdown. A case opened by a detection starts with the detection's description.
status	string	no	New, Investigating, Contained or Closed. Every case starts New; closing it records a verdict.
priority	string	no	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.
verdict	string	no	What the case turned out to be, set when it is closed: True Positive, Benign Positive, False Positive or Undetermined.
closingNote	string	no	Why the case was closed the way it was, in Markdown: what was found and what was done.
assignedToUserId	string	no	ID of the person working the case.
assignedToTeamId	string	no	ID of the team whose queue the case is in.
entities	object	no	The users, hosts, IP addresses, domains and files the case is about, each as { type, value }. Detections add theirs as they join the case.
mitreTactics	object	no	ATT&CK tactic ids (TA0006) the case's detections are tagged with.
mitreTechniques	object	no	ATT&CK technique ids (T1110) the case's detections are tagged with.
labels	array	no	Labels to filter and report on cases by.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Security Case to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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,

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.

Parameter	Type	Required	Notes
query	object	no	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, EqualToO
select	array	no	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,
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Security Case to update. Required. Use list_security_cases to find IDs.
title	string	no	What the case is about, in a line.
description	string	no	What is known about the threat, in Markdown. A case opened by a detection starts with the detection's description.
status	string	no	New, Investigating, Contained or Closed. Every case starts New; closing it records a verdict.
priority	string	no	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.
verdict	string	no	What the case turned out to be, set when it is closed: True Positive, Benign Positive, False Positive or Undetermined.
closingNote	string	no	Why the case was closed the way it was, in Markdown: what was found and what was done.
assignedToUserId	string	no	ID of the person working the case.
assignedToTeamId	string	no	ID of the team whose queue the case is in.
entities	object	no	The users, hosts, IP addresses, domains and files the case is about, each as { type, value }. Detections add theirs as they join the case.
mitreTactics	object	no	ATT&CK tactic ids (TA0006) the case's detections are tagged with.
mitreTechniques	object	no	ATT&CK technique ids (T1110) the case's detections are tagged with.
labels	array	no	Labels to filter and report on cases by.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Security Case to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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, NotEqu

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of the project this note belongs to.
securityCaseId	string	yes	ID of the case this note is on.
note	string	yes	The note, in Markdown.

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.

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

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.

Parameter	Type	Required	Notes
query	object	no	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, Equ
select	array	no	Optional: field names to return for each Security Case Note (e.g. ["_id", "name"]). Omit to get all readable fields.
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Security Case Note to update. Required. Use list_security_case_notes to find IDs.
note	string	no	The note, in Markdown.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Security Case Note to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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, N

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.

No parameter schema on file.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Security Detection to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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, mitreTac

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.

Parameter	Type	Required	Notes
query	object	no	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, Equ
select	array	no	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, mitreTac
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Security Detection to update. Required. Use list_security_detections to find IDs.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Security Detection to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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, N

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of the project this playbook belongs to.
name	object	yes	What the playbook does, in a few words.
description	string	no	When to use the playbook and what it is for.
isEnabled	boolean	no	Whether the playbook runs on its own. A disabled playbook can still be run by hand from a case.
trigger	string	no	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).
minimumPriority	string	no	Run only on cases at this priority or above. Empty runs on every priority.
detectionSource	string	no	Run only on cases raised by this source: a Detection Rule, Threat Intel or a Connected Product. Empty runs on every source.
detectionRuleIds	object	no	Run only on cases with a detection from one of these detection rules. Empty runs on cases from any rule.
steps	object	no	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.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Security Playbook to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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, s

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.

Parameter	Type	Required	Notes
query	object	no	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, Equa
select	array	no	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, s
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Security Playbook to update. Required. Use list_security_playbooks to find IDs.
name	object	no	What the playbook does, in a few words.
description	string	no	When to use the playbook and what it is for.
isEnabled	boolean	no	Whether the playbook runs on its own. A disabled playbook can still be run by hand from a case.
trigger	string	no	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).
minimumPriority	string	no	Run only on cases at this priority or above. Empty runs on every priority.
detectionSource	string	no	Run only on cases raised by this source: a Detection Rule, Threat Intel or a Connected Product. Empty runs on every source.
detectionRuleIds	object	no	Run only on cases with a detection from one of these detection rules. Empty runs on cases from any rule.
steps	object	no	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.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Security Playbook to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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, No

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
name	string	yes	Any friendly name of this object.
pageTitle	string	no	Title of your Status Page. This is used for SEO.
pageDescription	string	no	Description of your Status Page. This is used for SEO.
enableSearchEngineIndexing	boolean	no	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.
description	string	no	Friendly description that will help you remember.
labels	array	no	Relation to Labels Array where this object is categorized in.
isArchived	boolean	no	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.
faviconFileId	string	no	Status Page Favicon File ID.
logoFileId	string	no	Status Page Logo File ID.
coverImageFileId	string	no	Status Page Cover Image ID.
headerHTML	string	no	Status Page Custom HTML Header. Served only from a verified custom domain.
footerHTML	string	no	Status Page Custom HTML Footer. Served only from a verified custom domain.
customCSS	string	no	Status Page Custom CSS. Served only from a verified custom domain.
customJavaScript	string	no	Status Page Custom JavaScript. This runs when the status page is loaded from a verified custom domain.
isPublicStatusPage	boolean	no	Is this status page public?
enableMcpServer	boolean	no	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.
enableMasterPassword	boolean	no	Require visitors to enter a master password before viewing a private status page.
masterPassword	string	no	Password required to unlock a private status page. This value is stored as a secure hash.
showIncidentLabelsOnStatusPage	boolean	no	Show Incident Labels on Status Page?

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Status Page to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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, a

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.

Parameter	Type	Required	Notes
query	object	no	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, EqualToOrN
select	array	no	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, a
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Status Page to update. Required. Use list_status_pages to find IDs.
name	string	no	Any friendly name of this object.
pageTitle	string	no	Title of your Status Page. This is used for SEO.
pageDescription	string	no	Description of your Status Page. This is used for SEO.
enableSearchEngineIndexing	boolean	no	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.
description	string	no	Friendly description that will help you remember.
labels	array	no	Relation to Labels Array where this object is categorized in.
isArchived	boolean	no	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.
faviconFileId	string	no	Status Page Favicon File ID.
logoFileId	string	no	Status Page Logo File ID.
coverImageFileId	string	no	Status Page Cover Image ID.
headerHTML	string	no	Status Page Custom HTML Header. Served only from a verified custom domain.
footerHTML	string	no	Status Page Custom HTML Footer. Served only from a verified custom domain.
customCSS	string	no	Status Page Custom CSS. Served only from a verified custom domain.
customJavaScript	string	no	Status Page Custom JavaScript. This runs when the status page is loaded from a verified custom domain.
isPublicStatusPage	boolean	no	Is this status page public?
enableMcpServer	boolean	no	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.
enableMasterPassword	boolean	no	Require visitors to enter a master password before viewing a private status page.
masterPassword	string	no	Password required to unlock a private status page. This value is stored as a secure hash.
showIncidentLabelsOnStatusPage	boolean	no	Show Incident Labels on Status Page?

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Status Page to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
name	string	yes	Any friendly name of this object.
labels	array	no	Relation to Labels Array where this object is categorized in.
description	string	no	Friendly description that will help you remember.
isArchived	boolean	no	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.
repeatPolicyIfNoOneAcknowledges	boolean	no	Repeat the policy if no one acknowledges the alert.
repeatPolicyIfNoOneAcknowledgesNoOfTimes	number	no	Repeat the policy X number of times if no one acknowledges the alert.
acknowledgementTimeoutInMinutes	number	no	Page again when something this policy paged about is acknowledged but not resolved within this many minutes (5 to 1440). Empty: never.
customFields	object	no	Custom Fields on this resource.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the On-Call Policy to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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.

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.

Parameter	Type	Required	Notes
query	object	no	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, E
select	array	no	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.
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the On-Call Policy to update. Required. Use list_on_call_duty_policies to find IDs.
name	string	no	Any friendly name of this object.
labels	array	no	Relation to Labels Array where this object is categorized in.
description	string	no	Friendly description that will help you remember.
isArchived	boolean	no	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.
repeatPolicyIfNoOneAcknowledges	boolean	no	Repeat the policy if no one acknowledges the alert.
repeatPolicyIfNoOneAcknowledgesNoOfTimes	number	no	Repeat the policy X number of times if no one acknowledges the alert.
acknowledgementTimeoutInMinutes	number	no	Page again when something this policy paged about is acknowledged but not resolved within this many minutes (5 to 1440). Empty: never.
customFields	object	no	Custom Fields on this resource.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the On-Call Policy to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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,

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
name	string	yes	Any friendly name for this monitor.
description	string	no	Friendly description that will help you remember.
isArchived	boolean	no	Archived monitors are hidden from monitor lists and status pages, are not checked, and open no incidents or alerts. Unarchiving resumes monitoring.
labels	array	no	Relation to Labels Array where this object is categorized in.
dependsOnMonitors	array	no	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 monit
suppressAlertsWhenParentMonitorStatuses	array	no	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.
hosts	array	no	Hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
kubernetesClusters	array	no	Kubernetes clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
dockerHosts	array	no	Docker hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
podmanHosts	array	no	Podman hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
proxmoxClusters	array	no	Proxmox clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
vmwareVCenters	array	no	VMware vCenters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
cephClusters	array	no	Ceph clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
storageArrays	array	no	Storage arrays this monitor watches. Incidents and alerts it creates are linked to them.
dockerSwarmClusters	array	no	Docker Swarm clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
iotFleets	array	no	IoT fleets this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
databaseServers	array	no	Databases this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
services	array	no	Services this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
monitorTemplateId	string	no	ID of the Monitor Template this monitor was created from. Null for monitors not created from a template.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Monitor to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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, in

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

Parameter	Type	Required	Notes
query	object	no	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,
select	array	no	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, in
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Monitor to update. Required. Use list_monitors to find IDs.
name	string	no	Any friendly name for this monitor.
description	string	no	Friendly description that will help you remember.
isArchived	boolean	no	Archived monitors are hidden from monitor lists and status pages, are not checked, and open no incidents or alerts. Unarchiving resumes monitoring.
labels	array	no	Relation to Labels Array where this object is categorized in.
dependsOnMonitors	array	no	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 monit
suppressAlertsWhenParentMonitorStatuses	array	no	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.
hosts	array	no	Hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
kubernetesClusters	array	no	Kubernetes clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
dockerHosts	array	no	Docker hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
podmanHosts	array	no	Podman hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
proxmoxClusters	array	no	Proxmox clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
vmwareVCenters	array	no	VMware vCenters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
cephClusters	array	no	Ceph clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
storageArrays	array	no	Storage arrays this monitor watches. Incidents and alerts it creates are linked to them.
dockerSwarmClusters	array	no	Docker Swarm clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
iotFleets	array	no	IoT fleets this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
databaseServers	array	no	Databases this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
services	array	no	Services this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there.
monitorTemplateId	string	no	ID of the Monitor Template this monitor was created from. Null for monitors not created from a template.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Monitor to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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, Is

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
name	string	yes	Any friendly name of this object.
description	string	no	Friendly description that will help you remember.
color	object	yes	Color of this resource in Hex (#32a852 for example).
isOperationalState	boolean	no	Is this monitor in operational state?
isOfflineState	boolean	no	Is this monitor in offline state?
priority	number	no	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 grou
isArchived	boolean	no	Archived statuses stay on the monitors that are in them, but can't be picked again. The operational and offline statuses can't be archived.

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

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

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.

Parameter	Type	Required	Notes
query	object	no	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, EqualT
select	array	no	Optional: field names to return for each Monitor Status (e.g. ["_id", "name"]). Omit to get all readable fields.
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Monitor Status to update. Required. Use list_monitor_statuses to find IDs.
name	string	no	Any friendly name of this object.
description	string	no	Friendly description that will help you remember.
color	object	no	Color of this resource in Hex (#32a852 for example).
isOperationalState	boolean	no	Is this monitor in operational state?
isOfflineState	boolean	no	Is this monitor in offline state?
priority	number	no	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 grou
isArchived	boolean	no	Archived statuses stay on the monitors that are in them, but can't be picked again. The operational and offline statuses can't be archived.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Monitor Status to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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, NotE

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
name	string	yes	Any friendly name of this object.
description	string	no	Friendly description that will help you remember.
color	object	yes	Color of this resource in Hex (#32a852 for example).
isCreatedState	boolean	no	Is it the created state of the incident?
isAcknowledgedState	boolean	no	Is it the acknowledged state of the incident?
isResolvedState	boolean	no	Is it the resolved state of the incident?
order	integer	no	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
isArchived	boolean	no	Archived states stay on the incidents and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived.

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

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

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.

Parameter	Type	Required	Notes
query	object	no	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, EqualTo
select	array	no	Optional: field names to return for each Incident State (e.g. ["_id", "name"]). Omit to get all readable fields.
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident State to update. Required. Use list_incident_states to find IDs.
name	string	no	Any friendly name of this object.
description	string	no	Friendly description that will help you remember.
color	object	no	Color of this resource in Hex (#32a852 for example).
isCreatedState	boolean	no	Is it the created state of the incident?
isAcknowledgedState	boolean	no	Is it the acknowledged state of the incident?
isResolvedState	boolean	no	Is it the resolved state of the incident?
order	integer	no	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
isArchived	boolean	no	Archived states stay on the incidents and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident State to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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, NotEq

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
title	string	yes	Title of this incident.
description	string	no	Short description of this incident. This is in markdown and will be visible on the status page.
declaredAt	object	no	Date and time when this incident was declared.
impactStartedAt	object	no	When customer impact actually began. Left blank until someone records it - never inferred, because a guessed value is worse than no value.
monitors	array	no	List of monitors affected by this incident.
hosts	array	no	List of hosts affected by this incident.
kubernetesClusters	array	no	List of Kubernetes clusters affected by this incident.
kubernetesResources	array	no	List of Kubernetes resources (pods, deployments, nodes, etc.) affected by this incident.
kubernetesContainers	array	no	List of Kubernetes containers affected by this incident.
dockerHosts	array	no	List of Docker hosts affected by this incident.
podmanHosts	array	no	List of Podman hosts affected by this incident.
proxmoxClusters	array	no	List of Proxmox clusters affected by this incident.
vmwareVCenters	array	no	List of vCenters affected by this incident.
iotFleets	array	no	List of IoT fleets affected by this incident.
dockerSwarmClusters	array	no	List of Docker Swarm clusters affected by this incident.
cephClusters	array	no	List of Ceph clusters affected by this incident.
storageArrays	array	no	List of storage arrays affected by this incident.
databaseServers	array	no	List of databases affected by this incident.
dockerResources	array	no	List of Docker resources (containers, images, networks, volumes) affected by this incident.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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): subscriberNotificationStatus

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

Parameter	Type	Required	Notes
query	object	no	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
select	array	no	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): subscriberNotificationStatus
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident to update. Required. Use list_incidents to find IDs.
title	string	no	Title of this incident.
description	string	no	Short description of this incident. This is in markdown and will be visible on the status page.
declaredAt	object	no	Date and time when this incident was declared.
impactStartedAt	object	no	When customer impact actually began. Left blank until someone records it - never inferred, because a guessed value is worse than no value.
monitors	array	no	List of monitors affected by this incident.
hosts	array	no	List of hosts affected by this incident.
kubernetesClusters	array	no	List of Kubernetes clusters affected by this incident.
kubernetesResources	array	no	List of Kubernetes resources (pods, deployments, nodes, etc.) affected by this incident.
kubernetesContainers	array	no	List of Kubernetes containers affected by this incident.
dockerHosts	array	no	List of Docker hosts affected by this incident.
podmanHosts	array	no	List of Podman hosts affected by this incident.
proxmoxClusters	array	no	List of Proxmox clusters affected by this incident.
vmwareVCenters	array	no	List of vCenters affected by this incident.
iotFleets	array	no	List of IoT fleets affected by this incident.
dockerSwarmClusters	array	no	List of Docker Swarm clusters affected by this incident.
cephClusters	array	no	List of Ceph clusters affected by this incident.
storageArrays	array	no	List of storage arrays affected by this incident.
databaseServers	array	no	List of databases affected by this incident.
dockerResources	array	no	List of Docker resources (containers, images, networks, volumes) affected by this incident.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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, I

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
incidentId	string	yes	Relation to Incident ID in which this resource belongs.
incidentStateId	string	yes	Incident State ID Relation. Which incident state does this incident change to?
shouldStatusPageSubscribersBeNotified	boolean	no	Should subscribers be notified about this state change?
rootCause	string	no	What is the root cause of this status change?
endsAt	object	no	When did this status change end?
startsAt	object	no	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.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident State Timeline to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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): subscriberNot

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.

Parameter	Type	Required	Notes
query	object	no	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
select	array	no	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): subscriberNot
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident State Timeline to update. Required. Use list_incident_state_timelines to find IDs.
incidentStateId	string	no	Incident State ID Relation. Which incident state does this incident change to?
startsAt	object	no	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.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident State Timeline to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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: Equal

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
incidentId	string	yes	Relation to Incident ID in which this resource belongs.
note	string	no	Notes in markdown.
attachments	array	no	Files attached to this note.
postedFromSlackMessageId	string	no	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.
postedAt	object	no	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.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident Internal Note to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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): savedFromChatM

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.

Parameter	Type	Required	Notes
query	object	no	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,
select	array	no	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): savedFromChatM
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident Internal Note to update. Required. Use list_incident_internal_notes to find IDs.
note	string	no	Notes in markdown.
attachments	array	no	Files attached to this note.
postedAt	object	no	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.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident Internal Note to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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: EqualT

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
incidentId	string	yes	Relation to Incident ID in which this resource belongs.
note	string	no	Notes in markdown.
attachments	array	no	Files attached to this note.
shouldStatusPageSubscribersBeNotifiedOnNoteCreated	boolean	no	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
postedAt	object	no	Date and time when the note was posted.
postedFromSlackMessageId	string	no	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.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident Public Note to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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): subscriberNotifi

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.

Parameter	Type	Required	Notes
query	object	no	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, E
select	array	no	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): subscriberNotifi
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

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

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident Public Note to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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,

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
name	string	yes	Any friendly name of this object.
description	string	no	Friendly description that will help you remember.
color	object	yes	Color of this resource in Hex (#32a852 for example).
order	integer	no	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,
isArchived	boolean	no	Archived severities stay on the incidents and episodes that have them, but can't be picked again. A project keeps at least one severity that is not archived.

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

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

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.

Parameter	Type	Required	Notes
query	object	no	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, Equ
select	array	no	Optional: field names to return for each Incident Severity (e.g. ["_id", "name"]). Omit to get all readable fields.
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident Severity to update. Required. Use list_incident_severities to find IDs.
name	string	no	Any friendly name of this object.
description	string	no	Friendly description that will help you remember.
color	object	no	Color of this resource in Hex (#32a852 for example).
order	integer	no	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,
isArchived	boolean	no	Archived severities stay on the incidents and episodes that have them, but can't be picked again. A project keeps at least one severity that is not archived.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident Severity to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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, N

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

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
name	string	yes	Any friendly name of this object.
description	string	no	Friendly description that will help you remember.
color	object	yes	Color of this resource in Hex (#32a852 for example).
isNotStartedStatus	boolean	no	Is it the status a new incident's postmortem starts in? A project has one, and it can't be deleted or archived.
isDraftStatus	boolean	no	Is it the status a postmortem moves to once its note is written? A project has one, and it can't be deleted or archived.
isCompletedStatus	boolean	no	Is it the status a postmortem moves to once it is published on a status page? A postmortem in this status, or in one below it, counts as done. A project has one, and it can't be deleted or archived.
order	integer	no	Where this status sits in the project's list of postmortem statuses: 1 is the top. A postmortem in the completed status, or in a status below it, counts as done; one above it is still owed. So the not
isArchived	boolean	no	Archived statuses stay on the incidents whose postmortems are in them, but can't be picked again. The not started, draft and completed statuses can't be archived.

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

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

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

Parameter	Type	Required	Notes
query	object	no	Filter criteria for Postmortem Statuses. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, Equ
select	array	no	Optional: field names to return for each Postmortem Status (e.g. ["_id", "name"]). Omit to get all readable fields.
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Postmortem Status to update. Required. Use list_postmortem_statuses to find IDs.
name	string	no	Any friendly name of this object.
description	string	no	Friendly description that will help you remember.
color	object	no	Color of this resource in Hex (#32a852 for example).
isNotStartedStatus	boolean	no	Is it the status a new incident's postmortem starts in? A project has one, and it can't be deleted or archived.
isDraftStatus	boolean	no	Is it the status a postmortem moves to once its note is written? A project has one, and it can't be deleted or archived.
isCompletedStatus	boolean	no	Is it the status a postmortem moves to once it is published on a status page? A postmortem in this status, or in one below it, counts as done. A project has one, and it can't be deleted or archived.
order	integer	no	Where this status sits in the project's list of postmortem statuses: 1 is the top. A postmortem in the completed status, or in a status below it, counts as done; one above it is still owed. So the not
isArchived	boolean	no	Archived statuses stay on the incidents whose postmortems are in them, but can't be picked again. The not started, draft and completed statuses can't be archived.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Postmortem Status to delete. This action is irreversible.

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

Parameter	Type	Required	Notes
query	object	no	Optional filter criteria. If omitted, counts all Postmortem Statuses. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, N

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
name	string	yes	Any friendly name of this object.
description	string	no	Friendly description that will help you remember.
color	object	yes	Color of this resource in Hex (#32a852 for example).
isCreatedState	boolean	no	Is it the created state of the alert?
isAcknowledgedState	boolean	no	Is it the acknowledged state of the alert?
isResolvedState	boolean	no	Is it the resolved state of the alert?
order	integer	no	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 ackno
isArchived	boolean	no	Archived states stay on the alerts and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived.

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

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

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.

Parameter	Type	Required	Notes
query	object	no	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, EqualToOrN
select	array	no	Optional: field names to return for each Alert State (e.g. ["_id", "name"]). Omit to get all readable fields.
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Alert State to update. Required. Use list_alert_states to find IDs.
name	string	no	Any friendly name of this object.
description	string	no	Friendly description that will help you remember.
color	object	no	Color of this resource in Hex (#32a852 for example).
isCreatedState	boolean	no	Is it the created state of the alert?
isAcknowledgedState	boolean	no	Is it the acknowledged state of the alert?
isResolvedState	boolean	no	Is it the resolved state of the alert?
order	integer	no	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 ackno
isArchived	boolean	no	Archived states stay on the alerts and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Alert State to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
title	string	yes	Title of this alert.
description	string	no	Short description of this alert. This will be visible on the status page. This is in markdown.
impactStartedAt	object	no	When customer impact actually began. Left blank until someone records it - never inferred, because a guessed value is worse than no value.
monitorId	string	no	ID of the monitor this alert belongs to.
onCallDutyPolicies	array	no	List of on-call duty policies affected by this alert.
hosts	array	no	List of hosts affected by this alert.
kubernetesClusters	array	no	List of Kubernetes clusters affected by this alert.
kubernetesResources	array	no	List of Kubernetes resources (pods, deployments, nodes, etc.) affected by this alert.
kubernetesContainers	array	no	List of Kubernetes containers affected by this alert.
dockerHosts	array	no	List of Docker hosts affected by this alert.
podmanHosts	array	no	List of Podman hosts affected by this alert.
proxmoxClusters	array	no	List of Proxmox clusters affected by this alert.
vmwareVCenters	array	no	List of vCenters affected by this alert.
iotFleets	array	no	List of IoT fleets affected by this alert.
dockerSwarmClusters	array	no	List of Docker Swarm clusters affected by this alert.
cephClusters	array	no	List of Ceph clusters affected by this alert.
storageArrays	array	no	List of storage arrays affected by this alert.
databaseServers	array	no	List of databases affected by this alert.
dockerResources	array	no	List of Docker resources (containers, images, networks, volumes) affected by this alert.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Alert to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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,

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

Parameter	Type	Required	Notes
query	object	no	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, G
select	array	no	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,
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Alert to update. Required. Use list_alerts to find IDs.
title	string	no	Title of this alert.
description	string	no	Short description of this alert. This will be visible on the status page. This is in markdown.
impactStartedAt	object	no	When customer impact actually began. Left blank until someone records it - never inferred, because a guessed value is worse than no value.
monitorId	string	no	ID of the monitor this alert belongs to.
onCallDutyPolicies	array	no	List of on-call duty policies affected by this alert.
hosts	array	no	List of hosts affected by this alert.
kubernetesClusters	array	no	List of Kubernetes clusters affected by this alert.
kubernetesResources	array	no	List of Kubernetes resources (pods, deployments, nodes, etc.) affected by this alert.
kubernetesContainers	array	no	List of Kubernetes containers affected by this alert.
dockerHosts	array	no	List of Docker hosts affected by this alert.
podmanHosts	array	no	List of Podman hosts affected by this alert.
proxmoxClusters	array	no	List of Proxmox clusters affected by this alert.
vmwareVCenters	array	no	List of vCenters affected by this alert.
iotFleets	array	no	List of IoT fleets affected by this alert.
dockerSwarmClusters	array	no	List of Docker Swarm clusters affected by this alert.
cephClusters	array	no	List of Ceph clusters affected by this alert.
storageArrays	array	no	List of storage arrays affected by this alert.
databaseServers	array	no	List of databases affected by this alert.
dockerResources	array	no	List of Docker resources (containers, images, networks, volumes) affected by this alert.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Alert to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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, IsNu

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
alertId	string	yes	Relation to Alert ID in which this resource belongs.
alertStateId	string	yes	Alert State ID Relation. Which alert state does this alert change to?
rootCause	string	no	What is the root cause of this status change?
endsAt	object	no	When did this status change end?
startsAt	object	no	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.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Alert State Timeline to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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.

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.

Parameter	Type	Required	Notes
query	object	no	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, E
select	array	no	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.
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Alert State Timeline to update. Required. Use list_alert_state_timelines to find IDs.
alertStateId	string	no	Alert State ID Relation. Which alert state does this alert change to?
startsAt	object	no	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.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Alert State Timeline to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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,

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
alertId	string	yes	Relation to Alert ID in which this resource belongs.
note	string	no	Notes in markdown.
attachments	array	no	Files attached to this note.
postedFromSlackMessageId	string	no	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.
postedAt	object	no	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.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Alert Internal Note to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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): savedFromChatMess

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.

Parameter	Type	Required	Notes
query	object	no	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, Eq
select	array	no	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): savedFromChatMess
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Alert Internal Note to update. Required. Use list_alert_internal_notes to find IDs.
note	string	no	Notes in markdown.
attachments	array	no	Files attached to this note.
postedAt	object	no	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.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Alert Internal Note to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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,

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
name	string	yes	Any friendly name of this object.
description	string	no	Friendly description that will help you remember.
color	object	yes	Color of this resource in Hex (#32a852 for example).
order	integer	no	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, an
isArchived	boolean	no	Archived severities stay on the alerts and episodes that have them, but can't be picked again. A project keeps at least one severity that is not archived.

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

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

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.

Parameter	Type	Required	Notes
query	object	no	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, EqualT
select	array	no	Optional: field names to return for each Alert Severity (e.g. ["_id", "name"]). Omit to get all readable fields.
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Alert Severity to update. Required. Use list_alert_severities to find IDs.
name	string	no	Any friendly name of this object.
description	string	no	Friendly description that will help you remember.
color	object	no	Color of this resource in Hex (#32a852 for example).
order	integer	no	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, an
isArchived	boolean	no	Archived severities stay on the alerts and episodes that have them, but can't be picked again. A project keeps at least one severity that is not archived.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Alert Severity to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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, NotE

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
incidentId	string	yes	ID of the Incident this alert is linked to.
alertId	string	yes	ID of the Alert that is linked to the incident.

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

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

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.

Parameter	Type	Required	Notes
query	object	no	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, EqualTo
select	array	no	Optional: field names to return for each Incident Alert (e.g. ["_id", "name"]). Omit to get all readable fields.
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident Alert to update. Required. Use list_incident_alerts to find IDs.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Incident Alert to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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, NotEq

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.

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

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Monitor Status Event to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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.

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.

Parameter	Type	Required	Notes
query	object	no	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, E
select	array	no	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.
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

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

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Monitor Status Event to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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,

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.

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

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Status Page Announcement to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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): subscriberNo

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.

Parameter	Type	Required	Notes
query	object	no	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, NotNul
select	array	no	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): subscriberNo
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

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

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Status Page Announcement to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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: Equa

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
name	string	yes	Any friendly name of this object.
description	string	no	Friendly description that will help you remember.
color	object	yes	Color of this resource in Hex (#32a852 for example).
isScheduledState	boolean	no	Is this state a scheduled state?
isOngoingState	boolean	no	Is this state a ongoing state?
isEndedState	boolean	no	Is this state a ended state?
isResolvedState	boolean	no	Is this state a resolved state?
order	integer	no	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 th
isArchived	boolean	no	Archived states stay on the maintenance events that are in them, but can't be picked again. The scheduled, ongoing, ended and completed states can't be archived.

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.

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

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.

Parameter	Type	Required	Notes
query	object	no	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, Not
select	array	no	Optional: field names to return for each Scheduled Maintenance State (e.g. ["_id", "name"]). Omit to get all readable fields.
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Scheduled Maintenance State to update. Required. Use list_scheduled_maintenance_states to find IDs.
name	string	no	Any friendly name of this object.
description	string	no	Friendly description that will help you remember.
color	object	no	Color of this resource in Hex (#32a852 for example).
isScheduledState	boolean	no	Is this state a scheduled state?
isOngoingState	boolean	no	Is this state a ongoing state?
isEndedState	boolean	no	Is this state a ended state?
isResolvedState	boolean	no	Is this state a resolved state?
order	integer	no	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 th
isArchived	boolean	no	Archived states stay on the maintenance events that are in them, but can't be picked again. The scheduled, ongoing, ended and completed states can't be archived.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Scheduled Maintenance State to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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: E

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
title	string	yes	Title of this scheduled event.
description	string	no	Description of this scheduled event that will show up on Status Page. This is in markdown.
monitors	array	no	List of monitors attached to this event.
hosts	array	no	List of hosts affected by this event.
kubernetesClusters	array	no	List of Kubernetes clusters affected by this event.
dockerHosts	array	no	List of Docker hosts affected by this event.
podmanHosts	array	no	List of Podman hosts affected by this event.
proxmoxClusters	array	no	List of Proxmox clusters affected by this event.
vmwareVCenters	array	no	List of vCenters affected by this event.
iotFleets	array	no	List of IoT fleets affected by this event.
networkSites	array	no	List of network sites affected by this event. Their descendants are covered too.
dockerSwarmClusters	array	no	List of Docker Swarm clusters affected by this event.
cephClusters	array	no	List of Ceph clusters affected by this event.
storageArrays	array	no	List of storage arrays affected by this event.
databaseServers	array	no	List of databases affected by this event.
services	array	no	List of services affected by this event.
statusPages	array	no	List of status pages to show this event on.
labels	array	no	Relation to Labels Array where this object is categorized in.
currentScheduledMaintenanceStateId	string	no	Scheduled Maintenance State ID. The state the event currently is in.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Scheduled Maintenance Event to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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): subscribe

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.

Parameter	Type	Required	Notes
query	object	no	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, Not
select	array	no	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): subscribe
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Scheduled Maintenance Event to update. Required. Use list_scheduled_maintenance_events to find IDs.
title	string	no	Title of this scheduled event.
description	string	no	Description of this scheduled event that will show up on Status Page. This is in markdown.
monitors	array	no	List of monitors attached to this event.
hosts	array	no	List of hosts affected by this event.
kubernetesClusters	array	no	List of Kubernetes clusters affected by this event.
dockerHosts	array	no	List of Docker hosts affected by this event.
podmanHosts	array	no	List of Podman hosts affected by this event.
proxmoxClusters	array	no	List of Proxmox clusters affected by this event.
vmwareVCenters	array	no	List of vCenters affected by this event.
iotFleets	array	no	List of IoT fleets affected by this event.
networkSites	array	no	List of network sites affected by this event. Their descendants are covered too.
dockerSwarmClusters	array	no	List of Docker Swarm clusters affected by this event.
cephClusters	array	no	List of Ceph clusters affected by this event.
storageArrays	array	no	List of storage arrays affected by this event.
databaseServers	array	no	List of databases affected by this event.
services	array	no	List of services affected by this event.
statusPages	array	no	List of status pages to show this event on.
labels	array	no	Relation to Labels Array where this object is categorized in.
currentScheduledMaintenanceStateId	string	no	Scheduled Maintenance State ID. The state the event currently is in.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Scheduled Maintenance Event to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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: E

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.

Parameter	Type	Required	Notes
projectId	string	no	ID of your OneUptime Project in which this object belongs.
scheduledMaintenanceId	string	yes	ID of Scheduled Maintenance this resource belongs to.
scheduledMaintenanceStateId	string	yes	Scheduled Maintenance State ID. Which state does this event belongs to?
shouldStatusPageSubscribersBeNotified	boolean	no	Should subscribers be notified about this state change?
endsAt	object	no	When did this status change end?
startsAt	object	no	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.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Scheduled Maintenance State Timeline to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000"
select	array	no	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):

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.

Parameter	Type	Required	Notes
query	object	no	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, Is
select	array	no	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):
skip	number	no	Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100.
sort	object	no	Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first.

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.

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Scheduled Maintenance State Timeline to update. Required. Use list_scheduled_maintenance_state_timelines to find IDs.
scheduledMaintenanceStateId	string	no	Scheduled Maintenance State ID. Which state does this event belongs to?
startsAt	object	no	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.

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

Parameter	Type	Required	Notes
id	string	yes	The unique identifier (UUID) of the Scheduled Maintenance State Timeline to delete. This action is irreversible.

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.

Parameter	Type	Required	Notes
query	object	no	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": ...}. Ope

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/da

Parameter	Type	Required	Notes
query	object	no	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,
select	object	no	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.
skip	number	no	Number of records to skip. Default: 0.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
sort	object	no	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.

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

Parameter	Type	Required	Notes
query	object	no	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Gre

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/d

Parameter	Type	Required	Notes
query	object	no	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
select	object	no	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.
skip	number	no	Number of records to skip. Default: 0.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
sort	object	no	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.

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

Parameter	Type	Required	Notes
query	object	no	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Gre

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

Parameter	Type	Required	Notes
query	object	no	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, NotEqu
select	object	no	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.
skip	number	no	Number of records to skip. Default: 0.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
sort	object	no	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.

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

Parameter	Type	Required	Notes
query	object	no	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Gre

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, InBetw

Parameter	Type	Required	Notes
query	object	no	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: Equ
select	object	no	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.
skip	number	no	Number of records to skip. Default: 0.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
sort	object	no	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.

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

Parameter	Type	Required	Notes
query	object	no	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Gre

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 (nu

Parameter	Type	Required	Notes
query	object	no	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, N
select	object	no	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.
skip	number	no	Number of records to skip. Default: 0.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
sort	object	no	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.

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

Parameter	Type	Required	Notes
query	object	no	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Gre

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

Parameter	Type	Required	Notes
query	object	no	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": ...}. Operat
select	object	no	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.
skip	number	no	Number of records to skip. Default: 0.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
sort	object	no	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.

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

Parameter	Type	Required	Notes
query	object	no	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Gre

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

Parameter	Type	Required	Notes
query	object	no	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
select	object	no	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.
skip	number	no	Number of records to skip. Default: 0.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
sort	object	no	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.

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

Parameter	Type	Required	Notes
query	object	no	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Gre

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 (n

Parameter	Type	Required	Notes
query	object	no	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,
select	object	no	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.
skip	number	no	Number of records to skip. Default: 0.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
sort	object	no	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.

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

Parameter	Type	Required	Notes
query	object	no	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Gre

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, In

Parameter	Type	Required	Notes
query	object	no	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:
select	object	no	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.
skip	number	no	Number of records to skip. Default: 0.
limit	number	no	Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries.
sort	object	no	Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first.

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

Parameter	Type	Required	Notes
query	object	no	Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Gre

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.

Parameter	Type	Required	Notes
incidentId	string	yes	UUID of the incident to acknowledge. Use list_incidents to find it.

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

Parameter	Type	Required	Notes
incidentId	string	yes	UUID of the incident to resolve. Use list_incidents to find it.

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.

Parameter	Type	Required	Notes
alertId	string	yes	UUID of the alert to acknowledge. Use list_alerts to find it.

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

Parameter	Type	Required	Notes
alertId	string	yes	UUID of the alert to resolve. Use list_alerts to find it.

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.

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

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

Parameter	Type	Required	Notes
alertId	string	yes	UUID of the alert to annotate.
note	string	yes	The note content (Markdown supported).

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.

No parameter schema on file.

Get help and guidance for using the OneUptime MCP server. Returns information about available resources and common operations. Use this tool first to understand what you can do with OneUptime. AVAILABLE RESOURCES: - Teams: Groups of users with shared access to project resources. - Labels: Labels for organizing and filtering project resources. - Security Cases: Manages Security Case resources in O

Parameter	Type	Required	Notes
topic	string	no	Optional topic to get help on: 'resources', 'incidents', 'monitors', 'alerts', 'workflows', or 'examples'

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

No parameter schema on file.

Get the complete overview of a public status page including current status, resources, active incidents, scheduled maintenance, and announcements. This tool does NOT require an API key and works with public status pages. Status page owners can disable MCP access for their status page. If disabled, this tool returns an error and the data must be read from the status page website or its RSS feed i

Parameter	Type	Required	Notes
statusPageIdOrDomain	string	yes	The status page ID (UUID) or domain name (e.g., 'status.company.com'). Use domain for public status pages with custom domains.

Get incidents from a public status page. This tool does NOT require an API key and works with public status pages. Status page owners can disable MCP access for their status page. If disabled, this tool returns an error and the data must be read from the status page website or its RSS feed instead. USAGE: - By domain: statusPageIdOrDomain = "status.company.com" - By ID: statusPageIdOrDomain = "

Parameter	Type	Required	Notes
statusPageIdOrDomain	string	yes	The status page ID (UUID) or domain name (e.g., 'status.company.com')
incidentId	string	no	Optional: Specific incident ID to fetch details for

Get scheduled maintenance events from a public status page. This tool does NOT require an API key and works with public status pages. Status page owners can disable MCP access for their status page. If disabled, this tool returns an error and the data must be read from the status page website or its RSS feed instead. USAGE: - By domain: statusPageIdOrDomain = "status.company.com" - By ID: statu

Parameter	Type	Required	Notes
statusPageIdOrDomain	string	yes	The status page ID (UUID) or domain name (e.g., 'status.company.com')
scheduledMaintenanceId	string	no	Optional: Specific scheduled maintenance ID to fetch details for

Get announcements from a public status page. This tool does NOT require an API key and works with public status pages. Status page owners can disable MCP access for their status page. If disabled, this tool returns an error and the data must be read from the status page website or its RSS feed instead. USAGE: - By domain: statusPageIdOrDomain = "status.company.com" - By ID: statusPageIdOrDomain

Parameter	Type	Required	Notes
statusPageIdOrDomain	string	yes	The status page ID (UUID) or domain name (e.g., 'status.company.com')
announcementId	string	no	Optional: Specific announcement ID to fetch details for

Where are you running it?

Tool surface

Release history

OneUptime MCP

What it does

Quickstart

Where are you running it?

Tool surface

What counts against your monthly calls

Release history

See also