Job monitors

Overview of all job monitors

GET https://cronly.app/api/monitors

Headers

Name	Type	Description
Authorization*	String	Bearer: API token

200 All of your registered monitors

[
    {
        "id": 1,
        "name": "Test monitor",
        "company_id": 1,
        "project_id": null,
        "token": "91d13ccf-f015-4e61-aae9-355627815800",
        "timezone": "UTC",
        "schedule": "* * * * *",
        "last_run_at": "2022-05-30T13:39:55.000000Z",
        "duration": 1,
        "is_alerted": 1,
        "alert_reason": "Monitor failed",
        "deleted_at": null,
        "created_at": "2022-05-30T13:15:07.000000Z",
        "updated_at": "2022-05-30T13:41:01.000000Z"
    }
]

Details of job monitor

GET https://cronly.app/api/monitors/{id}

Query Parameters

Name	Type	Description
id*	Integer	The ID of the job monitor you want to view

Headers

Name	Type	Description
Authorization*	String	Bearer: API token

200 The job monitor

{
    "id": 1,
    "name": "Test monitor",
    "company_id": 1,
    "project_id": null,
    "token": "91d13ccf-f015-4e61-aae9-355627815800",
    "timezone": "UTC",
    "schedule": "* * * * *",
    "last_run_at": "2022-05-30T13:39:55.000000Z",
    "duration": 1,
    "is_alerted": 1,
    "alert_reason": "Monitor failed",
    "deleted_at": null,
    "created_at": "2022-05-30T13:15:07.000000Z",
    "updated_at": "2022-05-30T13:41:01.000000Z"
}

404: Not Found The job monitor was not found

{
    "error": "Monitor not found"
}

Create a new job monitor

POST https://cronly.app/api/monitors

Headers

Name	Type	Description
Authorization*	String	Bearer: API token

Request Body

Name	Type	Description
name*	String
timezone*	String
project_id	Integer
schedule*	String
duration*	Integer

200 The newly created job monitor

{
    "name": "test",
    "project_id": "1",
    "timezone": "UTC",
    "schedule": "* * * * *",
    "duration": "1",
    "company_id": 1,
    "token": "6e9c5250-a609-4fcc-aec8-710104fd744e",
    "updated_at": "2022-05-31T19:47:36.000000Z",
    "created_at": "2022-05-31T19:47:36.000000Z",
    "id": 5
}

Delete a job monitor

DELETE https://cronly.app/api/monitors/{id}

Query Parameters

Name	Type	Description
id*	Integer	The ID of the job monitor you want to view

Headers

Name	Type	Description
Authorization*	String	Bearer: API token

204: No Content The job monitor has been deleted successfully

{
    "success": "Monitor deleted"
}

404: Not Found The job monitor was not found

{
    "error": "Monitor not found"
}