"
}
```
{% endtab %}
{% tab title="400" %}
Bad Request Invalid
{% endtab %}
{% tab title="409" %}
Conflict Already exists
{% endtab %}
{% endtabs %}
**Request format**:
```
{
"name": "string",
"start_time": "14:20",
"duration": 123,
"timezone": "UTC-2",
"repeat": ["mon", "tue", "wed", "thu", "fri", "sat", "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://YOUR-API-KEY@api.hostedgraphite.com/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.
***
### [Searching scheduled mutes](#searching-scheduled-mutes)
`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.
#### Path Parameters
| Name | Type | Description |
| ----------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name | String | Format: \&name=\\&name=\
The scheduled mute name to search for. Can specify multiple scheduled mute names to search for more than 1. Performs an OR operation so a query such as
\&name=\\&name=\
will return info on both scheduled\_mute\_name1 and scheduled\_mute\_name2.
|
| id | String | Format: \&id=\\&id=\
The scheduled mute ID to search for. Can specify multiple scheduled mute IDs to search for more than 1. Performs an OR operation so a query such as
\&name=\\&name=\
will return info on both scheduled\_mute\_id1 and scheduled\_mute\_id2.
|
| duration | String | Format: \&duration=\\&id=\
Searches for scheduled mutes by their duration. Can specify multiple durations to search for. Performs an OR 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\_time | String | Format: \&start\_time=\\&start\_time=\
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.
|
| timezone | String | Format: \&timezone=\\&timezone=\
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.
|
| repeat | String | Format: \&repeat=\\&repeat=\
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=thu
will return scheduled mutes that repeat on either Sunday or Thursday.
|
| page | String | Format: \&page=1
The page number to query. Used if there are more items that can be displayed in a single request (default: 1).
|
| max | String | Format: \&max=50
The maximum number of items to display. Limit of 100 (default: 100).
|
{% tabs %}
{% tab title="200" %}
```http
HTTP/1.1 200
Content-Type: application/json
```
```json
{
"scheduled_mutes": [
{
"name": "Maintenance Window",
"id": "mute_id_1",
"duration": 60,
"alerts": ["alert_id1", "alert_id2", "alert_id3"],
"start_time": "20:20",
"timezone": "UTC+4",
"repeat": ["mon", "wed", "fri"]
},
{
"name": "Holiday Quiet Hours",
"id": "mute_id_2",
"duration": 120,
"alerts": ["alert_id4", "alert_id5"],
"start_time": "18:00",
"timezone": "UTC+1",
"repeat": ["sat", "sun"]
}
],
"next_page": false
}
```
{% endtab %}
{% tab title="400" %}
Bad Request Invalid
{% endtab %}
{% endtabs %}
**Curl example:**
```bash
curl -X GET "https://YOUR-API-KEY@api.hostedgraphite.com/v2/schedules/?"
```
Specifying multiple fields performs an `OR` operation and returns scheduled mutes that match either criterion.
***
### [Obtain information on a single scheduled mute](#obtain-information-on-a-single-scheduled-mute)
`GET` `/v2/schedules//`
Returns information on a single scheduled mute identified by ``.
{% tabs %}
{% tab title="200" %}
```http
HTTP/1.1 200
Content-Type: application/json
```
```json
{
"name": "Maintenance Window",
"id": "mute_id_1",
"duration": 123,
"alerts": ["alert_id1", "alert_id2", "alert_id3"],
"start_time": "20:20",
"timezone": "UTC+4",
"repeat": ["mon", "wed", "fri"]
}
```
{% endtab %}
{% tab title="404" %}
Not Found Scheduled mute doesn’t exist.
{% endtab %}
{% endtabs %}
**Curl example:**
```
curl -X GET "https://YOUR-API-KEY@api.hostedgraphite.com/v2/schedules/123-456-789/"
```
Obtain information on the scheduled mute identified by the ID `123-456-789`.
***
### [Updating scheduled mutes](#updating-scheduled-mutes)
`PUT` `/v2/schedules//`
Updates the attributes of a scheduled mute identified by ``.
#### Path Parameters
| Name | Type | Description |
| ----------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name | String | A name that uniquely identifies this scheduled mute. |
| start\_time | String | A 24-hour time string at which the scheduled mute will begin |
| duration | String | Mute time in minutes. |
| timezone | String | The 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. |
| repeat | String | The 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”. |
{% tabs %}
{% tab title="200" %}
```json
{
"name": "string",
"start_time": "14:20",
"duration": 123,
"timezone": "UTC-2",
"repeat": [
"mon",
"tue",
"wed",
"thu",
"fri",
"sat",
"sun"
]
}
```
{% endtab %}
{% tab title="400" %}
Bad Request Invalid
{% endtab %}
{% tab title="404" %}
Not Found Scheduled mute doesn’t exist.
{% endtab %}
{% tab title="409" %}
Conflict Scheduled mute with the updated name already exists.
{% endtab %}
{% endtabs %}
**Curl example:**
```
curl -H "Content-Type: application/json" -X PUT \
-d '{"start_time": "14:50", "timezone": "UTC+12"}' \
"https://YOUR-API-KEY@api.hostedgraphite.com/v2/schedules/123-456-789/"
```
Updates the start time and timezone of the scheduled mute with the id `123-456-789.`
Each field is optional and only the specified fields are updated.
***
### [Deleting scheduled mutes](#deleting-scheduled-mutes)
`DELETE` `/v2/schedules//`
Deletes a scheduled mute identified by ``.
{% tabs %}
{% tab title="200 " %}
OK
{% endtab %}
{% tab title="404" %}
Not Found Scheduled mute doesn’t exist.
{% endtab %}
{% endtabs %}
**Curl example:**
```
curl -X DELETE "https://YOUR-API-KEY@api.hostedgraphite.com/v2/schedules/123-456-789/"
```
Delete the scheduled mute identified by the ID `123-456-789`.
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.hostedgraphite.com/alerting-guide/scheduled-mutes-api.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.