--- title: "Get Auto Remediation Suggestion" method: POST path: "/auto-remediation-suggestion/{id}/get-item" tags: ["Auto Remediation Suggestion"] --- # Get Auto Remediation Suggestion `POST /auto-remediation-suggestion/{id}/get-item` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/auto-remediation-suggestion/{id}/get-item` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to retrieve a single Auto Remediation Suggestion by ID ## Path parameters - `id` string, uuid, required ## Request body - object - `select` AutoRemediationSuggestionSelectSchema: Select schema for AutoRemediationSuggestion. Set fields to true to include them in the response. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `projectId` boolean - `autoRemediationRuleId` boolean - `ruleNameSnapshot` boolean - `kubernetesClusterId` boolean - `resourceType` boolean - `resourceId` boolean - `incidentId` boolean - `alertId` boolean - `runbookId` boolean - `runbookNameSnapshot` boolean - `runbookTrackRecord` boolean - `status` boolean - `executionMode` boolean - `suggestionType` boolean - `commandPlan` boolean - `mcpToolCallPlan` boolean - `rationaleMarkdown` boolean - `aiRunId` boolean - `runbookExecutionId` boolean - `approvedByUserId` boolean - `approvedAt` boolean - `approvedFrom` boolean - `dismissedByUserId` boolean - `dismissedAt` boolean - `verificationStatus` boolean - `verificationDeadlineAt` boolean - `verificationCompletedAt` boolean - `verificationNote` boolean - `verificationWindowMinutes` boolean - `autoResolveOnRecovery` boolean ## Response `200` Successful response - object - `data` AutoRemediationSuggestion - `_id` string, uuid: ID of this object. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `version` number: Object version - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `autoRemediationRuleId` string, uuid: ID of the AI rule that produced this suggestion. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `ruleNameSnapshot` string: Name of the rule when this suggestion was created — survives rule deletion. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `kubernetesClusterId` string, uuid: ID of the cluster whose AI remediation mode produced this suggestion. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `resourceType` 'DockerHost' | 'PodmanHost' | 'DockerSwarmCluster' | 'ProxmoxCluster' | 'VMwareVCenter' | 'CephCluster' | 'DatabaseServer' | 'Host' | 'AwsAccount' | 'AzureSubscription' | 'GoogleCloudProject' | 'OpenStackCloud': The kind of resource whose AI remediation mode produced this suggestion (DockerHost, PodmanHost, DockerSwarmCluster, ProxmoxCluster, VMwareVCenter, CephCluster, DatabaseServer or Host; resource-level remediation, no rule). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `resourceId` string, uuid: ID of the resource whose AI remediation mode produced this suggestion, in the table its resource type names. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `incidentId` string, uuid: ID of the incident this suggestion remediates. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `alertId` string, uuid: ID of the alert this suggestion remediates. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `runbookId` string, uuid: ID of the proposed runbook. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `runbookNameSnapshot` string: Name of the proposed runbook when this suggestion was created — survives runbook deletion. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `runbookTrackRecord` object: How the proposed runbook went the last times OneUptime AI ran it for other incidents and alerts, when it was proposed. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `status` 'Planning' | 'Suggested' | 'Approved' | 'AutoExecuted' | 'Dismissed' | 'NoneApplicable', required: Lifecycle status: Planning, Suggested, Approved, AutoExecuted, Dismissed or NoneApplicable. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `executionMode` 'Suggest' | 'FullAuto', required: The rule's execution mode when this suggestion was created (Suggest or FullAuto). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `suggestionType` 'Runbook' | 'CommandPlan' | 'McpToolCalls', required: Runbook suggestions propose starting a pre-authored runbook; CommandPlan suggestions carry an AI-composed command plan; McpToolCalls suggestions carry the tool calls OneUptime AI makes, or proposes, through the project's external MCP servers. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `commandPlan` object: The AI-composed command plan for CommandPlan suggestions, including per-command execution results once run. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `mcpToolCallPlan` object: For McpToolCalls suggestions: the tool calls OneUptime AI made, or proposes, through the project's external MCP servers, with what each server answered once called. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `rationaleMarkdown` string: Why this runbook was proposed — the AI planning run's reasoning for AI rules, or a short note for deterministic rules. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `aiRunId` string, uuid: The AI planning run that picked the runbook (AI rules only). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `runbookExecutionId` string, uuid: The runbook execution started when this suggestion was approved or auto-executed. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `approvedByUserId` string, uuid: ID of the user who approved this suggestion. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `approvedAt` object: When this suggestion was approved. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `approvedFrom` 'Dashboard' | 'Slack' | 'MicrosoftTeams': Where this suggestion was approved: Dashboard (the AI card), Slack or MicrosoftTeams. Empty until approved. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `dismissedByUserId` string, uuid: ID of the user who dismissed this suggestion. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `dismissedAt` object: When this suggestion was dismissed. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `verificationStatus` 'Pending' | 'Verified' | 'Failed' | 'Skipped': Outcome verification after execution: Pending, Verified, Failed or Skipped. Empty until a runbook is started. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `verificationDeadlineAt` object: When the verification window closes — the monitors must be operational by this time. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `verificationCompletedAt` object: When verification reached a terminal outcome. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `verificationNote` string: Why verification ended the way it did. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `verificationWindowMinutes` number: Snapshot of the rule's verification window when this suggestion was created. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] - `autoResolveOnRecovery` boolean, required: Snapshot of the rule's auto-resolve-on-verified-recovery setting when this suggestion was created. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)