Manage incidents, alerts, monitors, status pages, on-call and telemetry in OneUptime.
Abgeleitet aus den Transporten, die dieser Eintrag deklariert (streamable-http). Ein Client, der hier nicht steht, ist damit nicht ausgeschlossen — Forge kann ihn nur nicht bestätigen.
Die Verifizierung bestätigt die Identität des Publishers (die Inhaberschaft am Repo), nicht die Sicherheit des Codes. Der Sicherheits-Scan deckt bekannte CVEs und verdächtige Installationsskripte ab.
Aus einem echten MCP-Handshake initialize → tools/list gegen den deklarierten Endpunkt gelesen. Es wurde nie ein Tool aufgerufen — tools/list ist der lesende Introspektionsaufruf, den das Protokoll dafür vorsieht. Es spiegelt wider, was der Server in diesem Moment angeboten hat; ein gehosteter Endpunkt ist an keine Version gebunden und kann sich ohne Ankündigung ändern.
https://oneuptime.com/mcp200 Tools · 1556 mscreate_teamCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| name* | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| customFields | object | Custom Fields on this resource. |
get_teamRetrieve a single Team by its unique ID from OneUptime. Use list_teams first if you need to find the ID.Retrieve a single Team by its unique ID from OneUptime. Use list_teams first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Team to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Team (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if… |
list_teamsList and search Teams from OneUptime with optional filtering, pagination, and sorting. Returns an array of Team objects plus the total matching count.List and search Teams from OneUptime with optional filtering, pagination, and sorting. Returns an array of Team objects plus the total matching count.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Teams. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, Not… |
| select | array | Optional: field names to return for each Team (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_teamUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Team to update. Required. Use list_teams to find IDs. |
| name | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| customFields | object | Custom Fields on this resource. |
delete_teamprivilegiertPermanently delete a Team from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Team from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Team to delete. This action is irreversible. |
count_teamsCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Teams. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value":… |
create_labelCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| name* | string | Any friendly name of this object. |
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| description | string | Friendly description that will help you remember. |
| color* | object | Color of this resource in Hex (#32a852 for example). |
| isArchived | boolean | Archived labels stay on everything that has them, but can't be added to anything again. |
get_labelRetrieve a single Label by its unique ID from OneUptime. Use list_labels first if you need to find the ID.Retrieve a single Label by its unique ID from OneUptime. Use list_labels first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Label to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Label (e.g. ["_id", "name"]). Omit to get all readable fields. |
list_labelsList and search Labels from OneUptime with optional filtering, pagination, and sorting. Returns an array of Label objects plus the total matching count.List and search Labels from OneUptime with optional filtering, pagination, and sorting. Returns an array of Label objects plus the total matching count.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Labels. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, No… |
| select | array | Optional: field names to return for each Label (e.g. ["_id", "name"]). Omit to get all readable fields. |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_labelUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Label to update. Required. Use list_labels to find IDs. |
| name | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| color | object | Color of this resource in Hex (#32a852 for example). |
| isArchived | boolean | Archived labels stay on everything that has them, but can't be added to anything again. |
delete_labelprivilegiertPermanently delete a Label from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Label from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Label to delete. This action is irreversible. |
count_labelsCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Labels. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value":… |
create_security_caseCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of the project this case belongs to. |
| title* | string | What the case is about, in a line. |
| description | string | What is known about the threat, in Markdown. A case opened by a detection starts with the detection's description. |
| securityCaseStatusId | string | ID of the case's status. Optional on create: a new case starts in the project's new status. |
| securityCasePriorityId | string | ID of the case's priority. Optional on create: a case opened by hand starts at the project's medium priority. |
| verdict | string | What the case turned out to be, set when it is closed: True Positive, Benign Positive, False Positive or Undetermined. |
| closingNote | string | Why the case was closed the way it was, in Markdown: what was found and what was done. |
| assignedToUserId | string | ID of the person working the case. |
| assignedToTeamId | string | ID of the team whose queue the case is in. |
| entities | object | The users, hosts, IP addresses, domains and files the case is about, each as { type, value }. Detections add theirs as they join the case. |
| mitreTactics | object | ATT&CK tactic ids (TA0006) the case's detections are tagged with. |
| mitreTechniques | object | ATT&CK technique ids (T1110) the case's detections are tagged with. |
| labels | array | Labels to filter and report on cases by. |
get_security_caseRetrieve a single Security Case by its unique ID from OneUptime. Use list_security_cases first if you need to find the ID.Retrieve a single Security Case by its unique ID from OneUptime. Use list_security_cases first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Security Case (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request expli… |
list_security_casesList and search Security Cases from OneUptime with optional filtering, pagination, and sorting. Returns an array of Security Case objects plus the total matching count.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Security Cases. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: Equ… |
| select | array | Optional: field names to return for each Security Case (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request expli… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_security_caseUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case to update. Required. Use list_security_cases to find IDs. |
| title | string | What the case is about, in a line. |
| description | string | What is known about the threat, in Markdown. A case opened by a detection starts with the detection's description. |
| securityCaseStatusId | string | ID of the case's status. Optional on create: a new case starts in the project's new status. |
| securityCasePriorityId | string | ID of the case's priority. Optional on create: a case opened by hand starts at the project's medium priority. |
| verdict | string | What the case turned out to be, set when it is closed: True Positive, Benign Positive, False Positive or Undetermined. |
| closingNote | string | Why the case was closed the way it was, in Markdown: what was found and what was done. |
| assignedToUserId | string | ID of the person working the case. |
| assignedToTeamId | string | ID of the team whose queue the case is in. |
| entities | object | The users, hosts, IP addresses, domains and files the case is about, each as { type, value }. Detections add theirs as they join the case. |
| mitreTactics | object | ATT&CK tactic ids (TA0006) the case's detections are tagged with. |
| mitreTechniques | object | ATT&CK technique ids (T1110) the case's detections are tagged with. |
| labels | array | Labels to filter and report on cases by. |
delete_security_caseprivilegiertPermanently delete a Security Case from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Security Case from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case to delete. This action is irreversible. |
count_security_casesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Security Cases. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>",… |
create_security_case_noteCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of the project this note belongs to. |
| securityCaseId* | string | ID of the case this note is on. |
| note* | string | The note, in Markdown. |
get_security_case_noteRetrieve a single Security Case Note by its unique ID from OneUptime. Use list_security_case_notes first if you need to find the ID.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case Note to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Security Case Note (e.g. ["_id", "name"]). Omit to get all readable fields. |
list_security_case_notesList 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Security Case Notes. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators… |
| select | array | Optional: field names to return for each Security Case Note (e.g. ["_id", "name"]). Omit to get all readable fields. |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_security_case_noteUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case Note to update. Required. Use list_security_case_notes to find IDs. |
| note | string | The note, in Markdown. |
delete_security_case_noteprivilegiertPermanently delete a Security Case Note from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Security Case Note from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case Note to delete. This action is irreversible. |
count_security_case_notesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Security Case Notes. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operato… |
create_security_case_taskCreate a new Security Case Task in OneUptime. Returns the created Security Case Task object with its ID. Use this to add new Security Case Tasks to your project. Note: projectId is inferred from your API key — you do not need to provide it.Create a new Security Case Task in OneUptime. Returns the created Security Case Task object with its ID. Use this to add new Security Case Tasks to your project. Note: projectId is inferred from your API key — you do not need to provide it.
| Parameter | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of the project this task belongs to. |
| securityCaseId* | string | ID of the case this task is on. |
| title* | string | What has to be done, in a line. |
| assignedToUserId | string | ID of the person doing the task. Empty while nobody is. |
| isDone | boolean | Whether the task is done. Setting it records who did it and when; clearing it opens the task again. |
get_security_case_taskRetrieve a single Security Case Task by its unique ID from OneUptime. Use list_security_case_tasks first if you need to find the ID.Retrieve a single Security Case Task by its unique ID from OneUptime. Use list_security_case_tasks first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case Task to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Security Case Task (e.g. ["_id", "name"]). Omit to get all readable fields. |
list_security_case_tasksList and search Security Case Tasks from OneUptime with optional filtering, pagination, and sorting. Returns an array of Security Case Task objects plus the total matching count.List and search Security Case Tasks from OneUptime with optional filtering, pagination, and sorting. Returns an array of Security Case Task objects plus the total matching count.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Security Case Tasks. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators… |
| select | array | Optional: field names to return for each Security Case Task (e.g. ["_id", "name"]). Omit to get all readable fields. |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_security_case_taskUpdate an existing Security Case Task in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_security_case_task afterwards to see the updated record.Update an existing Security Case Task in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_security_case_task afterwards to see the updated record.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case Task to update. Required. Use list_security_case_tasks to find IDs. |
| title | string | What has to be done, in a line. |
| assignedToUserId | string | ID of the person doing the task. Empty while nobody is. |
| isDone | boolean | Whether the task is done. Setting it records who did it and when; clearing it opens the task again. |
delete_security_case_taskprivilegiertPermanently delete a Security Case Task from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Security Case Task from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case Task to delete. This action is irreversible. |
count_security_case_tasksCount the total number of Security Case Tasks in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.Count the total number of Security Case Tasks in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Security Case Tasks. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operato… |
create_security_case_evidenceCreate a new Security Case Evidence in OneUptime. Returns the created Security Case Evidence object with its ID. Use this to add new Security Case Evidence to your project. Note: projectId is inferred from your API key — you do not need to provide it.Create a new Security Case Evidence in OneUptime. Returns the created Security Case Evidence object with its ID. Use this to add new Security Case Evidence to your project. Note: projectId is inferred from your API key — you do not need to provide it.
| Parameter | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of the project this evidence belongs to. |
| securityCaseId* | string | ID of the case this evidence is kept on. |
| kind* | string | What the evidence is: a File uploaded to OneUptime, or a Link to evidence kept somewhere else. It can't be changed. |
| name* | string | What the evidence is, in a few words. A file's own name when none is given. |
| description | string | What the evidence shows, and where and how it was collected. |
| fileId | string | ID of the uploaded file, for File evidence: upload it first, then name it here. |
| url | string | Where the evidence is kept, for Link evidence: an http or https address. |
get_security_case_evidenceRetrieve a single Security Case Evidence by its unique ID from OneUptime. Use list_security_case_evidence first if you need to find the ID.Retrieve a single Security Case Evidence by its unique ID from OneUptime. Use list_security_case_evidence first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case Evidence to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Security Case Evidence (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (requ… |
list_security_case_evidenceList and search Security Case Evidence from OneUptime with optional filtering, pagination, and sorting. Returns an array of Security Case Evidence objects plus the total matching count.List and search Security Case Evidence from OneUptime with optional filtering, pagination, and sorting. Returns an array of Security Case Evidence objects plus the total matching count.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Security Case Evidence. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operat… |
| select | array | Optional: field names to return for each Security Case Evidence (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (requ… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_security_case_evidenceUpdate an existing Security Case Evidence in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_security_case_evidence afterwards to see the updated record.Update an existing Security Case Evidence in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_security_case_evidence afterwards to see the updated record.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case Evidence to update. Required. Use list_security_case_evidence to find IDs. |
| name | string | What the evidence is, in a few words. A file's own name when none is given. |
| description | string | What the evidence shows, and where and how it was collected. |
delete_security_case_evidenceprivilegiertPermanently delete a Security Case Evidence from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Security Case Evidence from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case Evidence to delete. This action is irreversible. |
count_security_case_evidenceCount the total number of Security Case Evidence in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.Count the total number of Security Case Evidence in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Security Case Evidence. Each field accepts a direct value (exact match) or an operator object {"_type": "<Oper… |
create_security_case_priorityCreate a new Security Case Priority in OneUptime. Returns the created Security Case Priority object with its ID. Use this to add new Security Case Priorities to your project. Note: projectId is inferred from your API key — you do not need to provide it.Create a new Security Case Priority in OneUptime. Returns the created Security Case Priority object with its ID. Use this to add new Security Case Priorities to your project. Note: projectId is inferred from your API key — you do not need to provide it.
| Parameter | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of the project this priority belongs to. |
| name* | string | What the priority is called, like High or P1. |
| description | string | How fast a case at this priority needs a person, in a sentence. |
| color* | object | The priority's colour, in hex (#32a852 for example). |
| isCriticalPriority | boolean | Is it the priority Critical detections open cases at? From it up, a case can't wait. A project has one; it can't be deleted or archived. |
| isHighPriority | boolean | Is it the priority High detections open cases at? From it up, a case counts as urgent. A project has one; it can't be deleted or archived. |
| isMediumPriority | boolean | Is it the priority Medium detections, and the cases people open, start at? A project has one; it can't be deleted or archived. |
| isLowPriority | boolean | Is it the priority Low detections open cases at? A project has one, and it can't be deleted or archived. |
| isInformationalPriority | boolean | Is it the priority Informational detections open cases at? A project has one, and it can't be deleted or archived. |
| order | integer | Where this priority ranks among the project's security case priorities: 1 is the most urgent. Detections open their cases at the critical, high, medium, low an… |
| acknowledgeWithinInMinutes | number | How long a case at this priority may wait for somebody to take it on, in minutes, from when it opens. Empty for no target. |
| containWithinInMinutes | number | How long a case at this priority may take to be contained or closed, in minutes, from when it opens. Empty for no target. |
| isArchived | boolean | Archived priorities stay on the cases at them, but can't be picked again. The built-in priorities can't be archived. |
get_security_case_priorityRetrieve a single Security Case Priority by its unique ID from OneUptime. Use list_security_case_priorities first if you need to find the ID.Retrieve a single Security Case Priority by its unique ID from OneUptime. Use list_security_case_priorities first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case Priority to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Security Case Priority (e.g. ["_id", "name"]). Omit to get all readable fields. |
list_security_case_prioritiesList and search Security Case Priorities from OneUptime with optional filtering, pagination, and sorting. Returns an array of Security Case Priority objects plus the total matching count.List and search Security Case Priorities from OneUptime with optional filtering, pagination, and sorting. Returns an array of Security Case Priority objects plus the total matching count.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Security Case Priorities. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Oper… |
| select | array | Optional: field names to return for each Security Case Priority (e.g. ["_id", "name"]). Omit to get all readable fields. |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_security_case_priorityUpdate an existing Security Case Priority in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_security_case_priority afterwards to see the updated record.Update an existing Security Case Priority in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_security_case_priority afterwards to see the updated record.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case Priority to update. Required. Use list_security_case_priorities to find IDs. |
| name | string | What the priority is called, like High or P1. |
| description | string | How fast a case at this priority needs a person, in a sentence. |
| color | object | The priority's colour, in hex (#32a852 for example). |
| isCriticalPriority | boolean | Is it the priority Critical detections open cases at? From it up, a case can't wait. A project has one; it can't be deleted or archived. |
| isHighPriority | boolean | Is it the priority High detections open cases at? From it up, a case counts as urgent. A project has one; it can't be deleted or archived. |
| isMediumPriority | boolean | Is it the priority Medium detections, and the cases people open, start at? A project has one; it can't be deleted or archived. |
| isLowPriority | boolean | Is it the priority Low detections open cases at? A project has one, and it can't be deleted or archived. |
| isInformationalPriority | boolean | Is it the priority Informational detections open cases at? A project has one, and it can't be deleted or archived. |
| order | integer | Where this priority ranks among the project's security case priorities: 1 is the most urgent. Detections open their cases at the critical, high, medium, low an… |
| acknowledgeWithinInMinutes | number | How long a case at this priority may wait for somebody to take it on, in minutes, from when it opens. Empty for no target. |
| containWithinInMinutes | number | How long a case at this priority may take to be contained or closed, in minutes, from when it opens. Empty for no target. |
| isArchived | boolean | Archived priorities stay on the cases at them, but can't be picked again. The built-in priorities can't be archived. |
delete_security_case_priorityprivilegiertPermanently delete a Security Case Priority from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Security Case Priority from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case Priority to delete. This action is irreversible. |
count_security_case_prioritiesCount the total number of Security Case Priorities in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.Count the total number of Security Case Priorities in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Security Case Priorities. Each field accepts a direct value (exact match) or an operator object {"_type": "<Op… |
create_security_case_statusCreate a new Security Case Status in OneUptime. Returns the created Security Case Status object with its ID. Use this to add new Security Case Statuses to your project. Note: projectId is inferred from your API key — you do not need to provide it.Create a new Security Case Status in OneUptime. Returns the created Security Case Status object with its ID. Use this to add new Security Case Statuses to your project. Note: projectId is inferred from your API key — you do not need to provide it.
| Parameter | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of the project this status belongs to. |
| name* | string | What the status is called, like Investigating or Triage. |
| description | string | What a case in this status is waiting for, in a sentence. |
| color* | object | The status's colour, in hex (#32a852 for example). |
| isNewStatus | boolean | Is it the status every new case starts in? A project has one, and it can't be deleted or archived. |
| isAcknowledgedStatus | boolean | Is it the status a reopened case moves to? From it down, a case counts as taken on. A project has one, and it can't be deleted or archived. |
| isContainedStatus | boolean | Is it the status the time to contain is measured to? From it down, a case counts as contained. A project has one. |
| isClosedStatus | boolean | Is it the status Close Case moves a case to? From it down, a case counts as closed and carries a verdict. A project has one. |
| order | integer | Where this status sits in the project's list of security case statuses: 1 is the top. A case in a status at or below the acknowledged (contained, closed) statu… |
| isArchived | boolean | Archived statuses stay on the cases in them, but can't be picked again. The built-in statuses can't be archived. |
get_security_case_statusRetrieve a single Security Case Status by its unique ID from OneUptime. Use list_security_case_statuses first if you need to find the ID.Retrieve a single Security Case Status by its unique ID from OneUptime. Use list_security_case_statuses first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case Status to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Security Case Status (e.g. ["_id", "name"]). Omit to get all readable fields. |
list_security_case_statusesList and search Security Case Statuses from OneUptime with optional filtering, pagination, and sorting. Returns an array of Security Case Status objects plus the total matching count.List and search Security Case Statuses from OneUptime with optional filtering, pagination, and sorting. Returns an array of Security Case Status objects plus the total matching count.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Security Case Statuses. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operat… |
| select | array | Optional: field names to return for each Security Case Status (e.g. ["_id", "name"]). Omit to get all readable fields. |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_security_case_statusUpdate an existing Security Case Status in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_security_case_status afterwards to see the updated record.Update an existing Security Case Status in OneUptime. Only include the fields you want to change - unspecified fields will remain unchanged. Use get_security_case_status afterwards to see the updated record.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case Status to update. Required. Use list_security_case_statuses to find IDs. |
| name | string | What the status is called, like Investigating or Triage. |
| description | string | What a case in this status is waiting for, in a sentence. |
| color | object | The status's colour, in hex (#32a852 for example). |
| isNewStatus | boolean | Is it the status every new case starts in? A project has one, and it can't be deleted or archived. |
| isAcknowledgedStatus | boolean | Is it the status a reopened case moves to? From it down, a case counts as taken on. A project has one, and it can't be deleted or archived. |
| isContainedStatus | boolean | Is it the status the time to contain is measured to? From it down, a case counts as contained. A project has one. |
| isClosedStatus | boolean | Is it the status Close Case moves a case to? From it down, a case counts as closed and carries a verdict. A project has one. |
| order | integer | Where this status sits in the project's list of security case statuses: 1 is the top. A case in a status at or below the acknowledged (contained, closed) statu… |
| isArchived | boolean | Archived statuses stay on the cases in them, but can't be picked again. The built-in statuses can't be archived. |
delete_security_case_statusprivilegiertPermanently delete a Security Case Status from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Security Case Status from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Case Status to delete. This action is irreversible. |
count_security_case_statusesCount the total number of Security Case Statuses in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.Count the total number of Security Case Statuses in OneUptime, optionally filtered by query criteria. Returns a single number. Useful for dashboards, reports, or checking if records exist before listing.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Security Case Statuses. Each field accepts a direct value (exact match) or an operator object {"_type": "<Oper… |
create_security_detectionCreate 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.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.
Für dieses Tool wurde kein Eingabeschema veröffentlicht.
get_security_detectionRetrieve a single Security Detection by its unique ID from OneUptime. Use list_security_detections first if you need to find the ID.Retrieve a single Security Detection by its unique ID from OneUptime. Use list_security_detections first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Detection to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Security Detection (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request… |
list_security_detectionsList and search Security Detections from OneUptime with optional filtering, pagination, and sorting. Returns an array of Security Detection objects plus the total matching count.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Security Detections. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators… |
| select | array | Optional: field names to return for each Security Detection (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_security_detectionUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Detection to update. Required. Use list_security_detections to find IDs. |
delete_security_detectionprivilegiertPermanently delete a Security Detection from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Security Detection from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Detection to delete. This action is irreversible. |
count_security_detectionsCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Security Detections. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operato… |
create_security_playbookCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of the project this playbook belongs to. |
| name* | object | What the playbook does, in a few words. |
| description | string | When to use the playbook and what it is for. |
| isEnabled | boolean | Whether the playbook runs on its own. A disabled playbook can still be run by hand from a case. |
| trigger | string | When the playbook runs on its own: Case Opened, Detection Added (a new detection joins an open case), or Manual (only when somebody runs it). |
| minimumSecurityCasePriorityId | string | ID of the lowest case priority the playbook runs on by itself. Empty runs on every priority. |
| detectionSource | string | Run only on cases raised by this source: a Detection Rule, Threat Intel, a Connected Product or Entity Risk. Empty runs on every source. |
| detectionRuleIds | object | Run only on cases with a detection from one of these detection rules. Empty runs on cases from any rule. |
| steps | object | The steps the playbook takes, in order. Each has an action, its settings, and whether it needs approval, may fail without stopping the run, or runs only when t… |
get_security_playbookRetrieve a single Security Playbook by its unique ID from OneUptime. Use list_security_playbooks first if you need to find the ID.Retrieve a single Security Playbook by its unique ID from OneUptime. Use list_security_playbooks first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Playbook to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Security Playbook (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request e… |
list_security_playbooksList and search Security Playbooks from OneUptime with optional filtering, pagination, and sorting. Returns an array of Security Playbook objects plus the total matching count.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Security Playbooks. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators:… |
| select | array | Optional: field names to return for each Security Playbook (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request e… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_security_playbookUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Playbook to update. Required. Use list_security_playbooks to find IDs. |
| name | object | What the playbook does, in a few words. |
| description | string | When to use the playbook and what it is for. |
| isEnabled | boolean | Whether the playbook runs on its own. A disabled playbook can still be run by hand from a case. |
| trigger | string | When the playbook runs on its own: Case Opened, Detection Added (a new detection joins an open case), or Manual (only when somebody runs it). |
| minimumSecurityCasePriorityId | string | ID of the lowest case priority the playbook runs on by itself. Empty runs on every priority. |
| detectionSource | string | Run only on cases raised by this source: a Detection Rule, Threat Intel, a Connected Product or Entity Risk. Empty runs on every source. |
| detectionRuleIds | object | Run only on cases with a detection from one of these detection rules. Empty runs on cases from any rule. |
| steps | object | The steps the playbook takes, in order. Each has an action, its settings, and whether it needs approval, may fail without stopping the run, or runs only when t… |
delete_security_playbookprivilegiertPermanently delete a Security Playbook from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Security Playbook from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Security Playbook to delete. This action is irreversible. |
count_security_playbooksCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Security Playbooks. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator… |
create_status_pageCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| name* | string | Any friendly name of this object. |
| pageTitle | string | Title of your Status Page. This is used for SEO. |
| pageDescription | string | Description of your Status Page. This is used for SEO. |
| enableSearchEngineIndexing | boolean | 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 | Friendly description that will help you remember. |
| labels | array | Relation to Labels Array where this object is categorized in. |
| isArchived | boolean | 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 onli… |
| faviconFileId | string | Status Page Favicon File ID. |
| logoFileId | string | Status Page Logo File ID. |
| darkThemeLogoFileId | string | Status Page Dark Theme Logo File ID. |
| coverImageFileId | string | Status Page Cover Image ID. |
| headerHTML | string | Status Page Custom HTML Header. Served only from a verified custom domain. |
| footerHTML | string | Status Page Custom HTML Footer. Served only from a verified custom domain. |
| customCSS | string | Status Page Custom CSS. Served only from a verified custom domain. |
| customJavaScript | string | Status Page Custom JavaScript. This runs when the status page is loaded from a verified custom domain. |
| isPublicStatusPage | boolean | Is this status page public? |
| enableMcpServer | boolean | 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 | Require visitors to enter a master password before viewing a private status page. |
| masterPassword | string | Password required to unlock a private status page. This value is stored as a secure hash. |
| showIncidentLabelsOnStatusPage | boolean | Show Incident Labels on Status Page? |
| showScheduledEventLabelsOnStatusPage | boolean | Show Scheduled Event Labels on Status Page? |
| enableEmailSubscribers | boolean | Can email subscribers subscribe to this Status Page? |
| allowSubscribersToChooseResources | boolean | Can subscribers choose which resources to subscribe to? |
get_status_pageRetrieve a single Status Page by its unique ID from OneUptime. Use list_status_pages first if you need to find the ID.Retrieve a single Status Page by its unique ID from OneUptime. Use list_status_pages first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Status Page to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Status Page (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explici… |
list_status_pagesList and search Status Pages from OneUptime with optional filtering, pagination, and sorting. Returns an array of Status Page objects plus the total matching count.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Status Pages. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: Equal… |
| select | array | Optional: field names to return for each Status Page (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explici… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_status_pageUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Status Page to update. Required. Use list_status_pages to find IDs. |
| name | string | Any friendly name of this object. |
| pageTitle | string | Title of your Status Page. This is used for SEO. |
| pageDescription | string | Description of your Status Page. This is used for SEO. |
| enableSearchEngineIndexing | boolean | 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 | Friendly description that will help you remember. |
| labels | array | Relation to Labels Array where this object is categorized in. |
| isArchived | boolean | 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 onli… |
| faviconFileId | string | Status Page Favicon File ID. |
| logoFileId | string | Status Page Logo File ID. |
| darkThemeLogoFileId | string | Status Page Dark Theme Logo File ID. |
| coverImageFileId | string | Status Page Cover Image ID. |
| headerHTML | string | Status Page Custom HTML Header. Served only from a verified custom domain. |
| footerHTML | string | Status Page Custom HTML Footer. Served only from a verified custom domain. |
| customCSS | string | Status Page Custom CSS. Served only from a verified custom domain. |
| customJavaScript | string | Status Page Custom JavaScript. This runs when the status page is loaded from a verified custom domain. |
| isPublicStatusPage | boolean | Is this status page public? |
| enableMcpServer | boolean | 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 | Require visitors to enter a master password before viewing a private status page. |
| masterPassword | string | Password required to unlock a private status page. This value is stored as a secure hash. |
| showIncidentLabelsOnStatusPage | boolean | Show Incident Labels on Status Page? |
| showScheduledEventLabelsOnStatusPage | boolean | Show Scheduled Event Labels on Status Page? |
| enableEmailSubscribers | boolean | Can email subscribers subscribe to this Status Page? |
| allowSubscribersToChooseResources | boolean | Can subscribers choose which resources to subscribe to? |
delete_status_pageprivilegiertPermanently delete a Status Page from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Status Page from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Status Page to delete. This action is irreversible. |
count_status_pagesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Status Pages. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "v… |
create_on_call_policyCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| name* | string | Any friendly name of this object. |
| labels | array | Relation to Labels Array where this object is categorized in. |
| description | string | Friendly description that will help you remember. |
| isArchived | boolean | Archived on-call policies are hidden from the On-Call Policies list and page no one: incidents and alerts that use them skip them. Unarchiving puts them back i… |
| repeatPolicyIfNoOneAcknowledges | boolean | Repeat the policy if no one acknowledges the alert. |
| repeatPolicyIfNoOneAcknowledgesNoOfTimes | number | How many more times the policy starts again from its first escalation rule when nobody acknowledges: a whole number of 1 or more while Repeat Policy If No One… |
| acknowledgementTimeoutInMinutes | number | Page again when something this policy paged about is acknowledged but not resolved within this many minutes (5 to 1440). Empty: never. |
| customFields | object | Custom Fields on this resource. |
get_on_call_policyRetrieve 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the On-Call Policy to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each On-Call Policy (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request expl… |
list_on_call_duty_policiesList 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for On-Call Duty Policies. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operato… |
| select | array | Optional: field names to return for each On-Call Policy (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request expl… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_on_call_policyUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the On-Call Policy to update. Required. Use list_on_call_duty_policies to find IDs. |
| name | string | Any friendly name of this object. |
| labels | array | Relation to Labels Array where this object is categorized in. |
| description | string | Friendly description that will help you remember. |
| isArchived | boolean | Archived on-call policies are hidden from the On-Call Policies list and page no one: incidents and alerts that use them skip them. Unarchiving puts them back i… |
| repeatPolicyIfNoOneAcknowledges | boolean | Repeat the policy if no one acknowledges the alert. |
| repeatPolicyIfNoOneAcknowledgesNoOfTimes | number | How many more times the policy starts again from its first escalation rule when nobody acknowledges: a whole number of 1 or more while Repeat Policy If No One… |
| acknowledgementTimeoutInMinutes | number | Page again when something this policy paged about is acknowledged but not resolved within this many minutes (5 to 1440). Empty: never. |
| customFields | object | Custom Fields on this resource. |
delete_on_call_policyprivilegiertPermanently delete a On-Call Policy from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a On-Call Policy from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the On-Call Policy to delete. This action is irreversible. |
count_on_call_duty_policiesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all On-Call Duty Policies. Each field accepts a direct value (exact match) or an operator object {"_type": "<Opera… |
create_monitorCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| name* | string | Any friendly name for this monitor. |
| description | string | Friendly description that will help you remember. |
| isArchived | boolean | Archived monitors are hidden from monitor lists and status pages, are not checked, and open no incidents or alerts. Unarchiving resumes monitoring. |
| labels | array | Relation to Labels Array where this object is categorized in. |
| dependsOnMonitors | array | 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 ar… |
| suppressAlertsWhenParentMonitorStatuses | array | Parent monitor statuses that suppress this monitor's alerts and incidents. When empty, statuses flagged as offline suppress (the default). Only used when Depen… |
| hosts | array | Hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. |
| kubernetesClusters | array | 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 | 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 | 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 | 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 | 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 | 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 | Storage arrays this monitor watches. Incidents and alerts it creates are linked to them. |
| cloudResources | array | Cloud resources this monitor watches. Incidents and alerts it creates are linked to them. |
| dockerSwarmClusters | array | 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 | 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 | Databases this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. |
| services | array | Services this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. |
| monitorTemplateId | string | ID of the Monitor Template this monitor was created from. Null for monitors not created from a template. |
| monitorType* | string | What is the type of this monitor? Website? API? etc. |
| currentMonitorStatusId | string | Whats the current status ID of this monitor? |
| monitorSteps | object | What would you like to monitor and what is the criteria? |
get_monitorRetrieve a single Monitor by its unique ID from OneUptime. Use list_monitors first if you need to find the ID.Retrieve a single Monitor by its unique ID from OneUptime. Use list_monitors first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Monitor to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Monitor (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly… |
list_monitorsList and search Monitors from OneUptime with optional filtering, pagination, and sorting. Returns an array of Monitor objects plus the total matching count.List and search Monitors from OneUptime with optional filtering, pagination, and sorting. Returns an array of Monitor objects plus the total matching count.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Monitors. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo,… |
| select | array | Optional: field names to return for each Monitor (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_monitorUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Monitor to update. Required. Use list_monitors to find IDs. |
| name | string | Any friendly name for this monitor. |
| description | string | Friendly description that will help you remember. |
| isArchived | boolean | Archived monitors are hidden from monitor lists and status pages, are not checked, and open no incidents or alerts. Unarchiving resumes monitoring. |
| labels | array | Relation to Labels Array where this object is categorized in. |
| dependsOnMonitors | array | 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 ar… |
| suppressAlertsWhenParentMonitorStatuses | array | Parent monitor statuses that suppress this monitor's alerts and incidents. When empty, statuses flagged as offline suppress (the default). Only used when Depen… |
| hosts | array | Hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. |
| kubernetesClusters | array | 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 | 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 | 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 | 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 | 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 | 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 | Storage arrays this monitor watches. Incidents and alerts it creates are linked to them. |
| cloudResources | array | Cloud resources this monitor watches. Incidents and alerts it creates are linked to them. |
| dockerSwarmClusters | array | 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 | 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 | Databases this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. |
| services | array | Services this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. |
| monitorTemplateId | string | ID of the Monitor Template this monitor was created from. Null for monitors not created from a template. |
| currentMonitorStatusId | string | Whats the current status ID of this monitor? |
| monitorSteps | object | What would you like to monitor and what is the criteria? |
| monitoringInterval | string | How often would you like OneUptime to monitor this resource? A 5-field cron expression, not a label: "*/5 * * * *" is every five minutes. |
delete_monitorprivilegiertPermanently delete a Monitor from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Monitor from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Monitor to delete. This action is irreversible. |
count_monitorsCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Monitors. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value… |
create_monitor_statusCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| name* | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| color* | object | Color of this resource in Hex (#32a852 for example). |
| isOperationalState | boolean | Is this monitor in operational state? |
| isOfflineState | boolean | Is this monitor in offline state? |
| priority | number | Where this status sits in the project's list of monitor statuses, from the healthiest (the lowest number) down to the worst: where monitors are shown together,… |
| isArchived | boolean | Archived statuses stay on the monitors that are in them, but can't be picked again. The operational and offline statuses can't be archived. |
get_monitor_statusRetrieve a single Monitor Status by its unique ID from OneUptime. Use list_monitor_statuses first if you need to find the ID.Retrieve a single Monitor Status by its unique ID from OneUptime. Use list_monitor_statuses first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Monitor Status to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Monitor Status (e.g. ["_id", "name"]). Omit to get all readable fields. |
list_monitor_statusesList and search Monitor Statuses from OneUptime with optional filtering, pagination, and sorting. Returns an array of Monitor Status objects plus the total matching count.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Monitor Statuses. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: E… |
| select | array | Optional: field names to return for each Monitor Status (e.g. ["_id", "name"]). Omit to get all readable fields. |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_monitor_statusUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Monitor Status to update. Required. Use list_monitor_statuses to find IDs. |
| name | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| color | object | Color of this resource in Hex (#32a852 for example). |
| isOperationalState | boolean | Is this monitor in operational state? |
| isOfflineState | boolean | Is this monitor in offline state? |
| priority | number | Where this status sits in the project's list of monitor statuses, from the healthiest (the lowest number) down to the worst: where monitors are shown together,… |
| isArchived | boolean | Archived statuses stay on the monitors that are in them, but can't be picked again. The operational and offline statuses can't be archived. |
delete_monitor_statusprivilegiertPermanently delete a Monitor Status from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Monitor Status from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Monitor Status to delete. This action is irreversible. |
count_monitor_statusesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Monitor Statuses. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>"… |
create_incident_stateCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| name* | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| color* | object | Color of this resource in Hex (#32a852 for example). |
| isCreatedState | boolean | Is it the created state of the incident? |
| isAcknowledgedState | boolean | Is it the acknowledged state of the incident? |
| isResolvedState | boolean | Is it the resolved state of the incident? |
| order | integer | Where this state sits in the project's list of incident states: 1 is the top. Incidents only ever move down the list, and an incident in a state at or below th… |
| isArchived | boolean | Archived states stay on the incidents and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived. |
get_incident_stateRetrieve a single Incident State by its unique ID from OneUptime. Use list_incident_states first if you need to find the ID.Retrieve a single Incident State by its unique ID from OneUptime. Use list_incident_states first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident State to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Incident State (e.g. ["_id", "name"]). Omit to get all readable fields. |
list_incident_statesList and search Incident States from OneUptime with optional filtering, pagination, and sorting. Returns an array of Incident State objects plus the total matching count.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Incident States. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: Eq… |
| select | array | Optional: field names to return for each Incident State (e.g. ["_id", "name"]). Omit to get all readable fields. |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_incident_stateUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident State to update. Required. Use list_incident_states to find IDs. |
| name | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| color | object | Color of this resource in Hex (#32a852 for example). |
| isCreatedState | boolean | Is it the created state of the incident? |
| isAcknowledgedState | boolean | Is it the acknowledged state of the incident? |
| isResolvedState | boolean | Is it the resolved state of the incident? |
| order | integer | Where this state sits in the project's list of incident states: 1 is the top. Incidents only ever move down the list, and an incident in a state at or below th… |
| isArchived | boolean | Archived states stay on the incidents and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived. |
delete_incident_stateprivilegiertPermanently delete a Incident State from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Incident State from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident State to delete. This action is irreversible. |
count_incident_statesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Incident States. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>",… |
create_incidentCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| title* | string | Title of this incident. |
| description | string | Short description of this incident. This is in markdown and will be visible on the status page. |
| declaredAt | object | Date and time when this incident was declared. |
| impactStartedAt | object | When customer impact actually began. Left blank until someone records it - never inferred, because a guessed value is worse than no value. |
| monitors | array | List of monitors affected by this incident. |
| hosts | array | List of hosts affected by this incident. |
| networkDevices | array | List of network devices affected by this incident. |
| kubernetesClusters | array | List of Kubernetes clusters affected by this incident. |
| kubernetesResources | array | List of Kubernetes resources (pods, deployments, nodes, etc.) affected by this incident. |
| kubernetesContainers | array | List of Kubernetes containers affected by this incident. |
| dockerHosts | array | List of Docker hosts affected by this incident. |
| podmanHosts | array | List of Podman hosts affected by this incident. |
| proxmoxClusters | array | List of Proxmox clusters affected by this incident. |
| vmwareVCenters | array | List of vCenters affected by this incident. |
| iotFleets | array | List of IoT fleets affected by this incident. |
| dockerSwarmClusters | array | List of Docker Swarm clusters affected by this incident. |
| cephClusters | array | List of Ceph clusters affected by this incident. |
| storageArrays | array | List of storage arrays affected by this incident. |
| cloudResources | array | List of cloud resources affected by this incident. |
| databaseServers | array | List of databases affected by this incident. |
| dockerResources | array | List of Docker resources (containers, images, networks, volumes) affected by this incident. |
| podmanResources | array | List of Podman resources (containers, images, networks, volumes) affected by this incident. |
| services | array | List of services affected by this incident. |
get_incidentRetrieve a single Incident by its unique ID from OneUptime. Use list_incidents first if you need to find the ID.Retrieve a single Incident by its unique ID from OneUptime. Use list_incidents first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Incident (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly… |
list_incidentsList and search Incidents from OneUptime with optional filtering, pagination, and sorting. Returns an array of Incident objects plus the total matching count.List and search Incidents from OneUptime with optional filtering, pagination, and sorting. Returns an array of Incident objects plus the total matching count.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Incidents. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo,… |
| select | array | Optional: field names to return for each Incident (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_incidentUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident to update. Required. Use list_incidents to find IDs. |
| title | string | Title of this incident. |
| description | string | Short description of this incident. This is in markdown and will be visible on the status page. |
| declaredAt | object | Date and time when this incident was declared. |
| impactStartedAt | object | When customer impact actually began. Left blank until someone records it - never inferred, because a guessed value is worse than no value. |
| monitors | array | List of monitors affected by this incident. |
| hosts | array | List of hosts affected by this incident. |
| networkDevices | array | List of network devices affected by this incident. |
| kubernetesClusters | array | List of Kubernetes clusters affected by this incident. |
| kubernetesResources | array | List of Kubernetes resources (pods, deployments, nodes, etc.) affected by this incident. |
| kubernetesContainers | array | List of Kubernetes containers affected by this incident. |
| dockerHosts | array | List of Docker hosts affected by this incident. |
| podmanHosts | array | List of Podman hosts affected by this incident. |
| proxmoxClusters | array | List of Proxmox clusters affected by this incident. |
| vmwareVCenters | array | List of vCenters affected by this incident. |
| iotFleets | array | List of IoT fleets affected by this incident. |
| dockerSwarmClusters | array | List of Docker Swarm clusters affected by this incident. |
| cephClusters | array | List of Ceph clusters affected by this incident. |
| storageArrays | array | List of storage arrays affected by this incident. |
| cloudResources | array | List of cloud resources affected by this incident. |
| databaseServers | array | List of databases affected by this incident. |
| dockerResources | array | List of Docker resources (containers, images, networks, volumes) affected by this incident. |
| podmanResources | array | List of Podman resources (containers, images, networks, volumes) affected by this incident. |
| services | array | List of services affected by this incident. |
delete_incidentprivilegiertPermanently delete a Incident from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Incident from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident to delete. This action is irreversible. |
count_incidentsCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Incidents. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "valu… |
create_incident_state_timelineCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| incidentId* | string | Relation to Incident ID in which this resource belongs. |
| incidentStateId* | string | Incident State ID Relation. Which incident state does this incident change to? |
| shouldStatusPageSubscribersBeNotified | boolean | Should subscribers be notified about this state change? |
| rootCause | string | What is the root cause of this status change? |
| endsAt | object | When did this status change end? |
| startsAt | object | When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value. |
get_incident_state_timelineRetrieve a single Incident State Timeline by its unique ID from OneUptime. Use list_incident_state_timelines first if you need to find the ID.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident State Timeline to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Incident State Timeline (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (req… |
list_incident_state_timelinesList 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Incident State Timelines. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Oper… |
| select | array | Optional: field names to return for each Incident State Timeline (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (req… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_incident_state_timelineUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident State Timeline to update. Required. Use list_incident_state_timelines to find IDs. |
| incidentStateId | string | Incident State ID Relation. Which incident state does this incident change to? |
| startsAt | object | When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value. |
delete_incident_state_timelineprivilegiertPermanently delete a Incident State Timeline from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Incident State Timeline from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident State Timeline to delete. This action is irreversible. |
count_incident_state_timelinesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Incident State Timelines. Each field accepts a direct value (exact match) or an operator object {"_type": "<Op… |
create_incident_internal_noteCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| incidentId* | string | Relation to Incident ID in which this resource belongs. |
| note | string | Notes in markdown. |
| attachments | array | Files attached to this note. |
| postedFromSlackMessageId | string | Unique identifier for the Slack message this note was created from (channel_id:message_ts). Used to prevent duplicate notes when multiple users react to the sa… |
| postedAt | object | Date and time the note belongs to in the timeline: when it was written, or - for a note saved from a Slack or Microsoft Teams message - when that message was p… |
get_incident_internal_noteRetrieve a single Incident Internal Note by its unique ID from OneUptime. Use list_incident_internal_notes first if you need to find the ID.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident Internal Note to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Incident Internal Note (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (requ… |
list_incident_internal_notesList 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Incident Internal Notes. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Opera… |
| select | array | Optional: field names to return for each Incident Internal Note (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (requ… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_incident_internal_noteUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident Internal Note to update. Required. Use list_incident_internal_notes to find IDs. |
| note | string | Notes in markdown. |
| attachments | array | Files attached to this note. |
| postedAt | object | Date and time the note belongs to in the timeline: when it was written, or - for a note saved from a Slack or Microsoft Teams message - when that message was p… |
delete_incident_internal_noteprivilegiertPermanently delete a Incident Internal Note from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Incident Internal Note from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident Internal Note to delete. This action is irreversible. |
count_incident_internal_notesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Incident Internal Notes. Each field accepts a direct value (exact match) or an operator object {"_type": "<Ope… |
create_incident_public_noteCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| incidentId* | string | Relation to Incident ID in which this resource belongs. |
| note | string | Notes in markdown. |
| attachments | array | Files attached to this note. |
| shouldStatusPageSubscribersBeNotifiedOnNoteCreated | boolean | Should subscribers be notified about this note? If left out, this follows the incident: true when subscribers were notified that the incident was declared, fal… |
| postedAt | object | Date and time when the note was posted. |
| postedFromSlackMessageId | string | Unique identifier for the Slack message this note was created from (channel_id:message_ts). Used to prevent duplicate notes when multiple users react to the sa… |
get_incident_public_noteRetrieve a single Incident Public Note by its unique ID from OneUptime. Use list_incident_public_notes first if you need to find the ID.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident Public Note to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Incident Public Note (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (reques… |
list_incident_public_notesList 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Incident Public Notes. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operato… |
| select | array | Optional: field names to return for each Incident Public Note (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (reques… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_incident_public_noteUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident Public Note to update. Required. Use list_incident_public_notes to find IDs. |
| note | string | Notes in markdown. |
| attachments | array | Files attached to this note. |
| postedAt | object | Date and time when the note was posted. |
delete_incident_public_noteprivilegiertPermanently delete a Incident Public Note from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Incident Public Note from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident Public Note to delete. This action is irreversible. |
count_incident_public_notesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Incident Public Notes. Each field accepts a direct value (exact match) or an operator object {"_type": "<Opera… |
create_incident_severityCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| name* | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| color* | object | Color of this resource in Hex (#32a852 for example). |
| order | integer | Where this severity ranks among the project's incident severities: 1 is the most severe. A new severity without a number goes to the end of the list. Setting a… |
| isArchived | boolean | Archived severities stay on the incidents and episodes that have them, but can't be picked again. A project keeps at least one severity that is not archived. |
get_incident_severityRetrieve a single Incident Severity by its unique ID from OneUptime. Use list_incident_severities first if you need to find the ID.Retrieve a single Incident Severity by its unique ID from OneUptime. Use list_incident_severities first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident Severity to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Incident Severity (e.g. ["_id", "name"]). Omit to get all readable fields. |
list_incident_severitiesList and search Incident Severities from OneUptime with optional filtering, pagination, and sorting. Returns an array of Incident Severity objects plus the total matching count.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Incident Severities. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators… |
| select | array | Optional: field names to return for each Incident Severity (e.g. ["_id", "name"]). Omit to get all readable fields. |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_incident_severityUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident Severity to update. Required. Use list_incident_severities to find IDs. |
| name | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| color | object | Color of this resource in Hex (#32a852 for example). |
| order | integer | Where this severity ranks among the project's incident severities: 1 is the most severe. A new severity without a number goes to the end of the list. Setting a… |
| isArchived | boolean | Archived severities stay on the incidents and episodes that have them, but can't be picked again. A project keeps at least one severity that is not archived. |
delete_incident_severityprivilegiertPermanently delete a Incident Severity from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Incident Severity from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident Severity to delete. This action is irreversible. |
count_incident_severitiesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Incident Severities. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operato… |
create_postmortem_statusCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| name* | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| color* | object | Color of this resource in Hex (#32a852 for example). |
| isNotStartedStatus | boolean | 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 | 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 | 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 on… |
| order | integer | Where this status sits in the project's list of postmortem statuses: 1 is the top. A postmortem in the completed status, or in a status below it, counts as don… |
| isArchived | boolean | Archived statuses stay on the incidents whose postmortems are in them, but can't be picked again. The not started, draft and completed statuses can't be archiv… |
get_postmortem_statusRetrieve a single Postmortem Status by its unique ID from OneUptime. Use list_postmortem_statuses first if you need to find the ID.Retrieve a single Postmortem Status by its unique ID from OneUptime. Use list_postmortem_statuses first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Postmortem Status to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Postmortem Status (e.g. ["_id", "name"]). Omit to get all readable fields. |
list_postmortem_statusesList and search Postmortem Statuses from OneUptime with optional filtering, pagination, and sorting. Returns an array of Postmortem Status objects plus the total matching count.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Postmortem Statuses. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators… |
| select | array | Optional: field names to return for each Postmortem Status (e.g. ["_id", "name"]). Omit to get all readable fields. |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_postmortem_statusUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Postmortem Status to update. Required. Use list_postmortem_statuses to find IDs. |
| name | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| color | object | Color of this resource in Hex (#32a852 for example). |
| isNotStartedStatus | boolean | 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 | 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 | 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 on… |
| order | integer | Where this status sits in the project's list of postmortem statuses: 1 is the top. A postmortem in the completed status, or in a status below it, counts as don… |
| isArchived | boolean | Archived statuses stay on the incidents whose postmortems are in them, but can't be picked again. The not started, draft and completed statuses can't be archiv… |
delete_postmortem_statusprivilegiertPermanently delete a Postmortem Status from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Postmortem Status from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Postmortem Status to delete. This action is irreversible. |
count_postmortem_statusesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Postmortem Statuses. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operato… |
create_alert_stateCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| name* | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| color* | object | Color of this resource in Hex (#32a852 for example). |
| isCreatedState | boolean | Is it the created state of the alert? |
| isAcknowledgedState | boolean | Is it the acknowledged state of the alert? |
| isResolvedState | boolean | Is it the resolved state of the alert? |
| order | integer | Where this state sits in the project's list of alert states: 1 is the top. Alerts only ever move down the list, and an alert in a state at or below the acknowl… |
| isArchived | boolean | Archived states stay on the alerts and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived. |
get_alert_stateRetrieve a single Alert State by its unique ID from OneUptime. Use list_alert_states first if you need to find the ID.Retrieve a single Alert State by its unique ID from OneUptime. Use list_alert_states first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Alert State to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Alert State (e.g. ["_id", "name"]). Omit to get all readable fields. |
list_alert_statesList and search Alert States from OneUptime with optional filtering, pagination, and sorting. Returns an array of Alert State objects plus the total matching count.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Alert States. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: Equal… |
| select | array | Optional: field names to return for each Alert State (e.g. ["_id", "name"]). Omit to get all readable fields. |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_alert_stateUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Alert State to update. Required. Use list_alert_states to find IDs. |
| name | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| color | object | Color of this resource in Hex (#32a852 for example). |
| isCreatedState | boolean | Is it the created state of the alert? |
| isAcknowledgedState | boolean | Is it the acknowledged state of the alert? |
| isResolvedState | boolean | Is it the resolved state of the alert? |
| order | integer | Where this state sits in the project's list of alert states: 1 is the top. Alerts only ever move down the list, and an alert in a state at or below the acknowl… |
| isArchived | boolean | Archived states stay on the alerts and episodes that are in them, but can't be picked again. The created, acknowledged and resolved states can't be archived. |
delete_alert_stateprivilegiertPermanently delete a Alert State from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Alert State from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Alert State to delete. This action is irreversible. |
count_alert_statesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Alert States. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "v… |
create_alertCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| title* | string | Title of this alert. |
| description | string | Short description of this alert. This will be visible on the status page. This is in markdown. |
| impactStartedAt | object | When customer impact actually began. Left blank until someone records it - never inferred, because a guessed value is worse than no value. |
| monitorId | string | ID of the monitor this alert belongs to. |
| onCallDutyPolicies | array | List of on-call duty policies affected by this alert. |
| hosts | array | List of hosts affected by this alert. |
| networkDevices | array | List of network devices affected by this alert. |
| kubernetesClusters | array | List of Kubernetes clusters affected by this alert. |
| kubernetesResources | array | List of Kubernetes resources (pods, deployments, nodes, etc.) affected by this alert. |
| kubernetesContainers | array | List of Kubernetes containers affected by this alert. |
| dockerHosts | array | List of Docker hosts affected by this alert. |
| podmanHosts | array | List of Podman hosts affected by this alert. |
| proxmoxClusters | array | List of Proxmox clusters affected by this alert. |
| vmwareVCenters | array | List of vCenters affected by this alert. |
| iotFleets | array | List of IoT fleets affected by this alert. |
| dockerSwarmClusters | array | List of Docker Swarm clusters affected by this alert. |
| cephClusters | array | List of Ceph clusters affected by this alert. |
| storageArrays | array | List of storage arrays affected by this alert. |
| cloudResources | array | List of cloud resources affected by this alert. |
| databaseServers | array | List of databases affected by this alert. |
| dockerResources | array | List of Docker resources (containers, images, networks, volumes) affected by this alert. |
| podmanResources | array | List of Podman resources (containers, images, networks, volumes) affected by this alert. |
| services | array | List of services affected by this alert. |
get_alertRetrieve a single Alert by its unique ID from OneUptime. Use list_alerts first if you need to find the ID.Retrieve a single Alert by its unique ID from OneUptime. Use list_alerts first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Alert to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Alert (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if… |
list_alertsList and search Alerts from OneUptime with optional filtering, pagination, and sorting. Returns an array of Alert objects plus the total matching count.List and search Alerts from OneUptime with optional filtering, pagination, and sorting. Returns an array of Alert objects plus the total matching count.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Alerts. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, No… |
| select | array | Optional: field names to return for each Alert (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_alertUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Alert to update. Required. Use list_alerts to find IDs. |
| title | string | Title of this alert. |
| description | string | Short description of this alert. This will be visible on the status page. This is in markdown. |
| impactStartedAt | object | When customer impact actually began. Left blank until someone records it - never inferred, because a guessed value is worse than no value. |
| monitorId | string | ID of the monitor this alert belongs to. |
| onCallDutyPolicies | array | List of on-call duty policies affected by this alert. |
| hosts | array | List of hosts affected by this alert. |
| networkDevices | array | List of network devices affected by this alert. |
| kubernetesClusters | array | List of Kubernetes clusters affected by this alert. |
| kubernetesResources | array | List of Kubernetes resources (pods, deployments, nodes, etc.) affected by this alert. |
| kubernetesContainers | array | List of Kubernetes containers affected by this alert. |
| dockerHosts | array | List of Docker hosts affected by this alert. |
| podmanHosts | array | List of Podman hosts affected by this alert. |
| proxmoxClusters | array | List of Proxmox clusters affected by this alert. |
| vmwareVCenters | array | List of vCenters affected by this alert. |
| iotFleets | array | List of IoT fleets affected by this alert. |
| dockerSwarmClusters | array | List of Docker Swarm clusters affected by this alert. |
| cephClusters | array | List of Ceph clusters affected by this alert. |
| storageArrays | array | List of storage arrays affected by this alert. |
| cloudResources | array | List of cloud resources affected by this alert. |
| databaseServers | array | List of databases affected by this alert. |
| dockerResources | array | List of Docker resources (containers, images, networks, volumes) affected by this alert. |
| podmanResources | array | List of Podman resources (containers, images, networks, volumes) affected by this alert. |
| services | array | List of services affected by this alert. |
delete_alertprivilegiertPermanently delete a Alert from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Alert from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Alert to delete. This action is irreversible. |
count_alertsCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Alerts. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value":… |
create_alert_state_timelineCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| alertId* | string | Relation to Alert ID in which this resource belongs. |
| alertStateId* | string | Alert State ID Relation. Which alert state does this alert change to? |
| rootCause | string | What is the root cause of this status change? |
| endsAt | object | When did this status change end? |
| startsAt | object | When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value. |
get_alert_state_timelineRetrieve a single Alert State Timeline by its unique ID from OneUptime. Use list_alert_state_timelines first if you need to find the ID.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Alert State Timeline to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Alert State Timeline (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (reques… |
list_alert_state_timelinesList 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Alert State Timelines. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operato… |
| select | array | Optional: field names to return for each Alert State Timeline (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (reques… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_alert_state_timelineUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Alert State Timeline to update. Required. Use list_alert_state_timelines to find IDs. |
| alertStateId | string | Alert State ID Relation. Which alert state does this alert change to? |
| startsAt | object | When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value. |
delete_alert_state_timelineprivilegiertPermanently delete a Alert State Timeline from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Alert State Timeline from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Alert State Timeline to delete. This action is irreversible. |
count_alert_state_timelinesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Alert State Timelines. Each field accepts a direct value (exact match) or an operator object {"_type": "<Opera… |
create_alert_internal_noteCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| alertId* | string | Relation to Alert ID in which this resource belongs. |
| note | string | Notes in markdown. |
| attachments | array | Files attached to this note. |
| postedFromSlackMessageId | string | Unique identifier for the Slack message this note was created from (channel_id:message_ts). Used to prevent duplicate notes when multiple users react to the sa… |
| postedAt | object | Date and time the note belongs to in the timeline: when it was written, or - for a note saved from a Slack or Microsoft Teams message - when that message was p… |
get_alert_internal_noteRetrieve a single Alert Internal Note by its unique ID from OneUptime. Use list_alert_internal_notes first if you need to find the ID.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Alert Internal Note to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Alert Internal Note (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request… |
list_alert_internal_notesList 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Alert Internal Notes. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operator… |
| select | array | Optional: field names to return for each Alert Internal Note (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (request… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_alert_internal_noteUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Alert Internal Note to update. Required. Use list_alert_internal_notes to find IDs. |
| note | string | Notes in markdown. |
| attachments | array | Files attached to this note. |
| postedAt | object | Date and time the note belongs to in the timeline: when it was written, or - for a note saved from a Slack or Microsoft Teams message - when that message was p… |
delete_alert_internal_noteprivilegiertPermanently delete a Alert Internal Note from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Alert Internal Note from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Alert Internal Note to delete. This action is irreversible. |
count_alert_internal_notesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Alert Internal Notes. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operat… |
create_alert_severityCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| name* | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| color* | object | Color of this resource in Hex (#32a852 for example). |
| order | integer | Where this severity ranks among the project's alert severities: 1 is the most severe. A new severity without a number goes to the end of the list. Setting a nu… |
| isArchived | boolean | Archived severities stay on the alerts and episodes that have them, but can't be picked again. A project keeps at least one severity that is not archived. |
get_alert_severityRetrieve a single Alert Severity by its unique ID from OneUptime. Use list_alert_severities first if you need to find the ID.Retrieve a single Alert Severity by its unique ID from OneUptime. Use list_alert_severities first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Alert Severity to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Alert Severity (e.g. ["_id", "name"]). Omit to get all readable fields. |
list_alert_severitiesList and search Alert Severities from OneUptime with optional filtering, pagination, and sorting. Returns an array of Alert Severity objects plus the total matching count.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Alert Severities. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: E… |
| select | array | Optional: field names to return for each Alert Severity (e.g. ["_id", "name"]). Omit to get all readable fields. |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_alert_severityUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Alert Severity to update. Required. Use list_alert_severities to find IDs. |
| name | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| color | object | Color of this resource in Hex (#32a852 for example). |
| order | integer | Where this severity ranks among the project's alert severities: 1 is the most severe. A new severity without a number goes to the end of the list. Setting a nu… |
| isArchived | boolean | Archived severities stay on the alerts and episodes that have them, but can't be picked again. A project keeps at least one severity that is not archived. |
delete_alert_severityprivilegiertPermanently delete a Alert Severity from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Alert Severity from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Alert Severity to delete. This action is irreversible. |
count_alert_severitiesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Alert Severities. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>"… |
create_incident_alertCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| incidentId* | string | ID of the Incident this alert is linked to. |
| alertId* | string | ID of the Alert that is linked to the incident. |
get_incident_alertRetrieve a single Incident Alert by its unique ID from OneUptime. Use list_incident_alerts first if you need to find the ID.Retrieve a single Incident Alert by its unique ID from OneUptime. Use list_incident_alerts first if you need to find the ID.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident Alert to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Incident Alert (e.g. ["_id", "name"]). Omit to get all readable fields. |
list_incident_alertsList and search Incident Alerts from OneUptime with optional filtering, pagination, and sorting. Returns an array of Incident Alert objects plus the total matching count.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Incident Alerts. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: Eq… |
| select | array | Optional: field names to return for each Incident Alert (e.g. ["_id", "name"]). Omit to get all readable fields. |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_incident_alertUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident Alert to update. Required. Use list_incident_alerts to find IDs. |
delete_incident_alertprivilegiertPermanently delete a Incident Alert from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Incident Alert from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Incident Alert to delete. This action is irreversible. |
count_incident_alertsCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Incident Alerts. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>",… |
create_monitor_status_eventCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| monitorId* | string | Relation to Monitor ID Resource in which this object belongs. |
| monitorStatusId* | string | Relation to Monitor Status ID Resource in which this object belongs. |
| rootCause | string | What is the root cause of this status change? |
| endsAt | object | When did this status change end? |
| startsAt | object | When did this status change? |
get_monitor_status_eventRetrieve a single Monitor Status Event by its unique ID from OneUptime. Use list_monitor_status_events first if you need to find the ID.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Monitor Status Event to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Monitor Status Event (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (reques… |
list_monitor_status_eventsList 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Monitor Status Events. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operato… |
| select | array | Optional: field names to return for each Monitor Status Event (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (reques… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_monitor_status_eventUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Monitor Status Event to update. Required. Use list_monitor_status_events to find IDs. |
| monitorStatusId | string | Relation to Monitor Status ID Resource in which this object belongs. |
delete_monitor_status_eventprivilegiertPermanently delete a Monitor Status Event from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Monitor Status Event from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Monitor Status Event to delete. This action is irreversible. |
count_monitor_status_eventsCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Monitor Status Events. Each field accepts a direct value (exact match) or an operator object {"_type": "<Opera… |
create_status_page_announcementCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| statusPages | array | Status Pages to show show this announcement on. |
| monitors | array | List of monitors affected by this announcement. If none are selected, all subscribers will be notified. |
| title* | string | Title of this resource. |
| showAnnouncementAt* | object | When should this announcement be shown? |
| endAnnouncementAt | object | When should this announcement hidden? |
| description* | string | Text of the announcement. This can be in Markdown format. |
| attachments | array | Files attached to this announcement. |
| shouldStatusPageSubscribersBeNotified | boolean | Should subscribers be notified about this announcement? |
get_status_page_announcementRetrieve a single Status Page Announcement by its unique ID from OneUptime. Use list_status_page_announcements first if you need to find the ID.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Status Page Announcement to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Status Page Announcement (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (re… |
list_status_page_announcementsList 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Status Page Announcements. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Ope… |
| select | array | Optional: field names to return for each Status Page Announcement (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default (re… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_status_page_announcementUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Status Page Announcement to update. Required. Use list_status_page_announcements to find IDs. |
| statusPages | array | Status Pages to show show this announcement on. |
| monitors | array | List of monitors affected by this announcement. If none are selected, all subscribers will be notified. |
| title | string | Title of this resource. |
| showAnnouncementAt | object | When should this announcement be shown? |
| endAnnouncementAt | object | When should this announcement hidden? |
| description | string | Text of the announcement. This can be in Markdown format. |
| attachments | array | Files attached to this announcement. |
delete_status_page_announcementprivilegiertPermanently delete a Status Page Announcement from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Status Page Announcement from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Status Page Announcement to delete. This action is irreversible. |
count_status_page_announcementsCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Status Page Announcements. Each field accepts a direct value (exact match) or an operator object {"_type": "<O… |
create_scheduled_maintenance_stateCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| name* | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| color* | object | Color of this resource in Hex (#32a852 for example). |
| isScheduledState | boolean | Is this state a scheduled state? |
| isOngoingState | boolean | Is this state a ongoing state? |
| isEndedState | boolean | Is this state a ended state? |
| isResolvedState | boolean | Is this state a resolved state? |
| order | integer | Where this state sits in the project's list of scheduled maintenance states: 1 is the top. Events only ever move down the list, so the scheduled, ongoing, ende… |
| isArchived | boolean | Archived states stay on the maintenance events that are in them, but can't be picked again. The scheduled, ongoing, ended and completed states can't be archive… |
get_scheduled_maintenance_stateRetrieve a single Scheduled Maintenance State by its unique ID from OneUptime. Use list_scheduled_maintenance_states first if you need to find the ID.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Scheduled Maintenance State to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Scheduled Maintenance State (e.g. ["_id", "name"]). Omit to get all readable fields. |
list_scheduled_maintenance_statesList 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Scheduled Maintenance States. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}.… |
| select | array | Optional: field names to return for each Scheduled Maintenance State (e.g. ["_id", "name"]). Omit to get all readable fields. |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_scheduled_maintenance_stateUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Scheduled Maintenance State to update. Required. Use list_scheduled_maintenance_states to find IDs. |
| name | string | Any friendly name of this object. |
| description | string | Friendly description that will help you remember. |
| color | object | Color of this resource in Hex (#32a852 for example). |
| isScheduledState | boolean | Is this state a scheduled state? |
| isOngoingState | boolean | Is this state a ongoing state? |
| isEndedState | boolean | Is this state a ended state? |
| isResolvedState | boolean | Is this state a resolved state? |
| order | integer | Where this state sits in the project's list of scheduled maintenance states: 1 is the top. Events only ever move down the list, so the scheduled, ongoing, ende… |
| isArchived | boolean | Archived states stay on the maintenance events that are in them, but can't be picked again. The scheduled, ongoing, ended and completed states can't be archive… |
delete_scheduled_maintenance_stateprivilegiertPermanently delete a Scheduled Maintenance State from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Scheduled Maintenance State from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Scheduled Maintenance State to delete. This action is irreversible. |
count_scheduled_maintenance_statesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Scheduled Maintenance States. Each field accepts a direct value (exact match) or an operator object {"_type":… |
create_scheduled_maintenance_eventCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| title* | string | Title of this scheduled event. |
| description | string | Description of this scheduled event that will show up on Status Page. This is in markdown. |
| monitors | array | List of monitors attached to this event. |
| hosts | array | List of hosts affected by this event. |
| kubernetesClusters | array | List of Kubernetes clusters affected by this event. |
| dockerHosts | array | List of Docker hosts affected by this event. |
| podmanHosts | array | List of Podman hosts affected by this event. |
| proxmoxClusters | array | List of Proxmox clusters affected by this event. |
| vmwareVCenters | array | List of vCenters affected by this event. |
| iotFleets | array | List of IoT fleets affected by this event. |
| networkSites | array | List of network sites affected by this event. Their descendants are covered too. |
| dockerSwarmClusters | array | List of Docker Swarm clusters affected by this event. |
| cephClusters | array | List of Ceph clusters affected by this event. |
| storageArrays | array | List of storage arrays affected by this event. |
| databaseServers | array | List of databases affected by this event. |
| services | array | List of services affected by this event. |
| statusPages | array | List of status pages to show this event on. |
| labels | array | Relation to Labels Array where this object is categorized in. |
| currentScheduledMaintenanceStateId | string | Scheduled Maintenance State ID. The state the event currently is in. |
| changeMonitorStatusToId | string | Relation to Monitor Status Object ID. The monitors attached to this event change to this status when the event starts, and back to operational when it ends. It… |
| startsAt* | object | When does this event start? |
| endsAt* | object | When does this event end? |
| shouldStatusPageSubscribersBeNotifiedOnEventCreated | boolean | Should subscribers be notified about this event creation? |
get_scheduled_maintenance_eventRetrieve a single Scheduled Maintenance Event by its unique ID from OneUptime. Use list_scheduled_maintenance_events first if you need to find the ID.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Scheduled Maintenance Event to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Scheduled Maintenance Event (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default… |
list_scheduled_maintenance_eventsList 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Scheduled Maintenance Events. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}.… |
| select | array | Optional: field names to return for each Scheduled Maintenance Event (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by default… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_scheduled_maintenance_eventUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Scheduled Maintenance Event to update. Required. Use list_scheduled_maintenance_events to find IDs. |
| title | string | Title of this scheduled event. |
| description | string | Description of this scheduled event that will show up on Status Page. This is in markdown. |
| monitors | array | List of monitors attached to this event. |
| hosts | array | List of hosts affected by this event. |
| kubernetesClusters | array | List of Kubernetes clusters affected by this event. |
| dockerHosts | array | List of Docker hosts affected by this event. |
| podmanHosts | array | List of Podman hosts affected by this event. |
| proxmoxClusters | array | List of Proxmox clusters affected by this event. |
| vmwareVCenters | array | List of vCenters affected by this event. |
| iotFleets | array | List of IoT fleets affected by this event. |
| networkSites | array | List of network sites affected by this event. Their descendants are covered too. |
| dockerSwarmClusters | array | List of Docker Swarm clusters affected by this event. |
| cephClusters | array | List of Ceph clusters affected by this event. |
| storageArrays | array | List of storage arrays affected by this event. |
| databaseServers | array | List of databases affected by this event. |
| services | array | List of services affected by this event. |
| statusPages | array | List of status pages to show this event on. |
| labels | array | Relation to Labels Array where this object is categorized in. |
| currentScheduledMaintenanceStateId | string | Scheduled Maintenance State ID. The state the event currently is in. |
| changeMonitorStatusToId | string | Relation to Monitor Status Object ID. The monitors attached to this event change to this status when the event starts, and back to operational when it ends. It… |
| startsAt | object | When does this event start? |
| endsAt | object | When does this event end? |
| customFields | object | Custom Fields on this resource. |
delete_scheduled_maintenance_eventprivilegiertPermanently delete a Scheduled Maintenance Event from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Scheduled Maintenance Event from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Scheduled Maintenance Event to delete. This action is irreversible. |
count_scheduled_maintenance_eventsCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Scheduled Maintenance Events. Each field accepts a direct value (exact match) or an operator object {"_type":… |
create_scheduled_maintenance_state_timelineCreate 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.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 | Typ | Beschreibung |
|---|---|---|
| projectId | string | ID of your OneUptime Project in which this object belongs. |
| scheduledMaintenanceId* | string | ID of Scheduled Maintenance this resource belongs to. |
| scheduledMaintenanceStateId* | string | Scheduled Maintenance State ID. Which state does this event belongs to? |
| shouldStatusPageSubscribersBeNotified | boolean | Should subscribers be notified about this state change? |
| endsAt | object | When did this status change end? |
| startsAt | object | When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value. |
get_scheduled_maintenance_state_timelineRetrieve 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Scheduled Maintenance State Timeline to retrieve. Example: "550e8400-e29b-41d4-a716-446655440000" |
| select | array | Optional: field names to return for each Scheduled Maintenance State Timeline (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by… |
list_scheduled_maintenance_state_timelinesList 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Scheduled Maintenance State Timelines. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value… |
| select | array | Optional: field names to return for each Scheduled Maintenance State Timeline (e.g. ["_id", "name"]). Omit to get all readable fields. Large fields excluded by… |
| skip | number | Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. |
| sort | object | Sort order for results. Use "ASC" for ascending or "DESC" for descending. Example: {"createdAt": "DESC"} to sort by newest first. |
update_scheduled_maintenance_state_timelineUpdate 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.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 | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Scheduled Maintenance State Timeline to update. Required. Use list_scheduled_maintenance_state_timelines to find IDs. |
| scheduledMaintenanceStateId | string | Scheduled Maintenance State ID. Which state does this event belongs to? |
| startsAt | object | When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value. |
delete_scheduled_maintenance_state_timelineprivilegiertPermanently delete a Scheduled Maintenance State Timeline from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.Permanently delete a Scheduled Maintenance State Timeline from OneUptime. This action cannot be undone. Returns a confirmation message upon successful deletion.
| Parameter | Typ | Beschreibung |
|---|---|---|
| id* | string | The unique identifier (UUID) of the Scheduled Maintenance State Timeline to delete. This action is irreversible. |
count_scheduled_maintenance_state_timelinesCount 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.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 | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. If omitted, counts all Scheduled Maintenance State Timelines. Each field accepts a direct value (exact match) or an operator object {… |
list_logsQuery 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, NotN…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, NotN…
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Logs. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "va… |
| select | object | Fields to return, as an object of field names to true (e.g. {"time": true, "body": true}). Select only the fields you need — telemetry rows can be large. |
| skip | number | Number of records to skip. Default: 0. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries. |
| sort | object | Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first. |
count_logsCount Logs telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.Count Logs telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotE… |
list_spansQuery 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, Not…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, Not…
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Spans. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "v… |
| select | object | Fields to return, as an object of field names to true (e.g. {"time": true, "body": true}). Select only the fields you need — telemetry rows can be large. |
| skip | number | Number of records to skip. Default: 0. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries. |
| sort | object | Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first. |
count_spansCount Spans telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.Count Spans telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotE… |
list_metricsQuery 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, N…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, N…
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Metrics. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>",… |
| select | object | Fields to return, as an object of field names to true (e.g. {"time": true, "body": true}). Select only the fields you need — telemetry rows can be large. |
| skip | number | Number of records to skip. Default: 0. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries. |
| sort | object | Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first. |
count_metricsCount Metrics telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.Count Metrics telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotE… |
list_exception_instancesQuery 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, NotEqua…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, NotEqua…
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Filter criteria for Exception Instances. Always include a time-range filter. Each field accepts a direct value (exact match) or an operator object {"_type": "<… |
| select | object | Fields to return, as an object of field names to true (e.g. {"time": true, "body": true}). Select only the fields you need — telemetry rows can be large. |
| skip | number | Number of records to skip. Default: 0. |
| limit | number | Maximum number of records to return. Default: 10, Maximum: 100. Keep small for telemetry queries. |
| sort | object | Sort order. Use "ASC" or "DESC". Example: {"time": "DESC"} for most recent first. |
count_exception_instancesCount Exception Instances telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.Count Exception Instances telemetry records in OneUptime, optionally filtered. Prefer counting with a time-range filter.
| Parameter | Typ | Beschreibung |
|---|---|---|
| query | object | Optional filter criteria. Each field accepts a direct value (exact match) or an operator object {"_type": "<Operator>", "value": ...}. Operators: EqualTo, NotE… |
200 von 200 Tools haben eine Beschreibung veröffentlicht.
Tool-Namen und -Beschreibungen stammen vom Publisher und werden wortgetreu als inerter Text angezeigt. Es sind die Zeichenketten, die ein MCP-Client an ein Modell übergibt, deshalb prüft Forge sie auf Prompt-Injection-Muster — jeder Befund erscheint oben beim Sicherheits-Scan. „Privilegiert“ ist ein Schlagwort-Treffer im Tool-Namen, keine Prüfung dessen, was das Tool tut: ein harmlos klingender Name kann trotzdem alles tun.
Manage incidents, alerts, monitors, status pages, on-call and telemetry in OneUptime.
+ 160 weitere bei diesem Eintrag beobachtet.
Verlinkte Namen öffnen den Forge-Index aller Einträge, bei denen dieses Tool beobachtet wurde. Alle indexierten Tools durchsuchen.
Dieser Eintrag veröffentlicht kein npm-Paket, daher hat Forge keinen Abhängigkeitsbaum dafür. Das ist eine Lücke in der Abdeckung — keine Aussage, dass er keine Abhängigkeiten hat.