Scheduled Mutes API
Contents
POST /v2/schedules/
Request format:
{
"name": "string",
"start_time": "14:20",
"duration": 123,
"timezone": "UTC-2",
"repeat": ["mon", "tue", "wed", "thu", "fri", "sat", "sun"]
}
Parameters:
- name[REQUIRED]A name that uniquely identifies this scheduled mute.
- start_time[REQUIRED]A 24-hour time string at which the scheduled mute will begin.
- duration[REQUIRED]Mute time in minutes.
- timezoneThe timezone string for this scheduled mute’s start time. Valid values are “UTC-12”...”UTC-1”, “UTC”, “UTC+1”...”UTC+14”. Defaults to “UTC” if not specified.
- repeatThe list of days at which the scheduled mute will repeat on. Becomes a one-time scheduled mute if not specified. Valid values are “mon”, “tue”, “wed”, “thu”, “fri”, “sat” and “sun”.
Curl example
curl -H "Content-Type: application/json" -X POST -d \
'{"name": "Mute on weekends", "start_time": "00:00", "duration": 1440, "timezone": "UTC+2", "repeat": ["sat", "sun"]}' \
"https://[email protected]/v2/schedules/"
Creates a scheduled mute named “Mute on weekends” that starts at 12 AM in timezone UTC+2, with a mute duration of 24 hours, and repeats every Saturday and Sunday.
Response format:
HTTP/1.1 201
Content-Type: application/json
{
"id": "<scheduled_mute_id>",
"url": "/v2/schedules/<scheduled_mute_id>"
}
Parameters:
- idAn id that uniquely identifies this scheduled mute.
- urlURL endpoint that can be used to perform actions on this scheduled mute.
Status Codes:
- 201 - Created
- 400 - Invalid form data.
- 409 - Scheduled mute with the name already exists.
GET /v2/schedules/?
- Returns a JSON object containing information on scheduled mutes matching the search query. Returns all scheduled mutes if the parameter is left empty.Curl example:
curl -X GET "https://[email protected]/v2/schedules/?"
Parameters:
Available Parameters (default values in brackets):
- nameFormat:
&name=<scheduled_mute_name1>&name=<scheduled_mute_name2>
The scheduled mute name to search for. Can specify multiple scheduled mute names to search for more than 1. Performs anOR
operation so a query such as&name=<scheduled_mute_name1>&name=<scheduled_mute_name2>
will return info on bothscheduled_mute_name1
andscheduled_mute_name2
. - idFormat:
&id=<scheduled_mute_id1>&id=<scheduled_mute_id2>
The scheduled mute ID to search for. Can specify multiple scheduled mute IDs to search for more than 1. Performs anOR
operation so a query such as&name=<scheduled_mute_id1>&name=<scheduled_mute_id2>
will return info on bothscheduled_mute_id1
andscheduled_mute_id2
. - durationFormat:
&duration=<duration1>&id=<duration2>
Searches for scheduled mutes by their duration. Can specify multiple durations to search for. Performs anOR
operation so a query such as&duration=30&duration=10
will return scheduled mutes with a 10-minute duration or a 30-minute duration. - start_timeFormat:
&start_time=<start_time1>&start_time=<start_time2>
Searches for scheduled mutes by their start time. Can specify multiple start times to search for. Performs an OR operation so a query such as&start_time=12:00&start_time=20:00
will return scheduled mutes that start at either 12 PM or 8 PM. - timezoneFormat:
&timezone=<timezone1>&timezone=<timezone2>
Searches for scheduled mutes by their timezone. Can specify multiple time zones to search for. Performs an OR operation so a query such as&timezone=UTC+2&timezone=UTC-14
will return scheduled mutes that have either UTC+2 or UTC-14 time zones. - repeatFormat:
&repeat=<day1>&repeat=<day2>
Searches for scheduled mutes by their repeat days. Can specify multiple repeat days to search for. Performs an OR operation so a query such as&repeat=sun&repeat=thuwill return scheduled mutes that repeat on either Sunday or Thursday. - page (1)Format:
&page=1
The page number to query. Used if there are more items that can be displayed in a single request. - max(100)Format:
&max=50
The maximum number of items to display. Limit of 100.
Specifying multiple fields performs an
OR
operation and returns scheduled mutes that match either criterion.Response format:
HTTP/1.1 200
Content-Type: application/json
{
"scheduled_mutes": [
{
"name": "name of scheduled mute",
"id": "scheduled mute ID",
"duration": 123,
"alerts" : ["alert_id1", "alert_id2", "alert_id3"],
"start_time": "20:20",
"timezone": "UTC+4",
"repeat": ["mon", "wed", "fri"]
},
...
],
"next_page": False | <page_number>
}
Parameters:
- scheduled_mutesList of scheduled mutes returned by the search query.
- next_pageThe number of the next page. Set to False if there are no more pages.
Status Codes:
- 200 - OK.
- 400 - Invalid search query parameters.
GET /v2/schedules/<scheduled_mute_id>/
- Returns information on a single scheduled mute identified by <scheduled_mute_id>
.Curl example:
curl -X GET "https://[email protected]/v2/schedules/123-456-789/"
Obtain information on the scheduled mute identified by the ID
123-456-789
.Response format:
HTTP/1.1 200
Content-Type: application/json
{
"name": "name of scheduled mute",
"id": "scheduled mute ID",
"duration": 123,
"alerts" : ["alert_id1", "alert_id2", "alert_id3"],
"start_time": "20:20",
"timezone": "UTC+4",
"repeat": ["mon", "wed", "fri"]
}
Status Codes:
- 200 - OK.
- 404 - Scheduled mute doesn’t exist.
PUT /v2/schedules/<scheduled_mute_id>/
- Updates the attributes of a scheduled mute identified by <scheduled_mute_id>
.Curl example:
curl -H "Content-Type: application/json" -X PUT \
-d '{"start_time": "14:50", "timezone": "UTC+12"}' \
"https://[email protected]/v2/schedules/123-456-789/"
Updates the start time and timezone of the scheduled mute with the id
123-456-789.
Request format:
{
"name": "string",
"start_time": "14:20",
"duration": 123,
"timezone": "UTC-2",
"repeat": ["mon", "tue", "wed", "thu", "fri", "sat", "sun"]
}
Each field is optional and only the specified fields are updated.
Status Codes:
- 200 - OK.
- 400 - Invalid form data.
- 404 - Scheduled mute doesn’t exist.
- 409 - Scheduled mute with the updated name already exists.
DELETE /v2/schedules/<scheduled_mute_id>/
- Deletes a scheduled mute identified by <scheduled_mute_id>
.Curl example:
curl -X DELETE "https://[email protected]/v2/schedules/123-456-789/"
Delete the scheduled mute identified by the ID
123-456-789
.Status Codes:
- 200 - OK.
- 404 - Scheduled mute doesn’t exist.
Last modified 1mo ago