{ "opencollection": "1.0.0", "info": { "name": "ilert REST Alert Actions Schedules API", "version": "v2.2026.5-r.3" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Schedules", "type": "folder" }, "items": [ { "info": { "name": "List on-call schedules.", "type": "http" }, "http": { "method": "GET", "url": "/api/schedules", "params": [ { "name": "include", "value": "", "type": "query", "description": "Describes optional properties that should be included in the response. You may declare multiple. (currentShift, nextShift, scheduleLayers [only available for RECURRING schedules], shifts [only available for STATIC schedules], past [show shifts in the past, only for STATIC])" }, { "name": "start-index", "value": "", "type": "query", "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities" }, { "name": "max-results", "value": "", "type": "query", "description": "the maximum number of results when paging through a list of schedules." } ] }, "docs": "List on-call schedules." }, { "info": { "name": "Create a new on-call schedule.", "type": "http" }, "http": { "method": "POST", "url": "/api/schedules", "params": [ { "name": "abort-on-gaps", "value": "", "type": "query", "description": "Used for static schedules to prevent creating schedules with gaps" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new on-call schedule." }, { "info": { "name": "Get the on-call schedule with the specified id.", "type": "http" }, "http": { "method": "GET", "url": "/api/schedules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "entity ID" }, { "name": "include", "value": "", "type": "query", "description": "Describes optional properties that should be included in the response. You may declare multiple. (currentShift, nextShift, scheduleLayers [only available for RECURRING schedules], shifts [only available for STATIC schedules], past [show shifts in the past, only for STATIC])" } ] }, "docs": "Get the on-call schedule with the specified id." }, { "info": { "name": "Update an on-call schedule.", "type": "http" }, "http": { "method": "PUT", "url": "/api/schedules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "entity ID" }, { "name": "abort-on-gaps", "value": "", "type": "query", "description": "Used for static schedules to prevent updating schedules with gaps" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an on-call schedule." }, { "info": { "name": "Delete the on-call schedule with the specified id.", "type": "http" }, "http": { "method": "DELETE", "url": "/api/schedules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "entity ID" } ] }, "docs": "Delete the on-call schedule with the specified id." }, { "info": { "name": "Get shifts for the specified schedule and date range.", "type": "http" }, "http": { "method": "GET", "url": "/api/schedules/:id/shifts", "params": [ { "name": "id", "value": "", "type": "path", "description": "entity ID" }, { "name": "from", "value": "", "type": "query", "description": "from date, default is start of last month" }, { "name": "until", "value": "", "type": "query", "description": "until date, default is from date plus 3 months" }, { "name": "exclude-overrides", "value": "", "type": "query", "description": "if true, shifts won't include overrides" } ] }, "docs": "Get shifts for the specified schedule and date range." }, { "info": { "name": "Get overrides for the specified schedule.", "type": "http" }, "http": { "method": "GET", "url": "/api/schedules/:id/overrides", "params": [ { "name": "id", "value": "", "type": "path", "description": "entity ID" } ] }, "docs": "Get overrides for the specified schedule." }, { "info": { "name": "Add an override shift to a schedule.", "type": "http" }, "http": { "method": "PUT", "url": "/api/schedules/:id/overrides", "params": [ { "name": "id", "value": "", "type": "path", "description": "entity ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an override shift to a schedule." }, { "info": { "name": "Get the user (wrapped in a shift object) on-call for the specified schedule.", "type": "http" }, "http": { "method": "GET", "url": "/api/schedules/:id/user-on-call", "params": [ { "name": "id", "value": "", "type": "path", "description": "entity ID" } ] }, "docs": "Get the user (wrapped in a shift object) on-call for the specified schedule." } ] } ], "bundled": true }