diff --git a/.github/reference-slug-map.json b/.github/reference-slug-map.json new file mode 100644 index 00000000..e5ec54dc --- /dev/null +++ b/.github/reference-slug-map.json @@ -0,0 +1,1458 @@ +[ + { + "oldSlug": "getv1accounts", + "method": "GET", + "path": "/v1/accounts", + "operationId": "getV1Accounts", + "summary": "Fetch user accounts", + "newPath": "api-reference/accounts/fetch-user-accounts" + }, + { + "oldSlug": "getv1accountsme", + "method": "GET", + "path": "/v1/accounts/me", + "operationId": "getV1AccountsMe", + "summary": "Fetch current account details", + "newPath": "api-reference/accounts/fetch-current-account-details" + }, + { + "oldSlug": "getv1accountsmeentitlements", + "method": "GET", + "path": "/v1/accounts/me/entitlements", + "operationId": "getV1AccountsMeEntitlements", + "summary": "Fetch current account entitlements", + "newPath": "api-reference/accounts/fetch-current-account-entitlements" + }, + { + "oldSlug": "getv1accountsmemembers", + "method": "GET", + "path": "/v1/accounts/me/members", + "operationId": "getV1AccountsMeMembers", + "summary": "List current account members and pending invites", + "newPath": "api-reference/accounts/list-current-account-members-and-pending-invites" + }, + { + "oldSlug": "deletev1accountsmemembersuserid", + "method": "DELETE", + "path": "/v1/accounts/me/members/{userId}", + "operationId": "deleteV1AccountsMeMembersUserid", + "summary": "Remove a current account member", + "newPath": "api-reference/accounts/remove-a-current-account-member" + }, + { + "oldSlug": "patchv1accountsmemembersuserid", + "method": "PATCH", + "path": "/v1/accounts/me/members/{userId}", + "operationId": "patchV1AccountsMeMembersUserid", + "summary": "Update a current account member role", + "newPath": "api-reference/accounts/update-a-current-account-member-role" + }, + { + "oldSlug": "getv1accountsaccountid", + "method": "GET", + "path": "/v1/accounts/{accountId}", + "operationId": "getV1AccountsAccountid", + "summary": "Fetch a given account details", + "newPath": "api-reference/accounts/fetch-a-given-account-details" + }, + { + "oldSlug": "getv1accountsaccountidentitlements", + "method": "GET", + "path": "/v1/accounts/{accountId}/entitlements", + "operationId": "getV1AccountsAccountidEntitlements", + "summary": "Fetch account entitlements", + "newPath": "api-reference/accounts/fetch-account-entitlements" + }, + { + "oldSlug": "getv1accountsaccountidmembers", + "method": "GET", + "path": "/v1/accounts/{accountId}/members", + "operationId": "getV1AccountsAccountidMembers", + "summary": "List account members and pending invites", + "newPath": "api-reference/accounts/list-account-members-and-pending-invites" + }, + { + "oldSlug": "deletev1accountsaccountidmembersuserid", + "method": "DELETE", + "path": "/v1/accounts/{accountId}/members/{userId}", + "operationId": "deleteV1AccountsAccountidMembersUserid", + "summary": "Remove an account member", + "newPath": "api-reference/accounts/remove-an-account-member" + }, + { + "oldSlug": "patchv1accountsaccountidmembersuserid", + "method": "PATCH", + "path": "/v1/accounts/{accountId}/members/{userId}", + "operationId": "patchV1AccountsAccountidMembersUserid", + "summary": "Update an account member role", + "newPath": "api-reference/accounts/update-an-account-member-role" + }, + { + "oldSlug": "getv1alertchannels", + "method": "GET", + "path": "/v1/alert-channels", + "operationId": "getV1Alertchannels", + "summary": "List all alert channels", + "newPath": "api-reference/alert-channels/list-all-alert-channels" + }, + { + "oldSlug": "postv1alertchannels", + "method": "POST", + "path": "/v1/alert-channels", + "operationId": "postV1Alertchannels", + "summary": "Create an alert channel", + "newPath": "api-reference/alert-channels/create-an-alert-channel" + }, + { + "oldSlug": "deletev1alertchannelsid", + "method": "DELETE", + "path": "/v1/alert-channels/{id}", + "operationId": "deleteV1AlertchannelsId", + "summary": "Delete an alert channel", + "newPath": "api-reference/alert-channels/delete-an-alert-channel" + }, + { + "oldSlug": "getv1alertchannelsid", + "method": "GET", + "path": "/v1/alert-channels/{id}", + "operationId": "getV1AlertchannelsId", + "summary": "Retrieve an alert channel", + "newPath": "api-reference/alert-channels/retrieve-an-alert-channel" + }, + { + "oldSlug": "putv1alertchannelsid", + "method": "PUT", + "path": "/v1/alert-channels/{id}", + "operationId": "putV1AlertchannelsId", + "summary": "Update an alert channel", + "newPath": "api-reference/alert-channels/update-an-alert-channel" + }, + { + "oldSlug": "putv1alertchannelsidsubscriptions", + "method": "PUT", + "path": "/v1/alert-channels/{id}/subscriptions", + "operationId": "putV1AlertchannelsIdSubscriptions", + "summary": "Update the subscriptions of an alert channel", + "newPath": "api-reference/alert-channels/update-the-subscriptions-of-an-alert-channel" + }, + { + "oldSlug": "getv1alertnotifications", + "method": "GET", + "path": "/v1/alert-notifications", + "operationId": "getV1Alertnotifications", + "summary": "Lists all alert notifications", + "newPath": "api-reference/alert-notifications/lists-all-alert-notifications" + }, + { + "oldSlug": "getv1analyticsapichecksid", + "method": "GET", + "path": "/v1/analytics/api-checks/{id}", + "operationId": "getV1AnalyticsApichecksId", + "summary": "API checks", + "newPath": "api-reference/analytics/api-checks" + }, + { + "oldSlug": "getv1analyticsbrowserchecksid", + "method": "GET", + "path": "/v1/analytics/browser-checks/{id}", + "operationId": "getV1AnalyticsBrowserchecksId", + "summary": "Browser checks", + "newPath": "api-reference/analytics/browser-checks" + }, + { + "oldSlug": "postv1analyticschecks", + "method": "POST", + "path": "/v1/analytics/checks", + "operationId": "postV1AnalyticsChecks", + "summary": "Get analytics summary for multiple checks", + "newPath": "api-reference/analytics/get-analytics-summary-for-multiple-checks" + }, + { + "oldSlug": "getv1analyticsdnsid", + "method": "GET", + "path": "/v1/analytics/dns/{id}", + "operationId": "getV1AnalyticsDnsId", + "summary": "DNS monitors", + "newPath": "api-reference/analytics/dns-monitors" + }, + { + "oldSlug": "getv1analyticsheartbeatchecksid", + "method": "GET", + "path": "/v1/analytics/heartbeat-checks/{id}", + "operationId": "getV1AnalyticsHeartbeatchecksId", + "summary": "Heartbeat checks", + "newPath": "api-reference/analytics/heartbeat-checks" + }, + { + "oldSlug": "getv1analyticsicmpid", + "method": "GET", + "path": "/v1/analytics/icmp/{id}", + "operationId": "getV1AnalyticsIcmpId", + "summary": "ICMP monitors", + "newPath": "api-reference/analytics/icmp-monitors" + }, + { + "oldSlug": "getv1analyticsmetrics", + "method": "GET", + "path": "/v1/analytics/metrics", + "operationId": "getV1AnalyticsMetrics", + "summary": "List all available reporting metrics.", + "newPath": "api-reference/analytics/list-all-available-reporting-metrics" + }, + { + "oldSlug": "getv1analyticsmultistepchecksid", + "method": "GET", + "path": "/v1/analytics/multistep-checks/{id}", + "operationId": "getV1AnalyticsMultistepchecksId", + "summary": "Multistep checks", + "newPath": "api-reference/analytics/multistep-checks" + }, + { + "oldSlug": "getv1analyticsplaywrightchecksid", + "method": "GET", + "path": "/v1/analytics/playwright-checks/{id}", + "operationId": "getV1AnalyticsPlaywrightchecksId", + "summary": "Playwright checks", + "newPath": "api-reference/analytics/playwright-checks" + }, + { + "oldSlug": "getv1analyticstcpchecksid", + "method": "GET", + "path": "/v1/analytics/tcp-checks/{id}", + "operationId": "getV1AnalyticsTcpchecksId", + "summary": "TCP checks", + "newPath": "api-reference/analytics/tcp-checks" + }, + { + "oldSlug": "getv1analyticsurlmonitorsid", + "method": "GET", + "path": "/v1/analytics/url-monitors/{id}", + "operationId": "getV1AnalyticsUrlmonitorsId", + "summary": "URL Monitors", + "newPath": "api-reference/analytics/url-monitors" + }, + { + "oldSlug": "getv1badgescheckscheckid", + "method": "GET", + "path": "/v1/badges/checks/{checkId}", + "operationId": "getV1BadgesChecksCheckid", + "summary": "", + "newPath": "api-reference/badges/get-v1badgeschecks" + }, + { + "oldSlug": "getv1badgesgroupsgroupid", + "method": "GET", + "path": "/v1/badges/groups/{groupId}", + "operationId": "getV1BadgesGroupsGroupid", + "summary": "", + "newPath": "api-reference/badges/get-v1badgesgroups" + }, + { + "oldSlug": "getv1checkalerts", + "method": "GET", + "path": "/v1/check-alerts", + "operationId": "getV1Checkalerts", + "summary": "List all alerts for your account", + "newPath": "api-reference/check-alerts/list-all-alerts-for-your-account" + }, + { + "oldSlug": "getv1checkalertscheckid", + "method": "GET", + "path": "/v1/check-alerts/{checkId}", + "operationId": "getV1CheckalertsCheckid", + "summary": "List alerts for a specific check", + "newPath": "api-reference/check-alerts/list-alerts-for-a-specific-check" + }, + { + "oldSlug": "getv1checkgroups", + "method": "GET", + "path": "/v1/check-groups", + "operationId": "getV1Checkgroups", + "summary": "List all check groups", + "newPath": "api-reference/check-groups/list-all-check-groups" + }, + { + "oldSlug": "postv1checkgroups", + "method": "POST", + "path": "/v1/check-groups", + "operationId": "postV1Checkgroups", + "summary": "Create a check group", + "newPath": "api-reference/check-groups/create-a-check-group" + }, + { + "oldSlug": "getv1checkgroupsgroupidcheckscheckid", + "method": "GET", + "path": "/v1/check-groups/{groupId}/checks/{checkId}", + "operationId": "getV1CheckgroupsGroupidChecksCheckid", + "summary": "Retrieve one check in a specific group with group settings applied", + "newPath": "api-reference/check-groups/retrieve-one-check-in-a-specific-group-with-group-settings-applied" + }, + { + "oldSlug": "deletev1checkgroupsid", + "method": "DELETE", + "path": "/v1/check-groups/{id}", + "operationId": "deleteV1CheckgroupsId", + "summary": "Delete a check group.", + "newPath": "api-reference/check-groups/delete-a-check-group" + }, + { + "oldSlug": "getv1checkgroupsid", + "method": "GET", + "path": "/v1/check-groups/{id}", + "operationId": "getV1CheckgroupsId", + "summary": "Retrieve a check group", + "newPath": "api-reference/check-groups/retrieve-a-check-group" + }, + { + "oldSlug": "putv1checkgroupsid", + "method": "PUT", + "path": "/v1/check-groups/{id}", + "operationId": "putV1CheckgroupsId", + "summary": "Update a check group", + "newPath": "api-reference/check-groups/update-a-check-group" + }, + { + "oldSlug": "getv1checkgroupsidchecks", + "method": "GET", + "path": "/v1/check-groups/{id}/checks", + "operationId": "getV1CheckgroupsIdChecks", + "summary": "Retrieve all checks in a specific group with group settings applied", + "newPath": "api-reference/check-groups/retrieve-all-checks-in-a-specific-group-with-group-settings-applied" + }, + { + "oldSlug": "getv1checkresultscheckid", + "method": "GET", + "path": "/v1/check-results/{checkId}", + "operationId": "getV1CheckresultsCheckid", + "summary": "Lists all check results", + "newPath": "api-reference/check-results/lists-all-check-results" + }, + { + "oldSlug": "getv1checkresultscheckidcheckresultid", + "method": "GET", + "path": "/v1/check-results/{checkId}/{checkResultId}", + "operationId": "getV1CheckresultsCheckidCheckresultid", + "summary": "Retrieve a check result", + "newPath": "api-reference/check-results/retrieve-a-check-result" + }, + { + "oldSlug": "getv1checkresultscheckidcheckresultidassets", + "method": "GET", + "path": "/v1/check-results/{checkId}/{checkResultId}/assets", + "operationId": "getV1CheckresultsCheckidCheckresultidAssets", + "summary": "Retrieve a normalized asset manifest for a check result", + "newPath": "api-reference/check-results/retrieve-a-normalized-asset-manifest-for-a-check-result" + }, + { + "oldSlug": "postv1checksessionstrigger", + "method": "POST", + "path": "/v1/check-sessions/trigger", + "operationId": "postV1ChecksessionsTrigger", + "summary": "Trigger a new check session", + "newPath": "api-reference/check-sessions/trigger-a-new-check-session" + }, + { + "oldSlug": "getv1checksessionschecksessionid", + "method": "GET", + "path": "/v1/check-sessions/{checkSessionId}", + "operationId": "getV1ChecksessionsChecksessionid", + "summary": "Retrieve a check session", + "newPath": "api-reference/check-sessions/retrieve-a-check-session" + }, + { + "oldSlug": "postv1checksessionschecksessionidcancel", + "method": "POST", + "path": "/v1/check-sessions/{checkSessionId}/cancel", + "operationId": "postV1ChecksessionsChecksessionidCancel", + "summary": "Cancel a check session", + "newPath": "api-reference/check-sessions/cancel-a-check-session" + }, + { + "oldSlug": "getv1checksessionschecksessionidcompletion", + "method": "GET", + "path": "/v1/check-sessions/{checkSessionId}/completion", + "operationId": "getV1ChecksessionsChecksessionidCompletion", + "summary": "Await the completion of a check session", + "newPath": "api-reference/check-sessions/await-the-completion-of-a-check-session" + }, + { + "oldSlug": "getv1checkstatuses", + "method": "GET", + "path": "/v1/check-statuses", + "operationId": "getV1Checkstatuses", + "summary": "List all check statuses", + "newPath": "api-reference/check-status/list-all-check-statuses" + }, + { + "oldSlug": "getv1checkstatusescheckid", + "method": "GET", + "path": "/v1/check-statuses/{checkId}", + "operationId": "getV1CheckstatusesCheckid", + "summary": "Retrieve check status details", + "newPath": "api-reference/check-status/retrieve-check-status-details" + }, + { + "oldSlug": "getv1checks", + "method": "GET", + "path": "/v1/checks", + "operationId": "getV1Checks", + "summary": "List all checks", + "newPath": "api-reference/checks/list-all-checks" + }, + { + "oldSlug": "postv1checks", + "method": "POST", + "path": "/v1/checks", + "operationId": "postV1Checks", + "summary": "Create a check", + "newPath": "api-reference/checks/create-a-check" + }, + { + "oldSlug": "postv1checksapi", + "method": "POST", + "path": "/v1/checks/api", + "operationId": "postV1ChecksApi", + "summary": "Create an API check", + "newPath": "api-reference/checks/create-an-api-check" + }, + { + "oldSlug": "putv1checksapiid", + "method": "PUT", + "path": "/v1/checks/api/{id}", + "operationId": "putV1ChecksApiId", + "summary": "Update an API check", + "newPath": "api-reference/checks/update-an-api-check" + }, + { + "oldSlug": "postv1checksbrowser", + "method": "POST", + "path": "/v1/checks/browser", + "operationId": "postV1ChecksBrowser", + "summary": "Create a browser check", + "newPath": "api-reference/checks/create-a-browser-check" + }, + { + "oldSlug": "putv1checksbrowserid", + "method": "PUT", + "path": "/v1/checks/browser/{id}", + "operationId": "putV1ChecksBrowserId", + "summary": "Update a browser check", + "newPath": "api-reference/checks/update-a-browser-check" + }, + { + "oldSlug": "postv1checksdns", + "method": "POST", + "path": "/v1/checks/dns", + "operationId": "postV1ChecksDns", + "summary": "Create an DNS monitor", + "newPath": "api-reference/monitors/create-a-dns-monitor" + }, + { + "oldSlug": "putv1checksdnsid", + "method": "PUT", + "path": "/v1/checks/dns/{id}", + "operationId": "putV1ChecksDnsId", + "summary": "Update an DNS Monitor", + "newPath": "api-reference/monitors/update-a-dns-monitor" + }, + { + "oldSlug": "postv1checksheartbeat", + "method": "POST", + "path": "/v1/checks/heartbeat", + "operationId": "postV1ChecksHeartbeat", + "summary": "Create a heartbeat check", + "newPath": "api-reference/heartbeats/create-a-heartbeat-check" + }, + { + "oldSlug": "putv1checksheartbeatid", + "method": "PUT", + "path": "/v1/checks/heartbeat/{id}", + "operationId": "putV1ChecksHeartbeatId", + "summary": "Update a heartbeat check", + "newPath": "api-reference/heartbeats/update-a-heartbeat-check" + }, + { + "oldSlug": "getv1checksheartbeatscheckidavailability", + "method": "GET", + "path": "/v1/checks/heartbeats/{checkId}/availability", + "operationId": "getV1ChecksHeartbeatsCheckidAvailability", + "summary": "Get heartbeat availability", + "newPath": "api-reference/heartbeats/get-heartbeat-availability" + }, + { + "oldSlug": "getv1checksheartbeatscheckidevents", + "method": "GET", + "path": "/v1/checks/heartbeats/{checkId}/events", + "operationId": "getV1ChecksHeartbeatsCheckidEvents", + "summary": "Get a list of events for a heartbeat", + "newPath": "api-reference/heartbeats/get-a-list-of-events-for-a-heartbeat" + }, + { + "oldSlug": "getv1checksheartbeatscheckideventsid", + "method": "GET", + "path": "/v1/checks/heartbeats/{checkId}/events/{id}", + "operationId": "getV1ChecksHeartbeatsCheckidEventsId", + "summary": "Get a specific Heartbeat event", + "newPath": "api-reference/heartbeats/get-a-specific-heartbeat-event" + }, + { + "oldSlug": "postv1checksicmp", + "method": "POST", + "path": "/v1/checks/icmp", + "operationId": "postV1ChecksIcmp", + "summary": "Create an ICMP monitor", + "newPath": "api-reference/monitors/create-an-icmp-monitor" + }, + { + "oldSlug": "putv1checksicmpid", + "method": "PUT", + "path": "/v1/checks/icmp/{id}", + "operationId": "putV1ChecksIcmpId", + "summary": "Update an ICMP Monitor", + "newPath": "api-reference/monitors/update-an-icmp-monitor" + }, + { + "oldSlug": "postv1checksmultistep", + "method": "POST", + "path": "/v1/checks/multistep", + "operationId": "postV1ChecksMultistep", + "summary": "Create a multi-step check", + "newPath": "api-reference/checks/create-a-multi-step-check" + }, + { + "oldSlug": "putv1checksmultistepid", + "method": "PUT", + "path": "/v1/checks/multistep/{id}", + "operationId": "putV1ChecksMultistepId", + "summary": "Update a multi-step check", + "newPath": "api-reference/checks/update-a-multi-step-check" + }, + { + "oldSlug": "postv1checkstcp", + "method": "POST", + "path": "/v1/checks/tcp", + "operationId": "postV1ChecksTcp", + "summary": "Create a TCP check", + "newPath": "api-reference/checks/create-a-tcp-check" + }, + { + "oldSlug": "putv1checkstcpid", + "method": "PUT", + "path": "/v1/checks/tcp/{id}", + "operationId": "putV1ChecksTcpId", + "summary": "Update an TCP check", + "newPath": "api-reference/checks/update-an-tcp-check" + }, + { + "oldSlug": "postv1checksurl", + "method": "POST", + "path": "/v1/checks/url", + "operationId": "postV1ChecksUrl", + "summary": "Create a URL monitor", + "newPath": "api-reference/monitors/create-a-url-monitor" + }, + { + "oldSlug": "putv1checksurlid", + "method": "PUT", + "path": "/v1/checks/url/{id}", + "operationId": "putV1ChecksUrlId", + "summary": "Update an URL Monitor", + "newPath": "api-reference/monitors/update-an-url-monitor" + }, + { + "oldSlug": "deletev1checksid", + "method": "DELETE", + "path": "/v1/checks/{id}", + "operationId": "deleteV1ChecksId", + "summary": "Delete a check", + "newPath": "api-reference/checks/delete-a-check" + }, + { + "oldSlug": "getv1checksid", + "method": "GET", + "path": "/v1/checks/{id}", + "operationId": "getV1ChecksId", + "summary": "Retrieve a check", + "newPath": "api-reference/checks/retrieve-a-check" + }, + { + "oldSlug": "putv1checksid", + "method": "PUT", + "path": "/v1/checks/{id}", + "operationId": "putV1ChecksId", + "summary": "Update a check", + "newPath": "api-reference/checks/update-a-check" + }, + { + "oldSlug": "getv1clientcertificates", + "method": "GET", + "path": "/v1/client-certificates", + "operationId": "getV1Clientcertificates", + "summary": "Lists all client certificates.", + "newPath": "api-reference/client-certificates/lists-all-client-certificates" + }, + { + "oldSlug": "postv1clientcertificates", + "method": "POST", + "path": "/v1/client-certificates", + "operationId": "postV1Clientcertificates", + "summary": "Creates a new client certificate.", + "newPath": "api-reference/client-certificates/creates-a-new-client-certificate" + }, + { + "oldSlug": "deletev1clientcertificatesid", + "method": "DELETE", + "path": "/v1/client-certificates/{id}", + "operationId": "deleteV1ClientcertificatesId", + "summary": "Deletes a client certificate.", + "newPath": "api-reference/client-certificates/deletes-a-client-certificate" + }, + { + "oldSlug": "getv1clientcertificatesid", + "method": "GET", + "path": "/v1/client-certificates/{id}", + "operationId": "getV1ClientcertificatesId", + "summary": "Shows one client certificate.", + "newPath": "api-reference/client-certificates/shows-one-client-certificate" + }, + { + "oldSlug": "getv1dashboards", + "method": "GET", + "path": "/v1/dashboards", + "operationId": "getV1Dashboards", + "summary": "List all dashboards", + "newPath": "api-reference/dashboards/list-all-dashboards" + }, + { + "oldSlug": "postv1dashboards", + "method": "POST", + "path": "/v1/dashboards", + "operationId": "postV1Dashboards", + "summary": "Create a dashboard", + "newPath": "api-reference/dashboards/create-a-dashboard" + }, + { + "oldSlug": "deletev1dashboardsdashboardid", + "method": "DELETE", + "path": "/v1/dashboards/{dashboardId}", + "operationId": "deleteV1DashboardsDashboardid", + "summary": "Delete a dashboard", + "newPath": "api-reference/dashboards/delete-a-dashboard" + }, + { + "oldSlug": "getv1dashboardsdashboardid", + "method": "GET", + "path": "/v1/dashboards/{dashboardId}", + "operationId": "getV1DashboardsDashboardid", + "summary": "Retrieve a dashboard", + "newPath": "api-reference/dashboards/retrieve-a-dashboard" + }, + { + "oldSlug": "putv1dashboardsdashboardid", + "method": "PUT", + "path": "/v1/dashboards/{dashboardId}", + "operationId": "putV1DashboardsDashboardid", + "summary": "Update a dashboard", + "newPath": "api-reference/dashboards/update-a-dashboard" + }, + { + "oldSlug": "getv1errorgroups", + "method": "GET", + "path": "/v1/error-groups", + "operationId": "getV1Errorgroups", + "summary": "List all error groups in your account.", + "newPath": "api-reference/error-groups/list-all-error-groups" + }, + { + "oldSlug": "getv1errorgroupscheckscheckid", + "method": "GET", + "path": "/v1/error-groups/checks/{checkId}", + "operationId": "getV1ErrorgroupsChecksCheckid", + "summary": "List all error groups for a specific check.", + "newPath": "api-reference/error-groups/list-all-error-groups-for-a-specific-check" + }, + { + "oldSlug": "getv1errorgroupsid", + "method": "GET", + "path": "/v1/error-groups/{id}", + "operationId": "getV1ErrorgroupsId", + "summary": "Retrieve one error group.", + "newPath": "api-reference/error-groups/retrieve-an-error-group" + }, + { + "oldSlug": "patchv1errorgroupsid", + "method": "PATCH", + "path": "/v1/error-groups/{id}", + "operationId": "patchV1ErrorgroupsId", + "summary": "Update an error group. Mainly used for archiving error groups.", + "newPath": "api-reference/error-groups/update-an-error-group" + }, + { + "oldSlug": "postv1incidents", + "method": "POST", + "path": "/v1/incidents", + "operationId": "postV1Incidents", + "summary": "Create an incident", + "newPath": "api-reference/incidents/create-an-incident" + }, + { + "oldSlug": "deletev1incidentsid", + "method": "DELETE", + "path": "/v1/incidents/{id}", + "operationId": "deleteV1IncidentsId", + "summary": "Delete an incident", + "newPath": "api-reference/incidents/delete-an-incident" + }, + { + "oldSlug": "getv1incidentsid", + "method": "GET", + "path": "/v1/incidents/{id}", + "operationId": "getV1IncidentsId", + "summary": "Retrieve an incident", + "newPath": "api-reference/incidents/retrieve-an-incident" + }, + { + "oldSlug": "putv1incidentsid", + "method": "PUT", + "path": "/v1/incidents/{id}", + "operationId": "putV1IncidentsId", + "summary": "Update an incident", + "newPath": "api-reference/incidents/update-an-incident" + }, + { + "oldSlug": "postv1incidentsincidentidupdates", + "method": "POST", + "path": "/v1/incidents/{incidentId}/updates", + "operationId": "postV1IncidentsIncidentidUpdates", + "summary": "Create an incident update", + "newPath": "api-reference/incident-updates/create-an-incident-update" + }, + { + "oldSlug": "deletev1incidentsincidentidupdatesid", + "method": "DELETE", + "path": "/v1/incidents/{incidentId}/updates/{id}", + "operationId": "deleteV1IncidentsIncidentidUpdatesId", + "summary": "Delete an incident update", + "newPath": "api-reference/incident-updates/delete-an-incident-update" + }, + { + "oldSlug": "putv1incidentsincidentidupdatesid", + "method": "PUT", + "path": "/v1/incidents/{incidentId}/updates/{id}", + "operationId": "putV1IncidentsIncidentidUpdatesId", + "summary": "Update an incident update", + "newPath": "api-reference/incident-updates/update-an-incident-update" + }, + { + "oldSlug": "getv1locations", + "method": "GET", + "path": "/v1/locations", + "operationId": "getV1Locations", + "summary": "Lists all supported locations", + "newPath": "api-reference/location/lists-all-supported-locations" + }, + { + "oldSlug": "getv1maintenancewindows", + "method": "GET", + "path": "/v1/maintenance-windows", + "operationId": "getV1Maintenancewindows", + "summary": "List all maintenance windows", + "newPath": "api-reference/maintenance-windows/list-all-maintenance-windows" + }, + { + "oldSlug": "postv1maintenancewindows", + "method": "POST", + "path": "/v1/maintenance-windows", + "operationId": "postV1Maintenancewindows", + "summary": "Create a maintenance window", + "newPath": "api-reference/maintenance-windows/create-a-maintenance-window" + }, + { + "oldSlug": "deletev1maintenancewindowsid", + "method": "DELETE", + "path": "/v1/maintenance-windows/{id}", + "operationId": "deleteV1MaintenancewindowsId", + "summary": "Delete a maintenance window", + "newPath": "api-reference/maintenance-windows/delete-a-maintenance-window" + }, + { + "oldSlug": "getv1maintenancewindowsid", + "method": "GET", + "path": "/v1/maintenance-windows/{id}", + "operationId": "getV1MaintenancewindowsId", + "summary": "Retrieve a maintenance window", + "newPath": "api-reference/maintenance-windows/retrieve-a-maintenance-window" + }, + { + "oldSlug": "putv1maintenancewindowsid", + "method": "PUT", + "path": "/v1/maintenance-windows/{id}", + "operationId": "putV1MaintenancewindowsId", + "summary": "Update a maintenance window", + "newPath": "api-reference/maintenance-windows/update-a-maintenance-window" + }, + { + "oldSlug": "getv1maintenancewindowsidmaintenances", + "method": "GET", + "path": "/v1/maintenance-windows/{id}/maintenances", + "operationId": "getV1MaintenancewindowsIdMaintenances", + "summary": "List maintenances for a maintenance window", + "newPath": "api-reference/maintenance-windows/list-maintenances-for-a-maintenance-window" + }, + { + "oldSlug": "deletev1maintenancewindowsidmaintenancesmaintenanceid", + "method": "DELETE", + "path": "/v1/maintenance-windows/{id}/maintenances/{maintenanceId}", + "operationId": "deleteV1MaintenancewindowsIdMaintenancesMaintenanceid", + "summary": "Delete a maintenance", + "newPath": "api-reference/maintenance-windows/delete-a-maintenance" + }, + { + "oldSlug": "getv1maintenancewindowsidmaintenancesmaintenanceid", + "method": "GET", + "path": "/v1/maintenance-windows/{id}/maintenances/{maintenanceId}", + "operationId": "getV1MaintenancewindowsIdMaintenancesMaintenanceid", + "summary": "Retrieve a maintenance", + "newPath": "api-reference/maintenance-windows/retrieve-a-maintenance" + }, + { + "oldSlug": "patchv1maintenancewindowsidmaintenancesmaintenanceid", + "method": "PATCH", + "path": "/v1/maintenance-windows/{id}/maintenances/{maintenanceId}", + "operationId": "patchV1MaintenancewindowsIdMaintenancesMaintenanceid", + "summary": "Update maintenance dates", + "newPath": "api-reference/maintenance-windows/update-maintenance-dates" + }, + { + "oldSlug": "postv1maintenancewindowsidmaintenancesmaintenanceidupdates", + "method": "POST", + "path": "/v1/maintenance-windows/{id}/maintenances/{maintenanceId}/updates", + "operationId": "postV1MaintenancewindowsIdMaintenancesMaintenanceidUpdates", + "summary": "Create a maintenance window status update", + "newPath": "api-reference/maintenance-windows/create-a-maintenance-window-status-update" + }, + { + "oldSlug": "deletev1maintenancewindowsidmaintenancesmaintenanceidupdatesupdateid", + "method": "DELETE", + "path": "/v1/maintenance-windows/{id}/maintenances/{maintenanceId}/updates/{updateId}", + "operationId": "deleteV1MaintenancewindowsIdMaintenancesMaintenanceidUpdatesUpdateid", + "summary": "Delete a maintenance window status update", + "newPath": "api-reference/maintenance-windows/delete-a-maintenance-window-status-update" + }, + { + "oldSlug": "putv1maintenancewindowsidmaintenancesmaintenanceidupdatesupdateid", + "method": "PUT", + "path": "/v1/maintenance-windows/{id}/maintenances/{maintenanceId}/updates/{updateId}", + "operationId": "putV1MaintenancewindowsIdMaintenancesMaintenanceidUpdatesUpdateid", + "summary": "Update a maintenance window status update", + "newPath": "api-reference/maintenance-windows/update-a-maintenance-window-status-update" + }, + { + "oldSlug": "getv1privatelocations", + "method": "GET", + "path": "/v1/private-locations", + "operationId": "getV1Privatelocations", + "summary": "List all private locations", + "newPath": "api-reference/private-locations/list-all-private-locations" + }, + { + "oldSlug": "postv1privatelocations", + "method": "POST", + "path": "/v1/private-locations", + "operationId": "postV1Privatelocations", + "summary": "Create a private location", + "newPath": "api-reference/private-locations/create-a-private-location" + }, + { + "oldSlug": "deletev1privatelocationsid", + "method": "DELETE", + "path": "/v1/private-locations/{id}", + "operationId": "deleteV1PrivatelocationsId", + "summary": "Remove a private location", + "newPath": "api-reference/private-locations/remove-a-private-location" + }, + { + "oldSlug": "getv1privatelocationsid", + "method": "GET", + "path": "/v1/private-locations/{id}", + "operationId": "getV1PrivatelocationsId", + "summary": "Retrieve a private location", + "newPath": "api-reference/private-locations/retrieve-a-private-location" + }, + { + "oldSlug": "putv1privatelocationsid", + "method": "PUT", + "path": "/v1/private-locations/{id}", + "operationId": "putV1PrivatelocationsId", + "summary": "Update a private location", + "newPath": "api-reference/private-locations/update-a-private-location" + }, + { + "oldSlug": "postv1privatelocationsidkeys", + "method": "POST", + "path": "/v1/private-locations/{id}/keys", + "operationId": "postV1PrivatelocationsIdKeys", + "summary": "Generate a new API Key for a private location", + "newPath": "api-reference/private-locations/generate-a-new-api-key-for-a-private-location" + }, + { + "oldSlug": "deletev1privatelocationsidkeyskeyid", + "method": "DELETE", + "path": "/v1/private-locations/{id}/keys/{keyId}", + "operationId": "deleteV1PrivatelocationsIdKeysKeyid", + "summary": "Remove an existing API key for a private location", + "newPath": "api-reference/private-locations/remove-an-existing-api-key-for-a-private-location" + }, + { + "oldSlug": "getv1privatelocationsidmetrics", + "method": "GET", + "path": "/v1/private-locations/{id}/metrics", + "operationId": "getV1PrivatelocationsIdMetrics", + "summary": "Get private location health metrics from a window of time.", + "newPath": "api-reference/private-locations/get-private-location-health-metrics-from-a-window-of-time" + }, + { + "oldSlug": "getv1reporting", + "method": "GET", + "path": "/v1/reporting", + "operationId": "getV1Reporting", + "summary": "Generates a report with aggregate statistics for checks and check groups.", + "newPath": "api-reference/reporting/generates-a-report-with-aggregate-statistics-for-checks-and-check-groups" + }, + { + "oldSlug": "postv1rootcauseanalyseserrorgroupserrorgroupid", + "method": "POST", + "path": "/v1/root-cause-analyses/error-groups/{errorGroupId}", + "operationId": "postV1RootcauseanalysesErrorgroupsErrorgroupid", + "summary": "Generate a Root Cause Analysis for a check error group", + "newPath": "api-reference/rocky-ai/generate-a-root-cause-analysis-for-an-error-group" + }, + { + "oldSlug": "postv1rootcauseanalysestestsessionerrorgroupstestsessionerrorgroupid", + "method": "POST", + "path": "/v1/root-cause-analyses/test-session-error-groups/{testSessionErrorGroupId}", + "operationId": "postV1RootcauseanalysesTestsessionerrorgroupsTestsessionerrorgroupid", + "summary": "Generate a Root Cause Analysis for a test session error group", + "newPath": "api-reference/rocky-ai/generate-a-root-cause-analysis-for-a-test-session-error-group" + }, + { + "oldSlug": "getv1rootcauseanalysesid", + "method": "GET", + "path": "/v1/root-cause-analyses/{id}", + "operationId": "getV1RootcauseanalysesId", + "summary": "Retrieve a Root Cause Analysis", + "newPath": "api-reference/rocky-ai/retrieve-one-root-cause-analysis" + }, + { + "oldSlug": "getv1runtimes", + "method": "GET", + "path": "/v1/runtimes", + "operationId": "getV1Runtimes", + "summary": "Lists all supported runtimes", + "newPath": "api-reference/runtimes/lists-all-supported-runtimes" + }, + { + "oldSlug": "getv1runtimesid", + "method": "GET", + "path": "/v1/runtimes/{id}", + "operationId": "getV1RuntimesId", + "summary": "Shows details for one specific runtime", + "newPath": "api-reference/runtimes/shows-details-for-one-specific-runtime" + }, + { + "oldSlug": "getv1snippets", + "method": "GET", + "path": "/v1/snippets", + "operationId": "getV1Snippets", + "summary": "List all snippets", + "newPath": "api-reference/snippets/list-all-snippets" + }, + { + "oldSlug": "postv1snippets", + "method": "POST", + "path": "/v1/snippets", + "operationId": "postV1Snippets", + "summary": "Create a snippet", + "newPath": "api-reference/snippets/create-a-snippet" + }, + { + "oldSlug": "deletev1snippetsid", + "method": "DELETE", + "path": "/v1/snippets/{id}", + "operationId": "deleteV1SnippetsId", + "summary": "Delete a snippet", + "newPath": "api-reference/snippets/delete-a-snippet" + }, + { + "oldSlug": "getv1snippetsid", + "method": "GET", + "path": "/v1/snippets/{id}", + "operationId": "getV1SnippetsId", + "summary": "Retrieve a snippet", + "newPath": "api-reference/snippets/retrieve-a-snippet" + }, + { + "oldSlug": "putv1snippetsid", + "method": "PUT", + "path": "/v1/snippets/{id}", + "operationId": "putV1SnippetsId", + "summary": "Update a snippet", + "newPath": "api-reference/snippets/update-a-snippet" + }, + { + "oldSlug": "getv1staticips", + "method": "GET", + "path": "/v1/static-ips", + "operationId": "getV1Staticips", + "summary": "Lists all source IPs for check runs", + "newPath": "api-reference/static-ips/lists-all-source-ips-for-check-runs" + }, + { + "oldSlug": "getv1staticipsbyregion", + "method": "GET", + "path": "/v1/static-ips-by-region", + "operationId": "getV1Staticipsbyregion", + "summary": "Lists all source IPs for check runs", + "newPath": "api-reference/static-ips/lists-all-source-ips-for-check-runs-1" + }, + { + "oldSlug": "getv1staticipstxt", + "method": "GET", + "path": "/v1/static-ips.txt", + "operationId": "getV1Staticipstxt", + "summary": "Lists all source IPs for check runs as txt file", + "newPath": "api-reference/static-ips/lists-all-source-ips-for-check-runs-as-txt-file" + }, + { + "oldSlug": "getv1staticipv6s", + "method": "GET", + "path": "/v1/static-ipv6s", + "operationId": "getV1Staticipv6s", + "summary": "Lists all source IPv6s for check runs", + "newPath": "api-reference/static-ips/lists-all-source-ipv6s-for-check-runs" + }, + { + "oldSlug": "getv1staticipv6sbyregion", + "method": "GET", + "path": "/v1/static-ipv6s-by-region", + "operationId": "getV1Staticipv6sbyregion", + "summary": "Lists all source IPv6s for check runs", + "newPath": "api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-1" + }, + { + "oldSlug": "getv1staticipv6stxt", + "method": "GET", + "path": "/v1/static-ipv6s.txt", + "operationId": "getV1Staticipv6stxt", + "summary": "Lists all source IPv6s for check runs as a txt file", + "newPath": "api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-as-a-txt-file" + }, + { + "oldSlug": "getv1statuspages", + "method": "GET", + "path": "/v1/status-pages", + "operationId": "getV1Statuspages", + "summary": "Retrieve all status pages.", + "newPath": "api-reference/status-pages/retrieve-all-status-pages" + }, + { + "oldSlug": "postv1statuspages", + "method": "POST", + "path": "/v1/status-pages", + "operationId": "postV1Statuspages", + "summary": "Create a new status page.", + "newPath": "api-reference/status-pages/create-a-new-status-page" + }, + { + "oldSlug": "getv1statuspagesincidents", + "method": "GET", + "path": "/v1/status-pages/incidents", + "operationId": "getV1StatuspagesIncidents", + "summary": "Retrieve the latest incidents with pagination.", + "newPath": "api-reference/status-page-incidents/retrieve-the-latest-incidents-with-pagination" + }, + { + "oldSlug": "postv1statuspagesincidents", + "method": "POST", + "path": "/v1/status-pages/incidents", + "operationId": "postV1StatuspagesIncidents", + "summary": "Create a new incident.", + "newPath": "api-reference/status-page-incidents/create-a-new-incident" + }, + { + "oldSlug": "deletev1statuspagesincidentsincidentid", + "method": "DELETE", + "path": "/v1/status-pages/incidents/{incidentId}", + "operationId": "deleteV1StatuspagesIncidentsIncidentid", + "summary": "Delete an incident.", + "newPath": "api-reference/status-page-incidents/delete-an-incident" + }, + { + "oldSlug": "getv1statuspagesincidentsincidentid", + "method": "GET", + "path": "/v1/status-pages/incidents/{incidentId}", + "operationId": "getV1StatuspagesIncidentsIncidentid", + "summary": "Retrieve an incident by id.", + "newPath": "api-reference/status-page-incidents/retrieve-an-incident-by-id" + }, + { + "oldSlug": "putv1statuspagesincidentsincidentid", + "method": "PUT", + "path": "/v1/status-pages/incidents/{incidentId}", + "operationId": "putV1StatuspagesIncidentsIncidentid", + "summary": "Update an existing incident.", + "newPath": "api-reference/status-page-incidents/update-an-existing-incident" + }, + { + "oldSlug": "getv1statuspagesincidentsincidentidincidentupdates", + "method": "GET", + "path": "/v1/status-pages/incidents/{incidentId}/incident-updates", + "operationId": "getV1StatuspagesIncidentsIncidentidIncidentupdates", + "summary": "Retrieve the 100 latest incident updates of a specific incident.", + "newPath": "api-reference/status-page-incidents/retrieve-the-100-latest-incident-updates-of-a-specific-incident" + }, + { + "oldSlug": "postv1statuspagesincidentsincidentidincidentupdates", + "method": "POST", + "path": "/v1/status-pages/incidents/{incidentId}/incident-updates", + "operationId": "postV1StatuspagesIncidentsIncidentidIncidentupdates", + "summary": "Add a new incident update to a specific incident.", + "newPath": "api-reference/status-page-incidents/add-a-new-incident-update-to-a-specific-incident" + }, + { + "oldSlug": "deletev1statuspagesincidentsincidentidincidentupdatesincidentupdateid", + "method": "DELETE", + "path": "/v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}", + "operationId": "deleteV1StatuspagesIncidentsIncidentidIncidentupdatesIncidentupdateid", + "summary": "Delete an incident update.", + "newPath": "api-reference/status-page-incidents/delete-an-incident-update" + }, + { + "oldSlug": "getv1statuspagesincidentsincidentidincidentupdatesincidentupdateid", + "method": "GET", + "path": "/v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}", + "operationId": "getV1StatuspagesIncidentsIncidentidIncidentupdatesIncidentupdateid", + "summary": "Retrieve an incident update by id.", + "newPath": "api-reference/status-page-incidents/retrieve-an-incident-update-by-id" + }, + { + "oldSlug": "putv1statuspagesincidentsincidentidincidentupdatesincidentupdateid", + "method": "PUT", + "path": "/v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}", + "operationId": "putV1StatuspagesIncidentsIncidentidIncidentupdatesIncidentupdateid", + "summary": "Update an existing incident update.", + "newPath": "api-reference/status-page-incidents/update-an-existing-incident-update" + }, + { + "oldSlug": "getv1statuspagesservices", + "method": "GET", + "path": "/v1/status-pages/services", + "operationId": "getV1StatuspagesServices", + "summary": "Get all services", + "newPath": "api-reference/status-page-services/get-all-services" + }, + { + "oldSlug": "postv1statuspagesservices", + "method": "POST", + "path": "/v1/status-pages/services", + "operationId": "postV1StatuspagesServices", + "summary": "Create a service", + "newPath": "api-reference/status-page-services/create-a-service" + }, + { + "oldSlug": "deletev1statuspagesservicesserviceid", + "method": "DELETE", + "path": "/v1/status-pages/services/{serviceId}", + "operationId": "deleteV1StatuspagesServicesServiceid", + "summary": "Delete a service", + "newPath": "api-reference/status-page-services/delete-a-service" + }, + { + "oldSlug": "getv1statuspagesservicesserviceid", + "method": "GET", + "path": "/v1/status-pages/services/{serviceId}", + "operationId": "getV1StatuspagesServicesServiceid", + "summary": "Get a single service", + "newPath": "api-reference/status-page-services/get-a-single-service" + }, + { + "oldSlug": "putv1statuspagesservicesserviceid", + "method": "PUT", + "path": "/v1/status-pages/services/{serviceId}", + "operationId": "putV1StatuspagesServicesServiceid", + "summary": "Update a service", + "newPath": "api-reference/status-page-services/update-a-service" + }, + { + "oldSlug": "deletev1statuspagesstatuspageid", + "method": "DELETE", + "path": "/v1/status-pages/{statusPageId}", + "operationId": "deleteV1StatuspagesStatuspageid", + "summary": "Delete a status page.", + "newPath": "api-reference/status-pages/delete-a-status-page" + }, + { + "oldSlug": "getv1statuspagesstatuspageid", + "method": "GET", + "path": "/v1/status-pages/{statusPageId}", + "operationId": "getV1StatuspagesStatuspageid", + "summary": "Retrieve a single status page by id.", + "newPath": "api-reference/status-pages/retrieve-a-single-status-page-by-id" + }, + { + "oldSlug": "putv1statuspagesstatuspageid", + "method": "PUT", + "path": "/v1/status-pages/{statusPageId}", + "operationId": "putV1StatuspagesStatuspageid", + "summary": "Update an existing status page.", + "newPath": "api-reference/status-pages/update-an-existing-status-page" + }, + { + "oldSlug": "getv1statuspagesstatuspageidsubscriptions", + "method": "GET", + "path": "/v1/status-pages/{statusPageId}/subscriptions", + "operationId": "getV1StatuspagesStatuspageidSubscriptions", + "summary": "Get all subscriptions for a specific status page", + "newPath": "api-reference/status-pages/get-all-subscriptions-for-a-specific-status-page" + }, + { + "oldSlug": "postv1statuspagesstatuspageidsubscriptionsbulk", + "method": "POST", + "path": "/v1/status-pages/{statusPageId}/subscriptions/bulk", + "operationId": "postV1StatuspagesStatuspageidSubscriptionsBulk", + "summary": "Bulk create subscriptions for a specific status page", + "newPath": "api-reference/status-pages/bulk-create-subscriptions-for-a-specific-status-page" + }, + { + "oldSlug": "deletev1statuspagesstatuspageidsubscriptionssubscriptionid", + "method": "DELETE", + "path": "/v1/status-pages/{statusPageId}/subscriptions/{subscriptionId}", + "operationId": "deleteV1StatuspagesStatuspageidSubscriptionsSubscriptionid", + "summary": "Delete a subscription belonging to a specific status page", + "newPath": "api-reference/status-pages/delete-a-subscription-belonging-to-a-specific-status-page" + }, + { + "oldSlug": "getv1testsessionerrorgroups", + "method": "GET", + "path": "/v1/test-session-error-groups", + "operationId": "getV1Testsessionerrorgroups", + "summary": "List all test session error groups in your account.", + "newPath": "api-reference/test-session-error-groups/list-all-test-session-error-groups" + }, + { + "oldSlug": "getv1testsessionerrorgroupsprojectsprojectid", + "method": "GET", + "path": "/v1/test-session-error-groups/projects/{projectId}", + "operationId": "getV1TestsessionerrorgroupsProjectsProjectid", + "summary": "List all test session error groups for a specific project.", + "newPath": "api-reference/test-session-error-groups/list-all-test-session-error-groups-for-a-project" + }, + { + "oldSlug": "getv1testsessionerrorgroupsid", + "method": "GET", + "path": "/v1/test-session-error-groups/{id}", + "operationId": "getV1TestsessionerrorgroupsId", + "summary": "Retrieve one test session error group.", + "newPath": "api-reference/test-session-error-groups/retrieve-a-test-session-error-group" + }, + { + "oldSlug": "patchv1testsessionerrorgroupsid", + "method": "PATCH", + "path": "/v1/test-session-error-groups/{id}", + "operationId": "patchV1TestsessionerrorgroupsId", + "summary": "Update a test session error group. Mainly used for archiving test session error groups.", + "newPath": "api-reference/test-session-error-groups/update-a-test-session-error-group" + }, + { + "oldSlug": "getv1testsessions", + "method": "GET", + "path": "/v1/test-sessions", + "operationId": "getV1Testsessions", + "summary": "List test sessions", + "newPath": "api-reference/test-sessions/list-test-sessions" + }, + { + "oldSlug": "postv1testsessionstrigger", + "method": "POST", + "path": "/v1/test-sessions/trigger", + "operationId": "postV1TestsessionsTrigger", + "summary": "Trigger a new test session", + "newPath": "api-reference/test-sessions/trigger-a-new-test-session" + }, + { + "oldSlug": "getv1testsessionstestsessionid", + "method": "GET", + "path": "/v1/test-sessions/{testSessionId}", + "operationId": "getV1TestsessionsTestsessionid", + "summary": "Retrieve a test session", + "newPath": "api-reference/test-sessions/retrieve-a-test-session" + }, + { + "oldSlug": "postv1testsessionstestsessionidcancel", + "method": "POST", + "path": "/v1/test-sessions/{testSessionId}/cancel", + "operationId": "postV1TestsessionsTestsessionidCancel", + "summary": "Cancel a test session", + "newPath": "api-reference/test-sessions/cancel-a-test-session" + }, + { + "oldSlug": "getv1testsessionstestsessionidcompletion", + "method": "GET", + "path": "/v1/test-sessions/{testSessionId}/completion", + "operationId": "getV1TestsessionsTestsessionidCompletion", + "summary": "Await the completion of a test session", + "newPath": "api-reference/test-sessions/await-the-completion-of-a-test-session" + }, + { + "oldSlug": "getv1testsessionstestsessionidresultstestsessionresultid", + "method": "GET", + "path": "/v1/test-sessions/{testSessionId}/results/{testSessionResultId}", + "operationId": "getV1TestsessionsTestsessionidResultsTestsessionresultid", + "summary": "Retrieve a test session result", + "newPath": "api-reference/test-sessions/retrieve-a-test-session-result" + }, + { + "oldSlug": "getv1testsessionstestsessionidresultstestsessionresultidassets", + "method": "GET", + "path": "/v1/test-sessions/{testSessionId}/results/{testSessionResultId}/assets", + "operationId": "getV1TestsessionsTestsessionidResultsTestsessionresultidAssets", + "summary": "Retrieve a normalized asset manifest for a test-session result", + "newPath": "api-reference/test-sessions/retrieve-a-normalized-asset-manifest-for-a-test-session-result" + }, + { + "oldSlug": "deletev1triggerscheckgroupsgroupid", + "method": "DELETE", + "path": "/v1/triggers/check-groups/{groupId}", + "operationId": "deleteV1TriggersCheckgroupsGroupid", + "summary": "Delete the check group trigger", + "newPath": "api-reference/triggers/delete-the-check-group-trigger" + }, + { + "oldSlug": "getv1triggerscheckgroupsgroupid", + "method": "GET", + "path": "/v1/triggers/check-groups/{groupId}", + "operationId": "getV1TriggersCheckgroupsGroupid", + "summary": "Get the check group trigger", + "newPath": "api-reference/triggers/get-the-check-group-trigger" + }, + { + "oldSlug": "postv1triggerscheckgroupsgroupid", + "method": "POST", + "path": "/v1/triggers/check-groups/{groupId}", + "operationId": "postV1TriggersCheckgroupsGroupid", + "summary": "Create the check group trigger", + "newPath": "api-reference/triggers/create-the-check-group-trigger" + }, + { + "oldSlug": "deletev1triggerscheckscheckid", + "method": "DELETE", + "path": "/v1/triggers/checks/{checkId}", + "operationId": "deleteV1TriggersChecksCheckid", + "summary": "Delete the check trigger", + "newPath": "api-reference/triggers/delete-the-check-trigger" + }, + { + "oldSlug": "getv1triggerscheckscheckid", + "method": "GET", + "path": "/v1/triggers/checks/{checkId}", + "operationId": "getV1TriggersChecksCheckid", + "summary": "Get the check trigger", + "newPath": "api-reference/triggers/get-the-check-trigger" + }, + { + "oldSlug": "postv1triggerscheckscheckid", + "method": "POST", + "path": "/v1/triggers/checks/{checkId}", + "operationId": "postV1TriggersChecksCheckid", + "summary": "Create the check trigger", + "newPath": "api-reference/triggers/create-the-check-trigger" + }, + { + "oldSlug": "getv1variables", + "method": "GET", + "path": "/v1/variables", + "operationId": "getV1Variables", + "summary": "List all environment variables", + "newPath": "api-reference/environment-variables/list-all-environment-variables" + }, + { + "oldSlug": "postv1variables", + "method": "POST", + "path": "/v1/variables", + "operationId": "postV1Variables", + "summary": "Create an environment variable", + "newPath": "api-reference/environment-variables/create-an-environment-variable" + }, + { + "oldSlug": "deletev1variableskey", + "method": "DELETE", + "path": "/v1/variables/{key}", + "operationId": "deleteV1VariablesKey", + "summary": "Delete an environment variable", + "newPath": "api-reference/environment-variables/delete-an-environment-variable" + }, + { + "oldSlug": "getv1variableskey", + "method": "GET", + "path": "/v1/variables/{key}", + "operationId": "getV1VariablesKey", + "summary": "Retrieve an environment variable", + "newPath": "api-reference/environment-variables/retrieve-an-environment-variable" + }, + { + "oldSlug": "putv1variableskey", + "method": "PUT", + "path": "/v1/variables/{key}", + "operationId": "putV1VariablesKey", + "summary": "Update an environment variable", + "newPath": "api-reference/environment-variables/update-an-environment-variable" + }, + { + "oldSlug": "postv2checkgroups", + "method": "POST", + "path": "/v2/check-groups", + "operationId": "postV2Checkgroups", + "summary": "Create a check group (V2)", + "newPath": "api-reference/check-groups/create-a-check-group-v2" + }, + { + "oldSlug": "putv2checkgroupsid", + "method": "PUT", + "path": "/v2/check-groups/{id}", + "operationId": "putV2CheckgroupsId", + "summary": "Update a check group (V2)", + "newPath": "api-reference/check-groups/update-a-check-group-v2" + }, + { + "oldSlug": "getv2checkresultscheckid", + "method": "GET", + "path": "/v2/check-results/{checkId}", + "operationId": "getV2CheckresultsCheckid", + "summary": "Lists all check results", + "newPath": "api-reference/check-results/lists-all-check-results-1" + }, + { + "oldSlug": "postv2checksessionstrigger", + "method": "POST", + "path": "/v2/check-sessions/trigger", + "operationId": "postV2ChecksessionsTrigger", + "summary": "Trigger a new check session", + "newPath": "api-reference/check-sessions/trigger-a-new-check-session-v2" + }, + { + "oldSlug": "getv2checksessionschecksessionid", + "method": "GET", + "path": "/v2/check-sessions/{checkSessionId}", + "operationId": "getV2ChecksessionsChecksessionid", + "summary": "Retrieve a check session", + "newPath": "api-reference/check-sessions/retrieve-a-check-session-v2" + }, + { + "oldSlug": "getv2checksessionschecksessionidcompletion", + "method": "GET", + "path": "/v2/check-sessions/{checkSessionId}/completion", + "operationId": "getV2ChecksessionsChecksessionidCompletion", + "summary": "Await the completion of a check session", + "newPath": "api-reference/check-sessions/await-the-completion-of-a-check-session-v2" + } +] \ No newline at end of file diff --git a/.github/scripts/check_redirect_destinations.py b/.github/scripts/check_redirect_destinations.py new file mode 100644 index 00000000..fe23967c --- /dev/null +++ b/.github/scripts/check_redirect_destinations.py @@ -0,0 +1,38 @@ +#!/usr/bin/env python3 +"""Verify every legacy /reference/* redirect in docs.json points at an on-disk page. + +These redirects (generated from .github/reference-slug-map.json, the frozen +ReadMe-era slug set) are inbound-only: no docs page links to /reference/*, so +`mint broken-links` never walks them and a page rename/delete would dead-end +their destinations silently. This check closes that gap. It must run on any +PR that touches .mdx files or docs.json — a rename PR is exactly the event +it exists to catch. +""" +import json +import pathlib +import sys + +root = pathlib.Path(__file__).resolve().parents[2] +docs = json.loads((root / "docs.json").read_text()) + +pages = { + "/" + str(p.relative_to(root))[: -len(".mdx")] + for p in root.rglob("*.mdx") + if "node_modules" not in p.parts +} + +broken = [] +for redirect in docs.get("redirects", []): + if not redirect["source"].startswith("/reference/"): + continue + destination = redirect["destination"].split("#")[0] + if destination not in pages: + broken.append(f"{redirect['source']} -> {redirect['destination']}") + +if broken: + print(f"{len(broken)} /reference/* redirect destination(s) have no matching .mdx page:") + print("\n".join(broken)) + sys.exit(1) + +checked = sum(1 for r in docs.get("redirects", []) if r["source"].startswith("/reference/")) +print(f"OK: {checked} /reference/* redirect destinations all resolve to on-disk pages") diff --git a/.github/workflows/static-docs-checks.yml b/.github/workflows/static-docs-checks.yml index a8aadfe8..a1e492f4 100644 --- a/.github/workflows/static-docs-checks.yml +++ b/.github/workflows/static-docs-checks.yml @@ -68,6 +68,13 @@ jobs: if: steps.detect.outputs.openapi_changed == 'true' run: npx mint openapi-check api-reference/openapi.json + # Legacy /reference/* redirects are inbound-only, so `mint broken-links` + # never validates their destinations. Runs on any docs change (.mdx or + # docs.json) because a page rename/delete is exactly what breaks them. + - name: Check legacy redirect destinations + if: steps.detect.outputs.docs_changed == 'true' + run: python3 .github/scripts/check_redirect_destinations.py + - name: Broken-links scan if: steps.detect.outputs.docs_changed == 'true' run: | diff --git a/API-DOCUMENTATION.md b/API-DOCUMENTATION.md index 5ad8c46d..50342801 100644 --- a/API-DOCUMENTATION.md +++ b/API-DOCUMENTATION.md @@ -65,3 +65,11 @@ title: API checks If you need to update your local copy of the OpenAPI spec, run `./update-api-spec.sh` That's it! Your new endpoint should be showing properly now. + +## Legacy `/reference/*` redirects + +The pre-Mintlify API reference lived on ReadMe.io at `developers.checklyhq.com/reference/`, where `` was the lowercased OpenAPI `operationId` (e.g. `getv1checks`). To keep those old deep links alive, `docs.json` carries redirects generated from `.github/reference-slug-map.json` — a **frozen** snapshot of the ReadMe-era slug set. Don't regenerate it from a newer spec: endpoints added after the ReadMe era never had `/reference/` URLs. + +* One explicit redirect per historical slug maps to its endpoint page, so old bookmarks deep-link correctly. +* A trailing catch-all `/reference/:slug*` → `/api-reference/overview` backstops slugs whose endpoints were removed after the ReadMe era. Mintlify resolves exact sources before wildcards, so the catch-all never shadows the explicit entries. **If you ever add a real docs page under `/reference/`, this catch-all will intercept it — narrow or remove it first.** +* `mint broken-links` does **not** validate these destinations (nothing links to `/reference/*` in page content), so `.github/scripts/check_redirect_destinations.py` runs in the static-docs-checks workflow on every docs PR and fails if a page rename/delete breaks any of them. diff --git a/docs.json b/docs.json index cb2985e2..efbb2a62 100644 --- a/docs.json +++ b/docs.json @@ -1426,6 +1426,742 @@ { "source": "/assertions", "destination": "/detect/assertions" + }, + { + "source": "/reference/getv1accounts", + "destination": "/api-reference/accounts/fetch-user-accounts" + }, + { + "source": "/reference/getv1accountsme", + "destination": "/api-reference/accounts/fetch-current-account-details" + }, + { + "source": "/reference/getv1accountsmeentitlements", + "destination": "/api-reference/accounts/fetch-current-account-entitlements" + }, + { + "source": "/reference/getv1accountsmemembers", + "destination": "/api-reference/accounts/list-current-account-members-and-pending-invites" + }, + { + "source": "/reference/deletev1accountsmemembersuserid", + "destination": "/api-reference/accounts/remove-a-current-account-member" + }, + { + "source": "/reference/patchv1accountsmemembersuserid", + "destination": "/api-reference/accounts/update-a-current-account-member-role" + }, + { + "source": "/reference/getv1accountsaccountid", + "destination": "/api-reference/accounts/fetch-a-given-account-details" + }, + { + "source": "/reference/getv1accountsaccountidentitlements", + "destination": "/api-reference/accounts/fetch-account-entitlements" + }, + { + "source": "/reference/getv1accountsaccountidmembers", + "destination": "/api-reference/accounts/list-account-members-and-pending-invites" + }, + { + "source": "/reference/deletev1accountsaccountidmembersuserid", + "destination": "/api-reference/accounts/remove-an-account-member" + }, + { + "source": "/reference/patchv1accountsaccountidmembersuserid", + "destination": "/api-reference/accounts/update-an-account-member-role" + }, + { + "source": "/reference/getv1alertchannels", + "destination": "/api-reference/alert-channels/list-all-alert-channels" + }, + { + "source": "/reference/postv1alertchannels", + "destination": "/api-reference/alert-channels/create-an-alert-channel" + }, + { + "source": "/reference/deletev1alertchannelsid", + "destination": "/api-reference/alert-channels/delete-an-alert-channel" + }, + { + "source": "/reference/getv1alertchannelsid", + "destination": "/api-reference/alert-channels/retrieve-an-alert-channel" + }, + { + "source": "/reference/putv1alertchannelsid", + "destination": "/api-reference/alert-channels/update-an-alert-channel" + }, + { + "source": "/reference/putv1alertchannelsidsubscriptions", + "destination": "/api-reference/alert-channels/update-the-subscriptions-of-an-alert-channel" + }, + { + "source": "/reference/getv1alertnotifications", + "destination": "/api-reference/alert-notifications/lists-all-alert-notifications" + }, + { + "source": "/reference/getv1analyticsapichecksid", + "destination": "/api-reference/analytics/api-checks" + }, + { + "source": "/reference/getv1analyticsbrowserchecksid", + "destination": "/api-reference/analytics/browser-checks" + }, + { + "source": "/reference/postv1analyticschecks", + "destination": "/api-reference/analytics/get-analytics-summary-for-multiple-checks" + }, + { + "source": "/reference/getv1analyticsdnsid", + "destination": "/api-reference/analytics/dns-monitors" + }, + { + "source": "/reference/getv1analyticsheartbeatchecksid", + "destination": "/api-reference/analytics/heartbeat-checks" + }, + { + "source": "/reference/getv1analyticsicmpid", + "destination": "/api-reference/analytics/icmp-monitors" + }, + { + "source": "/reference/getv1analyticsmetrics", + "destination": "/api-reference/analytics/list-all-available-reporting-metrics" + }, + { + "source": "/reference/getv1analyticsmultistepchecksid", + "destination": "/api-reference/analytics/multistep-checks" + }, + { + "source": "/reference/getv1analyticsplaywrightchecksid", + "destination": "/api-reference/analytics/playwright-checks" + }, + { + "source": "/reference/getv1analyticstcpchecksid", + "destination": "/api-reference/analytics/tcp-checks" + }, + { + "source": "/reference/getv1analyticsurlmonitorsid", + "destination": "/api-reference/analytics/url-monitors" + }, + { + "source": "/reference/getv1badgescheckscheckid", + "destination": "/api-reference/badges/get-v1badgeschecks" + }, + { + "source": "/reference/getv1badgesgroupsgroupid", + "destination": "/api-reference/badges/get-v1badgesgroups" + }, + { + "source": "/reference/getv1checkalerts", + "destination": "/api-reference/check-alerts/list-all-alerts-for-your-account" + }, + { + "source": "/reference/getv1checkalertscheckid", + "destination": "/api-reference/check-alerts/list-alerts-for-a-specific-check" + }, + { + "source": "/reference/getv1checkgroups", + "destination": "/api-reference/check-groups/list-all-check-groups" + }, + { + "source": "/reference/postv1checkgroups", + "destination": "/api-reference/check-groups/create-a-check-group" + }, + { + "source": "/reference/getv1checkgroupsgroupidcheckscheckid", + "destination": "/api-reference/check-groups/retrieve-one-check-in-a-specific-group-with-group-settings-applied" + }, + { + "source": "/reference/deletev1checkgroupsid", + "destination": "/api-reference/check-groups/delete-a-check-group" + }, + { + "source": "/reference/getv1checkgroupsid", + "destination": "/api-reference/check-groups/retrieve-a-check-group" + }, + { + "source": "/reference/putv1checkgroupsid", + "destination": "/api-reference/check-groups/update-a-check-group" + }, + { + "source": "/reference/getv1checkgroupsidchecks", + "destination": "/api-reference/check-groups/retrieve-all-checks-in-a-specific-group-with-group-settings-applied" + }, + { + "source": "/reference/getv1checkresultscheckid", + "destination": "/api-reference/check-results/lists-all-check-results" + }, + { + "source": "/reference/getv1checkresultscheckidcheckresultid", + "destination": "/api-reference/check-results/retrieve-a-check-result" + }, + { + "source": "/reference/getv1checkresultscheckidcheckresultidassets", + "destination": "/api-reference/check-results/retrieve-a-normalized-asset-manifest-for-a-check-result" + }, + { + "source": "/reference/postv1checksessionstrigger", + "destination": "/api-reference/check-sessions/trigger-a-new-check-session" + }, + { + "source": "/reference/getv1checksessionschecksessionid", + "destination": "/api-reference/check-sessions/retrieve-a-check-session" + }, + { + "source": "/reference/postv1checksessionschecksessionidcancel", + "destination": "/api-reference/check-sessions/cancel-a-check-session" + }, + { + "source": "/reference/getv1checksessionschecksessionidcompletion", + "destination": "/api-reference/check-sessions/await-the-completion-of-a-check-session" + }, + { + "source": "/reference/getv1checkstatuses", + "destination": "/api-reference/check-status/list-all-check-statuses" + }, + { + "source": "/reference/getv1checkstatusescheckid", + "destination": "/api-reference/check-status/retrieve-check-status-details" + }, + { + "source": "/reference/getv1checks", + "destination": "/api-reference/checks/list-all-checks" + }, + { + "source": "/reference/postv1checks", + "destination": "/api-reference/checks/create-a-check" + }, + { + "source": "/reference/postv1checksapi", + "destination": "/api-reference/checks/create-an-api-check" + }, + { + "source": "/reference/putv1checksapiid", + "destination": "/api-reference/checks/update-an-api-check" + }, + { + "source": "/reference/postv1checksbrowser", + "destination": "/api-reference/checks/create-a-browser-check" + }, + { + "source": "/reference/putv1checksbrowserid", + "destination": "/api-reference/checks/update-a-browser-check" + }, + { + "source": "/reference/postv1checksdns", + "destination": "/api-reference/monitors/create-a-dns-monitor" + }, + { + "source": "/reference/putv1checksdnsid", + "destination": "/api-reference/monitors/update-a-dns-monitor" + }, + { + "source": "/reference/postv1checksheartbeat", + "destination": "/api-reference/heartbeats/create-a-heartbeat-check" + }, + { + "source": "/reference/putv1checksheartbeatid", + "destination": "/api-reference/heartbeats/update-a-heartbeat-check" + }, + { + "source": "/reference/getv1checksheartbeatscheckidavailability", + "destination": "/api-reference/heartbeats/get-heartbeat-availability" + }, + { + "source": "/reference/getv1checksheartbeatscheckidevents", + "destination": "/api-reference/heartbeats/get-a-list-of-events-for-a-heartbeat" + }, + { + "source": "/reference/getv1checksheartbeatscheckideventsid", + "destination": "/api-reference/heartbeats/get-a-specific-heartbeat-event" + }, + { + "source": "/reference/postv1checksicmp", + "destination": "/api-reference/monitors/create-an-icmp-monitor" + }, + { + "source": "/reference/putv1checksicmpid", + "destination": "/api-reference/monitors/update-an-icmp-monitor" + }, + { + "source": "/reference/postv1checksmultistep", + "destination": "/api-reference/checks/create-a-multi-step-check" + }, + { + "source": "/reference/putv1checksmultistepid", + "destination": "/api-reference/checks/update-a-multi-step-check" + }, + { + "source": "/reference/postv1checkstcp", + "destination": "/api-reference/checks/create-a-tcp-check" + }, + { + "source": "/reference/putv1checkstcpid", + "destination": "/api-reference/checks/update-an-tcp-check" + }, + { + "source": "/reference/postv1checksurl", + "destination": "/api-reference/monitors/create-a-url-monitor" + }, + { + "source": "/reference/putv1checksurlid", + "destination": "/api-reference/monitors/update-an-url-monitor" + }, + { + "source": "/reference/deletev1checksid", + "destination": "/api-reference/checks/delete-a-check" + }, + { + "source": "/reference/getv1checksid", + "destination": "/api-reference/checks/retrieve-a-check" + }, + { + "source": "/reference/putv1checksid", + "destination": "/api-reference/checks/update-a-check" + }, + { + "source": "/reference/getv1clientcertificates", + "destination": "/api-reference/client-certificates/lists-all-client-certificates" + }, + { + "source": "/reference/postv1clientcertificates", + "destination": "/api-reference/client-certificates/creates-a-new-client-certificate" + }, + { + "source": "/reference/deletev1clientcertificatesid", + "destination": "/api-reference/client-certificates/deletes-a-client-certificate" + }, + { + "source": "/reference/getv1clientcertificatesid", + "destination": "/api-reference/client-certificates/shows-one-client-certificate" + }, + { + "source": "/reference/getv1dashboards", + "destination": "/api-reference/dashboards/list-all-dashboards" + }, + { + "source": "/reference/postv1dashboards", + "destination": "/api-reference/dashboards/create-a-dashboard" + }, + { + "source": "/reference/deletev1dashboardsdashboardid", + "destination": "/api-reference/dashboards/delete-a-dashboard" + }, + { + "source": "/reference/getv1dashboardsdashboardid", + "destination": "/api-reference/dashboards/retrieve-a-dashboard" + }, + { + "source": "/reference/putv1dashboardsdashboardid", + "destination": "/api-reference/dashboards/update-a-dashboard" + }, + { + "source": "/reference/getv1errorgroups", + "destination": "/api-reference/error-groups/list-all-error-groups" + }, + { + "source": "/reference/getv1errorgroupscheckscheckid", + "destination": "/api-reference/error-groups/list-all-error-groups-for-a-specific-check" + }, + { + "source": "/reference/getv1errorgroupsid", + "destination": "/api-reference/error-groups/retrieve-an-error-group" + }, + { + "source": "/reference/patchv1errorgroupsid", + "destination": "/api-reference/error-groups/update-an-error-group" + }, + { + "source": "/reference/postv1incidents", + "destination": "/api-reference/incidents/create-an-incident" + }, + { + "source": "/reference/deletev1incidentsid", + "destination": "/api-reference/incidents/delete-an-incident" + }, + { + "source": "/reference/getv1incidentsid", + "destination": "/api-reference/incidents/retrieve-an-incident" + }, + { + "source": "/reference/putv1incidentsid", + "destination": "/api-reference/incidents/update-an-incident" + }, + { + "source": "/reference/postv1incidentsincidentidupdates", + "destination": "/api-reference/incident-updates/create-an-incident-update" + }, + { + "source": "/reference/deletev1incidentsincidentidupdatesid", + "destination": "/api-reference/incident-updates/delete-an-incident-update" + }, + { + "source": "/reference/putv1incidentsincidentidupdatesid", + "destination": "/api-reference/incident-updates/update-an-incident-update" + }, + { + "source": "/reference/getv1locations", + "destination": "/api-reference/location/lists-all-supported-locations" + }, + { + "source": "/reference/getv1maintenancewindows", + "destination": "/api-reference/maintenance-windows/list-all-maintenance-windows" + }, + { + "source": "/reference/postv1maintenancewindows", + "destination": "/api-reference/maintenance-windows/create-a-maintenance-window" + }, + { + "source": "/reference/deletev1maintenancewindowsid", + "destination": "/api-reference/maintenance-windows/delete-a-maintenance-window" + }, + { + "source": "/reference/getv1maintenancewindowsid", + "destination": "/api-reference/maintenance-windows/retrieve-a-maintenance-window" + }, + { + "source": "/reference/putv1maintenancewindowsid", + "destination": "/api-reference/maintenance-windows/update-a-maintenance-window" + }, + { + "source": "/reference/getv1maintenancewindowsidmaintenances", + "destination": "/api-reference/maintenance-windows/list-maintenances-for-a-maintenance-window" + }, + { + "source": "/reference/deletev1maintenancewindowsidmaintenancesmaintenanceid", + "destination": "/api-reference/maintenance-windows/delete-a-maintenance" + }, + { + "source": "/reference/getv1maintenancewindowsidmaintenancesmaintenanceid", + "destination": "/api-reference/maintenance-windows/retrieve-a-maintenance" + }, + { + "source": "/reference/patchv1maintenancewindowsidmaintenancesmaintenanceid", + "destination": "/api-reference/maintenance-windows/update-maintenance-dates" + }, + { + "source": "/reference/postv1maintenancewindowsidmaintenancesmaintenanceidupdates", + "destination": "/api-reference/maintenance-windows/create-a-maintenance-window-status-update" + }, + { + "source": "/reference/deletev1maintenancewindowsidmaintenancesmaintenanceidupdatesupdateid", + "destination": "/api-reference/maintenance-windows/delete-a-maintenance-window-status-update" + }, + { + "source": "/reference/putv1maintenancewindowsidmaintenancesmaintenanceidupdatesupdateid", + "destination": "/api-reference/maintenance-windows/update-a-maintenance-window-status-update" + }, + { + "source": "/reference/getv1privatelocations", + "destination": "/api-reference/private-locations/list-all-private-locations" + }, + { + "source": "/reference/postv1privatelocations", + "destination": "/api-reference/private-locations/create-a-private-location" + }, + { + "source": "/reference/deletev1privatelocationsid", + "destination": "/api-reference/private-locations/remove-a-private-location" + }, + { + "source": "/reference/getv1privatelocationsid", + "destination": "/api-reference/private-locations/retrieve-a-private-location" + }, + { + "source": "/reference/putv1privatelocationsid", + "destination": "/api-reference/private-locations/update-a-private-location" + }, + { + "source": "/reference/postv1privatelocationsidkeys", + "destination": "/api-reference/private-locations/generate-a-new-api-key-for-a-private-location" + }, + { + "source": "/reference/deletev1privatelocationsidkeyskeyid", + "destination": "/api-reference/private-locations/remove-an-existing-api-key-for-a-private-location" + }, + { + "source": "/reference/getv1privatelocationsidmetrics", + "destination": "/api-reference/private-locations/get-private-location-health-metrics-from-a-window-of-time" + }, + { + "source": "/reference/getv1reporting", + "destination": "/api-reference/reporting/generates-a-report-with-aggregate-statistics-for-checks-and-check-groups" + }, + { + "source": "/reference/postv1rootcauseanalyseserrorgroupserrorgroupid", + "destination": "/api-reference/rocky-ai/generate-a-root-cause-analysis-for-an-error-group" + }, + { + "source": "/reference/postv1rootcauseanalysestestsessionerrorgroupstestsessionerrorgroupid", + "destination": "/api-reference/rocky-ai/generate-a-root-cause-analysis-for-a-test-session-error-group" + }, + { + "source": "/reference/getv1rootcauseanalysesid", + "destination": "/api-reference/rocky-ai/retrieve-one-root-cause-analysis" + }, + { + "source": "/reference/getv1runtimes", + "destination": "/api-reference/runtimes/lists-all-supported-runtimes" + }, + { + "source": "/reference/getv1runtimesid", + "destination": "/api-reference/runtimes/shows-details-for-one-specific-runtime" + }, + { + "source": "/reference/getv1snippets", + "destination": "/api-reference/snippets/list-all-snippets" + }, + { + "source": "/reference/postv1snippets", + "destination": "/api-reference/snippets/create-a-snippet" + }, + { + "source": "/reference/deletev1snippetsid", + "destination": "/api-reference/snippets/delete-a-snippet" + }, + { + "source": "/reference/getv1snippetsid", + "destination": "/api-reference/snippets/retrieve-a-snippet" + }, + { + "source": "/reference/putv1snippetsid", + "destination": "/api-reference/snippets/update-a-snippet" + }, + { + "source": "/reference/getv1staticips", + "destination": "/api-reference/static-ips/lists-all-source-ips-for-check-runs" + }, + { + "source": "/reference/getv1staticipsbyregion", + "destination": "/api-reference/static-ips/lists-all-source-ips-for-check-runs-1" + }, + { + "source": "/reference/getv1staticipstxt", + "destination": "/api-reference/static-ips/lists-all-source-ips-for-check-runs-as-txt-file" + }, + { + "source": "/reference/getv1staticipv6s", + "destination": "/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs" + }, + { + "source": "/reference/getv1staticipv6sbyregion", + "destination": "/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-1" + }, + { + "source": "/reference/getv1staticipv6stxt", + "destination": "/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-as-a-txt-file" + }, + { + "source": "/reference/getv1statuspages", + "destination": "/api-reference/status-pages/retrieve-all-status-pages" + }, + { + "source": "/reference/postv1statuspages", + "destination": "/api-reference/status-pages/create-a-new-status-page" + }, + { + "source": "/reference/getv1statuspagesincidents", + "destination": "/api-reference/status-page-incidents/retrieve-the-latest-incidents-with-pagination" + }, + { + "source": "/reference/postv1statuspagesincidents", + "destination": "/api-reference/status-page-incidents/create-a-new-incident" + }, + { + "source": "/reference/deletev1statuspagesincidentsincidentid", + "destination": "/api-reference/status-page-incidents/delete-an-incident" + }, + { + "source": "/reference/getv1statuspagesincidentsincidentid", + "destination": "/api-reference/status-page-incidents/retrieve-an-incident-by-id" + }, + { + "source": "/reference/putv1statuspagesincidentsincidentid", + "destination": "/api-reference/status-page-incidents/update-an-existing-incident" + }, + { + "source": "/reference/getv1statuspagesincidentsincidentidincidentupdates", + "destination": "/api-reference/status-page-incidents/retrieve-the-100-latest-incident-updates-of-a-specific-incident" + }, + { + "source": "/reference/postv1statuspagesincidentsincidentidincidentupdates", + "destination": "/api-reference/status-page-incidents/add-a-new-incident-update-to-a-specific-incident" + }, + { + "source": "/reference/deletev1statuspagesincidentsincidentidincidentupdatesincidentupdateid", + "destination": "/api-reference/status-page-incidents/delete-an-incident-update" + }, + { + "source": "/reference/getv1statuspagesincidentsincidentidincidentupdatesincidentupdateid", + "destination": "/api-reference/status-page-incidents/retrieve-an-incident-update-by-id" + }, + { + "source": "/reference/putv1statuspagesincidentsincidentidincidentupdatesincidentupdateid", + "destination": "/api-reference/status-page-incidents/update-an-existing-incident-update" + }, + { + "source": "/reference/getv1statuspagesservices", + "destination": "/api-reference/status-page-services/get-all-services" + }, + { + "source": "/reference/postv1statuspagesservices", + "destination": "/api-reference/status-page-services/create-a-service" + }, + { + "source": "/reference/deletev1statuspagesservicesserviceid", + "destination": "/api-reference/status-page-services/delete-a-service" + }, + { + "source": "/reference/getv1statuspagesservicesserviceid", + "destination": "/api-reference/status-page-services/get-a-single-service" + }, + { + "source": "/reference/putv1statuspagesservicesserviceid", + "destination": "/api-reference/status-page-services/update-a-service" + }, + { + "source": "/reference/deletev1statuspagesstatuspageid", + "destination": "/api-reference/status-pages/delete-a-status-page" + }, + { + "source": "/reference/getv1statuspagesstatuspageid", + "destination": "/api-reference/status-pages/retrieve-a-single-status-page-by-id" + }, + { + "source": "/reference/putv1statuspagesstatuspageid", + "destination": "/api-reference/status-pages/update-an-existing-status-page" + }, + { + "source": "/reference/getv1statuspagesstatuspageidsubscriptions", + "destination": "/api-reference/status-pages/get-all-subscriptions-for-a-specific-status-page" + }, + { + "source": "/reference/postv1statuspagesstatuspageidsubscriptionsbulk", + "destination": "/api-reference/status-pages/bulk-create-subscriptions-for-a-specific-status-page" + }, + { + "source": "/reference/deletev1statuspagesstatuspageidsubscriptionssubscriptionid", + "destination": "/api-reference/status-pages/delete-a-subscription-belonging-to-a-specific-status-page" + }, + { + "source": "/reference/getv1testsessionerrorgroups", + "destination": "/api-reference/test-session-error-groups/list-all-test-session-error-groups" + }, + { + "source": "/reference/getv1testsessionerrorgroupsprojectsprojectid", + "destination": "/api-reference/test-session-error-groups/list-all-test-session-error-groups-for-a-project" + }, + { + "source": "/reference/getv1testsessionerrorgroupsid", + "destination": "/api-reference/test-session-error-groups/retrieve-a-test-session-error-group" + }, + { + "source": "/reference/patchv1testsessionerrorgroupsid", + "destination": "/api-reference/test-session-error-groups/update-a-test-session-error-group" + }, + { + "source": "/reference/getv1testsessions", + "destination": "/api-reference/test-sessions/list-test-sessions" + }, + { + "source": "/reference/postv1testsessionstrigger", + "destination": "/api-reference/test-sessions/trigger-a-new-test-session" + }, + { + "source": "/reference/getv1testsessionstestsessionid", + "destination": "/api-reference/test-sessions/retrieve-a-test-session" + }, + { + "source": "/reference/postv1testsessionstestsessionidcancel", + "destination": "/api-reference/test-sessions/cancel-a-test-session" + }, + { + "source": "/reference/getv1testsessionstestsessionidcompletion", + "destination": "/api-reference/test-sessions/await-the-completion-of-a-test-session" + }, + { + "source": "/reference/getv1testsessionstestsessionidresultstestsessionresultid", + "destination": "/api-reference/test-sessions/retrieve-a-test-session-result" + }, + { + "source": "/reference/getv1testsessionstestsessionidresultstestsessionresultidassets", + "destination": "/api-reference/test-sessions/retrieve-a-normalized-asset-manifest-for-a-test-session-result" + }, + { + "source": "/reference/deletev1triggerscheckgroupsgroupid", + "destination": "/api-reference/triggers/delete-the-check-group-trigger" + }, + { + "source": "/reference/getv1triggerscheckgroupsgroupid", + "destination": "/api-reference/triggers/get-the-check-group-trigger" + }, + { + "source": "/reference/postv1triggerscheckgroupsgroupid", + "destination": "/api-reference/triggers/create-the-check-group-trigger" + }, + { + "source": "/reference/deletev1triggerscheckscheckid", + "destination": "/api-reference/triggers/delete-the-check-trigger" + }, + { + "source": "/reference/getv1triggerscheckscheckid", + "destination": "/api-reference/triggers/get-the-check-trigger" + }, + { + "source": "/reference/postv1triggerscheckscheckid", + "destination": "/api-reference/triggers/create-the-check-trigger" + }, + { + "source": "/reference/getv1variables", + "destination": "/api-reference/environment-variables/list-all-environment-variables" + }, + { + "source": "/reference/postv1variables", + "destination": "/api-reference/environment-variables/create-an-environment-variable" + }, + { + "source": "/reference/deletev1variableskey", + "destination": "/api-reference/environment-variables/delete-an-environment-variable" + }, + { + "source": "/reference/getv1variableskey", + "destination": "/api-reference/environment-variables/retrieve-an-environment-variable" + }, + { + "source": "/reference/putv1variableskey", + "destination": "/api-reference/environment-variables/update-an-environment-variable" + }, + { + "source": "/reference/postv2checkgroups", + "destination": "/api-reference/check-groups/create-a-check-group-v2" + }, + { + "source": "/reference/putv2checkgroupsid", + "destination": "/api-reference/check-groups/update-a-check-group-v2" + }, + { + "source": "/reference/getv2checkresultscheckid", + "destination": "/api-reference/check-results/lists-all-check-results-1" + }, + { + "source": "/reference/postv2checksessionstrigger", + "destination": "/api-reference/check-sessions/trigger-a-new-check-session-v2" + }, + { + "source": "/reference/getv2checksessionschecksessionid", + "destination": "/api-reference/check-sessions/retrieve-a-check-session-v2" + }, + { + "source": "/reference/getv2checksessionschecksessionidcompletion", + "destination": "/api-reference/check-sessions/await-the-completion-of-a-check-session-v2" + }, + { + "source": "/reference/authentication", + "destination": "/api-reference/overview#authentication" + }, + { + "source": "/reference/:slug*", + "destination": "/api-reference/overview" } ] } diff --git a/guides/create-multiple-monitors.mdx b/guides/create-multiple-monitors.mdx index d7704e08..1dad9633 100644 --- a/guides/create-multiple-monitors.mdx +++ b/guides/create-multiple-monitors.mdx @@ -116,7 +116,7 @@ Create: UrlMonitor: multi-url-monitor-0checklyhq.com UrlMonitor: multi-url-monitor-1checklyhq.com UrlMonitor: multi-url-monitor-2checklyhq.com - UrlMonitor: multi-url-monitor-3developers.checklyhq.com + UrlMonitor: multi-url-monitor-3checklyhq.com UrlMonitor: multi-url-monitor-4checklyhq.com ``` diff --git a/guides/developer-fixtures.mdx b/guides/developer-fixtures.mdx index 20c97f73..54fd7b12 100644 --- a/guides/developer-fixtures.mdx +++ b/guides/developer-fixtures.mdx @@ -47,9 +47,9 @@ For small teams just getting started with Checkly, this is all you need to do to It's a great feature of Checkly that any check can have totally custom settings for every aspect of its running: it can run at a custom cadence, from its own geography, with its own logic for retries. This means that if, for example, you're creating a new test specifically to check localization settings, you can set just that check to run from dozens of geographies, even if most checks only need three or four. -Of course, we don't want to give our fresh developer over a dozen settings that she needs to set just to create her first check. New Checks created either in the web UI or from your code environment via the CLI will default to using the [global configuration](https://docs.checklyhq.com/cli/overviewproject-structure/#global-configuration). You can view and edit this global config in `checkly.config.ts`, you can see a reference on this configuration and options under the `project` [construct documentation](https://docs.checklyhq.com/cli/overviewconstructs-reference/#project). Some suggestions for default configuration: +Of course, we don't want to give our fresh developer over a dozen settings that she needs to set just to create her first check. New Checks created either in the web UI or from your code environment via the CLI will default to using the [global configuration](/constructs/overview#global-configuration). You can view and edit this global config in `checkly.config.ts`, you can see a reference on this configuration and options under the `project` [construct documentation](/constructs/project). Some suggestions for default configuration: -* Set a generous `RetryStrategy`! Some failures can look extremely worrying even if they happen once, but it's worth double-checking that the problem wasn't entirely ephemeral. Full [documentation of retry configuration is on our docs site](https://docs.checklyhq.com/cli/overviewconstructs-reference/#retrystrategy). +* Set a generous `RetryStrategy`! Some failures can look extremely worrying even if they happen once, but it's worth double-checking that the problem wasn't entirely ephemeral. Full [documentation of retry configuration is on our docs site](/constructs/retry-strategy). * If you're encouraging microservice developers or frontend engineers to add checks, consider setting the default frequency to be relatively low. It's great to test edge cases or unusual scenarios, but someone without exposure to Operations is unlikely to need to run a check every minute. @@ -83,7 +83,7 @@ Some important things to remember when working with a group of checks: So group settings will override global settings, and individual settings will override everything else. -* While groups are a useful feature of Checkly, and will make sense for some applications, you may also be served by using Javascript and Typescript's native features for [inheritance](https://www.typescriptlang.org/docs/handbook/2/classes.html). Since files can inherit modules from others, it's possible to share configuration very cleanly, is as complex a heirarchy as you'd like, using these native features. This especially may make sense if you're going deep into [Monitoring as Code](https://docs.checklyhq.com/guides/getting-started-with-monitoring-as-code/) and want to set up a complex repository for all monitoring. Native features also help support the next section on using fixtures to share code blocks. +* While groups are a useful feature of Checkly, and will make sense for some applications, you may also be served by using Javascript and Typescript's native features for [inheritance](https://www.typescriptlang.org/docs/handbook/2/classes.html). Since files can inherit modules from others, it's possible to share configuration very cleanly, is as complex a heirarchy as you'd like, using these native features. This especially may make sense if you're going deep into [Monitoring as Code](/guides/getting-started-with-monitoring-as-code) and want to set up a complex repository for all monitoring. Native features also help support the next section on using fixtures to share code blocks. ## Sharing code for repeated tasks While there are sophisticated ways to share authentication across checks discussed in other guides, it's good to know how to share code with fixtures for common repeated tasks. Let's imagine an example where we've got a web shop with a login modal that we need to fill out before doing further account actions. The goal of my check isn't really to test this modal, it just needs to be filled out before my *real* testing, where I look at my demo user's recent orders.