Skip to content

Restructure Synthetic Monitoring API doc #21629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 23 commits into
base: develop
Choose a base branch
from
Draft

Restructure Synthetic Monitoring API doc #21629

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
2a1ad38
Restructure Synthetic Monitoring API doc
PallaviWrite Sep 4, 2025
00e0ffe
Update nerdgraph-synthetics-tutorial.mdx
PallaviWrite Sep 30, 2025
e4c1378
Improve language clarity in NerdGraph synthetics tutorial
PallaviWrite Oct 13, 2025
1e92c12
Updated Manage your secure credentials section
PallaviWrite Oct 15, 2025
eb4e0da
updated manage monitor your downtimes section
PallaviWrite Oct 15, 2025
da3e77b
Update nerdgraph-synthetics-tutorial.mdx
PallaviWrite Nov 13, 2025
2b553ea
removed repetitive content
PallaviWrite Nov 18, 2025
ca71ded
wip
PallaviWrite Nov 18, 2025
eccd8c1
added all monitor types under synthetics api
PallaviWrite Nov 27, 2025
0a4c3a9
Added upgrade monitor run time
PallaviWrite Nov 27, 2025
ac39194
Added downgrade a scripted monitor
PallaviWrite Nov 27, 2025
a7be034
Added private locations and Downgrade a scripted API monitor's runtime
PallaviWrite Nov 27, 2025
e1ab2e9
Added secure credentials section
PallaviWrite Nov 27, 2025
0d60383
Added Monitor downtimes section
PallaviWrite Nov 27, 2025
86a6380
Added queries section
PallaviWrite Nov 28, 2025
d95e785
Updated get-started with overview
PallaviWrite Nov 28, 2025
664283d
Changed queries file to query-synthetics-data
PallaviWrite Nov 28, 2025
d65d5f4
Added left nav
PallaviWrite Nov 28, 2025
73e958b
Updated overview file
PallaviWrite Nov 28, 2025
c6bd21c
updated links for account id and guid for ping
PallaviWrite Nov 28, 2025
0aef163
Added account id and guid links
PallaviWrite Nov 28, 2025
da6f4a8
updated links for account id and guid
PallaviWrite Dec 1, 2025
fb0362e
updated links for private locations
PallaviWrite Dec 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
updated links for account id and guid
  • Loading branch information
@PallaviWrite
PallaviWrite committed Dec 1, 2025
commit da6f4a88d2faf2b46aaa31b9559fbf1a4085d045
4 changes: 2 additions & 2 deletions ...ntent/docs/apis/nerdgraph/examples/synthetics-api/certificate-check-monitor.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ You can create a certificate check monitor using the `syntheticsCreateCertCheckM
<td>`accountId`</td>
<td>Integer</td>
<td>Yes</td>
<td>Your New Relic account ID where the monitor will be created.</td>
<td>Your New Relic [account ID](/docs/accounts/accounts-billing/account-structure/account-id) where the monitor will be created.</td>
</tr>
<tr>
<td>`monitor.domain`</td>
Expand Down Expand Up @@ -138,7 +138,7 @@ You can update an existing certificate check monitor using the `syntheticsUpdate
<td>`guid`</td>
<td>String</td>
<td>Yes</td>
<td>The unique entity GUID of the monitor you want to update.</td>
<td>The unique entity [GUID](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-monitors) of the monitor you want to update.</td>
</tr>
<tr>
<td>`monitor.domain`</td>
Expand Down
170 changes: 12 additions & 158 deletions src/content/docs/apis/nerdgraph/examples/synthetics-api/monitor-downtimes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ metaDescription: How to use New Relic NerdGraph API to create and manage monitor
freshnessValidatedDate: never
---

Monitor downtimes let you schedule periods when your synthetic monitors stop running. This is useful during planned maintenance, deployments, or known outages when you don't want to receive alerts. You can create one-time downtimes or recurring schedules (daily, weekly, or monthly). This tutorial provides examples of how to use the NerdGraph API to programmatically manage monitor downtimes. To learn more about when you might schedule monitor downtimes, refer to [Disable monitoring during scheduled maintenance times](/docs/synthetics/synthetic-monitoring/using-monitors/monitor-downtimes-disable-monitoring-during-scheduled-maintenance-times/).
Monitor downtimes let you schedule periods when your synthetic monitors stop running. This is useful during planned maintenance, deployments, or known outages when you don't want to receive alerts. You can create one-time downtimes or recurring schedules (daily, weekly, or monthly). This tutorial provides examples of how to use the NerdGraph API to programmatically manage monitor downtimes. To manage monitor downtimes using the UI, refer to [Disable monitoring during scheduled maintenance times](/docs/synthetics/synthetic-monitoring/using-monitors/monitor-downtimes-disable-monitoring-during-scheduled-maintenance-times/).

<Callout variant="tip">
For timezone values, refer to the [tz database of time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, use `America/Los_Angeles` for Pacific Time.
Expand All @@ -35,7 +35,7 @@ You can create a one-time monitor downtime using the `syntheticsCreateOnceMonito
<td>`accountId`</td>
<td>Integer</td>
<td>Yes</td>
<td>The New Relic account ID where the downtime will be created.</td>
<td>The New Relic [account ID](/docs/accounts/accounts-billing/account-structure/account-id) where the downtime will be created.</td>
</tr>
<tr>
<td>`name`</td>
Expand All @@ -47,7 +47,7 @@ You can create a one-time monitor downtime using the `syntheticsCreateOnceMonito
<td>`monitorGuids`</td>
<td>Array</td>
<td>No</td>
<td>List of monitor GUIDs to include in the downtime. Leave empty to apply to all monitors.</td>
<td>List of monitor [GUIDs](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-monitors) to include in the downtime. Leave empty to apply to all monitors.</td>
</tr>
<tr>
<td>`timezone`</td>
Expand Down Expand Up @@ -93,26 +93,6 @@ mutation {
}
```

### Sample response

A successful response returns the created downtime details:

```json
{
"data": {
"syntheticsCreateOnceMonitorDowntime": {
"guid": "DOWNTIME_GUID",
"accountId": 123456,
"name": "MonitorDowntimeName",
"monitorGuids": ["OptionalMonitorEntityGuid", "OptionalMonitorEntityGuid"],
"timezone": "America/New_York",
"startTime": "2024-12-25T00:00:00",
"endTime": "2024-12-25T06:00:00"
}
}
}
```

## Create a daily recurring monitor downtime [#create-daily-downtime]

You can create a daily recurring monitor downtime using the `syntheticsCreateDailyMonitorDowntime` mutation. Use this for regular maintenance windows that occur every day.
Expand All @@ -133,7 +113,7 @@ You can create a daily recurring monitor downtime using the `syntheticsCreateDai
<td>`accountId`</td>
<td>Integer</td>
<td>Yes</td>
<td>The New Relic account ID where the downtime will be created.</td>
<td>The New Relic [account ID](/docs/accounts/accounts-billing/account-structure/account-id) where the downtime will be created.</td>
</tr>
<tr>
<td>`name`</td>
Expand All @@ -145,7 +125,7 @@ You can create a daily recurring monitor downtime using the `syntheticsCreateDai
<td>`monitorGuids`</td>
<td>Array</td>
<td>No</td>
<td>List of monitor GUIDs to include in the downtime.</td>
<td>List of monitor [GUIDs](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-monitors) to include in the downtime.</td>
</tr>
<tr>
<td>`timezone`</td>
Expand Down Expand Up @@ -205,30 +185,6 @@ mutation {
}
```

### Sample response

A successful response returns the created recurring downtime details:

```json
{
"data": {
"syntheticsCreateDailyMonitorDowntime": {
"guid": "DOWNTIME_GUID",
"accountId": 123456,
"name": "MonitorDowntimeName",
"monitorGuids": ["OptionalMonitorEntityGuid", "AnotherOptionalMonitorEntityGuid"],
"timezone": "America/New_York",
"startTime": "2024-01-01T02:00:00",
"endTime": "2024-01-01T04:00:00",
"endRepeat": {
"onDate": "2024-12-31T23:59:59",
"onRepeat": 10
}
}
}
}
```

## Create a weekly recurring monitor downtime [#create-weekly-downtime]

You can create a weekly recurring monitor downtime using the `syntheticsCreateWeeklyMonitorDowntime` mutation. Use this for maintenance windows that occur on specific days of the week.
Expand All @@ -249,7 +205,7 @@ You can create a weekly recurring monitor downtime using the `syntheticsCreateWe
<td>`accountId`</td>
<td>Integer</td>
<td>Yes</td>
<td>The New Relic account ID where the downtime will be created.</td>
<td>The New Relic [account ID](/docs/accounts/accounts-billing/account-structure/account-id) where the downtime will be created.</td>
</tr>
<tr>
<td>`name`</td>
Expand All @@ -261,7 +217,7 @@ You can create a weekly recurring monitor downtime using the `syntheticsCreateWe
<td>`monitorGuids`</td>
<td>Array</td>
<td>No</td>
<td>List of monitor GUIDs to include in the downtime.</td>
<td>List of monitor [GUIDs](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-monitors) to include in the downtime.</td>
</tr>
<tr>
<td>`timezone`</td>
Expand Down Expand Up @@ -329,31 +285,6 @@ mutation {
}
```

### Sample response

A successful response returns the created weekly downtime details:

```json
{
"data": {
"syntheticsCreateWeeklyMonitorDowntime": {
"guid": "DOWNTIME_GUID",
"accountId": 123456,
"name": "MonitorDowntimeName",
"monitorGuids": ["OptionalMonitorEntityGuid", "AnotherOptionalMonitorEntityGuid"],
"timezone": "America/New_York",
"startTime": "2024-01-01T02:00:00",
"endTime": "2024-01-01T04:00:00",
"maintenanceDays": ["MONDAY", "WEDNESDAY", "FRIDAY"],
"endRepeat": {
"onDate": "2024-12-31T23:59:59",
"onRepeat": 20
}
}
}
}
```

## Create a monthly recurring monitor downtime [#create-monthly-downtime]

You can create a monthly recurring monitor downtime using the `syntheticsCreateMonthlyMonitorDowntime` mutation. Use this for maintenance windows that occur on specific days each month.
Expand All @@ -374,7 +305,7 @@ You can create a monthly recurring monitor downtime using the `syntheticsCreateM
<td>`accountId`</td>
<td>Integer</td>
<td>Yes</td>
<td>The New Relic account ID where the downtime will be created.</td>
<td>The New Relic [account ID](/docs/accounts/accounts-billing/account-structure/account-id) where the downtime will be created.</td>
</tr>
<tr>
<td>`name`</td>
Expand All @@ -386,7 +317,7 @@ You can create a monthly recurring monitor downtime using the `syntheticsCreateM
<td>`monitorGuids`</td>
<td>Array</td>
<td>No</td>
<td>List of monitor GUIDs to include in the downtime.</td>
<td>List of monitor [GUIDs](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-monitors) to include in the downtime.</td>
</tr>
<tr>
<td>`timezone`</td>
Expand Down Expand Up @@ -466,37 +397,6 @@ mutation {
}
```

### Sample response

A successful response returns the created monthly downtime details:

```json
{
"data": {
"syntheticsCreateMonthlyMonitorDowntime": {
"guid": "DOWNTIME_GUID",
"accountId": 123456,
"name": "MonitorDowntimeName",
"monitorGuids": ["OptionalMonitorEntityGuid", "AnotherOptionalMonitorEntityGuid"],
"timezone": "America/New_York",
"startTime": "2024-01-01T02:00:00",
"endTime": "2024-01-01T04:00:00",
"frequency": {
"daysOfWeek": {
"weekDay": "MONDAY",
"ordinalDayOfMonth": "FIRST"
},
"daysOfMonth": [15]
},
"endRepeat": {
"onDate": "2024-12-31T23:59:59",
"onRepeat": 12
}
}
}
}
```

## Update a monitor downtime [#update-downtime]

You can update an existing monitor downtime using the `syntheticsEditMonitorDowntime` mutation. This allows you to modify any downtime type (once, daily, weekly, or monthly) using this single mutation.
Expand All @@ -517,7 +417,7 @@ You can update an existing monitor downtime using the `syntheticsEditMonitorDown
<td>`guid`</td>
<td>String</td>
<td>Yes</td>
<td>The GUID of the existing monitor downtime to update.</td>
<td>The [GUID](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-monitors) of the existing monitor downtime to update.</td>
</tr>
<tr>
<td>`name`</td>
Expand All @@ -529,7 +429,7 @@ You can update an existing monitor downtime using the `syntheticsEditMonitorDown
<td>`monitorGuids`</td>
<td>Array</td>
<td>No</td>
<td>Updated list of monitor GUIDs.</td>
<td>Updated list of monitor [GUIDs](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-monitors).</td>
</tr>
<tr>
<td>`once`</td>
Expand Down Expand Up @@ -630,38 +530,6 @@ mutation {
}
```

### Sample response

A successful response returns the updated downtime details:

```json
{
"data": {
"syntheticsEditMonitorDowntime": {
"guid": "MonitorDowntimeEntityGuid",
"accountId": 123456,
"name": "MONITOR_DOWNTIME_NAME",
"monitorGuids": ["OptionalMonitorEntityGuid", "AnotherOptionalMonitorEntityGuid"],
"timezone": "America/New_York",
"startTime": "2024-01-01T02:00:00",
"endTime": "2024-01-01T04:00:00",
"endRepeat": {
"onDate": "2024-12-31T23:59:59",
"onRepeat": 30
},
"maintenanceDays": ["MONDAY", "WEDNESDAY"],
"frequency": {
"daysOfWeek": {
"weekDay": "MONDAY",
"ordinalDayOfMonth": "FIRST"
},
"daysOfMonth": [15]
}
}
}
}
```

## Delete a monitor downtime [#delete-downtime]

You can delete a monitor downtime using the `syntheticsDeleteMonitorDowntime` mutation. Once deleted, the scheduled downtime will be removed and monitors will resume their normal schedule.
Expand All @@ -682,7 +550,7 @@ You can delete a monitor downtime using the `syntheticsDeleteMonitorDowntime` mu
<td>`guid`</td>
<td>String</td>
<td>Yes</td>
<td>The GUID of the monitor downtime to delete.</td>
<td>The [GUID](/docs/apis/nerdgraph/examples/synthetics-api/query-synthetics-data#query-monitor-downtimes) of the monitor downtime to delete.</td>
</tr>
</tbody>
</table>
Expand All @@ -698,17 +566,3 @@ mutation {
}
}
```

### Sample response

A successful response returns the GUID of the deleted downtime:

```json
{
"data": {
"syntheticsDeleteMonitorDowntime": {
"guid": "DOWNTIME_ENTITY_GUID"
}
}
}
```
8 changes: 4 additions & 4 deletions src/content/docs/apis/nerdgraph/examples/synthetics-api/private-locations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ You can create a private location using the `syntheticsCreatePrivateLocation` mu
<td>`accountId`</td>
<td>Integer</td>
<td>Yes</td>
<td>The account ID associated with the private location.</td>
<td>The [account ID](/docs/accounts/accounts-billing/account-structure/account-id) associated with the private location.</td>
</tr>
<tr>
<td>`description`</td>
Expand Down Expand Up @@ -121,7 +121,7 @@ You can update an existing private location using the `syntheticsUpdatePrivateLo
<td>`guid`</td>
<td>String</td>
<td>Yes</td>
<td>The unique entity GUID of the private location you want to update.</td>
<td>The unique entity [GUID](/docs/apis/nerdgraph/examples/nerdgraph-synthetics-tutorial/#private-examples) of the private location you want to update.</td>
</tr>
<tr>
<td>`description`</td>
Expand Down Expand Up @@ -206,7 +206,7 @@ You can clear the job queue for a private location using the `syntheticsPurgePri
<td>`guid`</td>
<td>String</td>
<td>Yes</td>
<td>The unique identifier (GUID) of the private location whose job queue you want to purge.</td>
<td>The [unique identifier (GUID)](/docs/apis/nerdgraph/examples/nerdgraph-synthetics-tutorial/#private-examples) of the private location whose job queue you want to purge.</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -266,7 +266,7 @@ When a private location is no longer needed, you can permanently remove it using
<td>`guid`</td>
<td>String</td>
<td>Yes</td>
<td>The unique entity GUID of the private location you want to delete.</td>
<td>The unique entity [GUID](/docs/apis/nerdgraph/examples/nerdgraph-synthetics-tutorial/#private-examples) of the private location you want to delete.</td>
</tr>
</tbody>
</table>
Expand Down
Loading
Loading