Auto Remediation Suggestion
Get Auto Remediation Suggestion
Endpoint to retrieve a single Auto Remediation Suggestion by ID
post/auto-remediation-suggestion/{id}/get-item
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
ID of the Auto Remediation Suggestion to retrieve
Request body
Example request
{
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"ruleNameSnapshot": true,
"resourceType": true,
"runbookNameSnapshot": true,
"status": true,
"executionMode": true
}
}Response
Successful response
Example response
{
"data": {
"_id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"version": 42,
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"autoRemediationRuleId": "123e4567-e89b-12d3-a456-426614174000",
"ruleNameSnapshot": "Example short text",
"kubernetesClusterId": "123e4567-e89b-12d3-a456-426614174000",
"resourceType": "DockerHost",
"resourceId": "123e4567-e89b-12d3-a456-426614174000",
"incidentId": "123e4567-e89b-12d3-a456-426614174000",
"alertId": "123e4567-e89b-12d3-a456-426614174000",
"runbookId": "123e4567-e89b-12d3-a456-426614174000",
"runbookNameSnapshot": "Example short text",
"runbookTrackRecord": {
"key": "value",
"nested": {
"data": 123
}
},
"status": "Planning",
"executionMode": "Suggest",
"suggestionType": "Runbook",
"commandPlan": {
"key": "value",
"nested": {
"data": 123
}
},
"mcpToolCallPlan": {
"key": "value",
"nested": {
"data": 123
}
},
"rationaleMarkdown": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
"aiRunId": "123e4567-e89b-12d3-a456-426614174000",
"runbookExecutionId": "123e4567-e89b-12d3-a456-426614174000",
"approvedByUserId": "123e4567-e89b-12d3-a456-426614174000",
"approvedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"approvedFrom": "Dashboard",
"dismissedByUserId": "123e4567-e89b-12d3-a456-426614174000",
"dismissedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"verificationStatus": "Pending",
"verificationDeadlineAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"verificationCompletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"verificationNote": "This is an example of longer text content that might be stored in this field.",
"verificationWindowMinutes": 42,
"autoResolveOnRecovery": true
}
}Changes
No recorded changes to this operation across all 1 revision of this API.