Monitor Template
List Monitor Template
Endpoint to list all Monitor Template items
post/monitor-template/get-list
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"query": {
"createdAt": {
"_type": "GreaterThan",
"value": "2026-01-01T00:00:00.000Z"
},
"templateName": {
"_type": "Search",
"value": "example"
}
},
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"templateName": true,
"monitorName": true,
"monitoringInterval": true
},
"sort": {
"createdAt": "DESC"
}
}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",
"templateName": "Example short text",
"templateDescription": "This is an example of longer text content that might be stored in this field.",
"slug": "example-slug-value",
"monitorName": "Example short text",
"monitorDescription": "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.",
"monitorType": "Manual",
"monitorSteps": {
"_type": "MonitorSteps",
"value": {
"monitorStepsInstanceArray": []
}
},
"monitoringInterval": "*/5 * * * *",
"labels": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"customFields": {
"key": "value",
"nested": {
"data": 123
}
},
"minimumProbeAgreement": 42,
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.