Skip to content

chore(api): update API spec and add 31 new endpoint page(s) #484

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

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore(api): update API spec and add 31 new endpoint page(s) #484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions api-reference/openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions ...tus-pages-v3-automation-rules/create-an-automation-rule-on-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: post /v3/status-pages/{statusPageId}/automation-rules
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-automation-rules/create-an-automation-rule-on-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions ...tus-pages-v3-automation-rules/delete-an-automation-rule-of-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: delete /v3/status-pages/{statusPageId}/automation-rules/{ruleId}
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-automation-rules/delete-an-automation-rule-of-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions ...tus-pages-v3-automation-rules/list-the-automation-rules-of-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: get /v3/status-pages/{statusPageId}/automation-rules
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-automation-rules/list-the-automation-rules-of-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions ...s-v3-automation-rules/retrieve-a-single-automation-rule-of-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: get /v3/status-pages/{statusPageId}/automation-rules/{ruleId}
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-automation-rules/retrieve-a-single-automation-rule-of-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions ...tus-pages-v3-automation-rules/update-an-automation-rule-of-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: put /v3/status-pages/{statusPageId}/automation-rules/{ruleId}
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-automation-rules/update-an-automation-rule-of-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions ...reference/status-pages-v3-components/create-a-component-on-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: post /v3/status-pages/{statusPageId}/components
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-components/create-a-component-on-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions ...reference/status-pages-v3-components/delete-a-component-of-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: delete /v3/status-pages/{statusPageId}/components/{componentId}
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-components/delete-a-component-of-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions ...eference/status-pages-v3-components/list-the-components-of-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: get /v3/status-pages/{statusPageId}/components
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-components/list-the-components-of-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions .../status-pages-v3-components/retrieve-a-single-component-of-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: get /v3/status-pages/{statusPageId}/components/{componentId}
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-components/retrieve-a-single-component-of-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions ...reference/status-pages-v3-components/update-a-component-of-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: put /v3/status-pages/{statusPageId}/components/{componentId}
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-components/update-a-component-of-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions api-reference/status-pages-v3-incidents/delete-an-incident-of-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: delete /v3/status-pages/{statusPageId}/incidents/{incidentId}
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/delete-an-incident-of-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions api-reference/status-pages-v3-incidents/delete-an-incident-update.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: delete /v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/delete-an-incident-update/'
---
4 changes: 4 additions & 0 deletions api-reference/status-pages-v3-incidents/edit-an-incident-update.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: put /v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/edit-an-incident-update/'
---
4 changes: 4 additions & 0 deletions api-reference/status-pages-v3-incidents/list-the-incidents-of-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: get /v3/status-pages/{statusPageId}/incidents
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/list-the-incidents-of-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions api-reference/status-pages-v3-incidents/list-the-updates-of-an-incident.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: get /v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/list-the-updates-of-an-incident/'
---
4 changes: 4 additions & 0 deletions api-reference/status-pages-v3-incidents/open-an-incident-on-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: post /v3/status-pages/{statusPageId}/incidents
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/open-an-incident-on-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions api-reference/status-pages-v3-incidents/post-an-update-to-an-incident.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: post /v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/post-an-update-to-an-incident/'
---
4 changes: 4 additions & 0 deletions ...e/status-pages-v3-incidents/replace-an-incident-s-component-impact-timeline.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: put /v3/status-pages/{statusPageId}/incidents/{incidentId}/component-impacts
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/replace-an-incident-s-component-impact-timeline/'
---
4 changes: 4 additions & 0 deletions ...eference/status-pages-v3-incidents/retrieve-an-incident-of-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: get /v3/status-pages/{statusPageId}/incidents/{incidentId}
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/retrieve-an-incident-of-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions api-reference/status-pages-v3-incidents/retrieve-an-incident-update.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: get /v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/retrieve-an-incident-update/'
---
4 changes: 4 additions & 0 deletions api-reference/status-pages-v3-incidents/update-an-incident-of-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: put /v3/status-pages/{statusPageId}/incidents/{incidentId}
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/update-an-incident-of-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions ...ference/status-pages-v3-subscribers/delete-a-subscriber-of-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: delete /v3/status-pages/{statusPageId}/subscribers/{subscriberId}
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-subscribers/delete-a-subscriber-of-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions ...erence/status-pages-v3-subscribers/list-the-subscribers-of-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: get /v3/status-pages/{statusPageId}/subscribers
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-subscribers/list-the-subscribers-of-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions ...pages-v3-subscribers/subscribe-multiple-email-addresses-to-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: post /v3/status-pages/{statusPageId}/subscribers/bulk
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3-subscribers/subscribe-multiple-email-addresses-to-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions api-reference/status-pages-v3/create-a-new-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: post /v3/status-pages
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3/create-a-new-v3-status-page/'
---
4 changes: 4 additions & 0 deletions api-reference/status-pages-v3/delete-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: delete /v3/status-pages/{statusPageId}
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3/delete-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions api-reference/status-pages-v3/list-v3-status-pages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: get /v3/status-pages
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3/list-v3-status-pages/'
---
4 changes: 4 additions & 0 deletions ...status-pages-v3/re-check-the-custom-domain-verification-of-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: post /v3/status-pages/{statusPageId}/custom-domain-verifications/recheck
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3/re-check-the-custom-domain-verification-of-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions api-reference/status-pages-v3/retrieve-a-single-v3-status-page-by-id.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: get /v3/status-pages/{statusPageId}
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3/retrieve-a-single-v3-status-page-by-id/'
---
4 changes: 4 additions & 0 deletions ...s-pages-v3/retrieve-custom-domain-verification-details-for-a-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: get /v3/status-pages/{statusPageId}/custom-domain-verifications
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3/retrieve-custom-domain-verification-details-for-a-v3-status-page/'
---
4 changes: 4 additions & 0 deletions api-reference/status-pages-v3/update-an-existing-v3-status-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: put /v3/status-pages/{statusPageId}
canonical: 'https://www.checklyhq.com/docs/api-reference/status-pages-v3/update-an-existing-v3-status-page/'
---
56 changes: 56 additions & 0 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1043,6 +1043,62 @@
"pages": [
"api-reference/secret-scans/lists-readable-configuration-values-that-look-like-inline-credentials"
]
},
{
"group": "Status Pages V3",
"pages": [
"api-reference/status-pages-v3/list-v3-status-pages",
"api-reference/status-pages-v3/create-a-new-v3-status-page",
"api-reference/status-pages-v3/delete-a-v3-status-page",
"api-reference/status-pages-v3/retrieve-a-single-v3-status-page-by-id",
"api-reference/status-pages-v3/update-an-existing-v3-status-page",
"api-reference/status-pages-v3/retrieve-custom-domain-verification-details-for-a-v3-status-page",
"api-reference/status-pages-v3/re-check-the-custom-domain-verification-of-a-v3-status-page"
]
},
{
"group": "Status Pages V3 Automation Rules",
"pages": [
"api-reference/status-pages-v3-automation-rules/list-the-automation-rules-of-a-v3-status-page",
"api-reference/status-pages-v3-automation-rules/create-an-automation-rule-on-a-v3-status-page",
"api-reference/status-pages-v3-automation-rules/delete-an-automation-rule-of-a-v3-status-page",
"api-reference/status-pages-v3-automation-rules/retrieve-a-single-automation-rule-of-a-v3-status-page",
"api-reference/status-pages-v3-automation-rules/update-an-automation-rule-of-a-v3-status-page"
]
},
{
"group": "Status Pages V3 Components",
"pages": [
"api-reference/status-pages-v3-components/list-the-components-of-a-v3-status-page",
"api-reference/status-pages-v3-components/create-a-component-on-a-v3-status-page",
"api-reference/status-pages-v3-components/delete-a-component-of-a-v3-status-page",
"api-reference/status-pages-v3-components/retrieve-a-single-component-of-a-v3-status-page",
"api-reference/status-pages-v3-components/update-a-component-of-a-v3-status-page"
]
},
{
"group": "Status Pages V3 Incidents",
"pages": [
"api-reference/status-pages-v3-incidents/list-the-incidents-of-a-v3-status-page",
"api-reference/status-pages-v3-incidents/open-an-incident-on-a-v3-status-page",
"api-reference/status-pages-v3-incidents/delete-an-incident-of-a-v3-status-page",
"api-reference/status-pages-v3-incidents/retrieve-an-incident-of-a-v3-status-page",
"api-reference/status-pages-v3-incidents/update-an-incident-of-a-v3-status-page",
"api-reference/status-pages-v3-incidents/replace-an-incident-s-component-impact-timeline",
"api-reference/status-pages-v3-incidents/list-the-updates-of-an-incident",
"api-reference/status-pages-v3-incidents/post-an-update-to-an-incident",
"api-reference/status-pages-v3-incidents/delete-an-incident-update",
"api-reference/status-pages-v3-incidents/retrieve-an-incident-update",
"api-reference/status-pages-v3-incidents/edit-an-incident-update"
]
},
{
"group": "Status Pages V3 Subscribers",
"pages": [
"api-reference/status-pages-v3-subscribers/list-the-subscribers-of-a-v3-status-page",
"api-reference/status-pages-v3-subscribers/subscribe-multiple-email-addresses-to-a-v3-status-page",
"api-reference/status-pages-v3-subscribers/delete-a-subscriber-of-a-v3-status-page"
]
}
]
}
Expand Down
93 changes: 93 additions & 0 deletions sitemap.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -570,6 +570,99 @@
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-page-services/update-a-service/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-automation-rules/create-an-automation-rule-on-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-automation-rules/delete-an-automation-rule-of-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-automation-rules/list-the-automation-rules-of-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-automation-rules/retrieve-a-single-automation-rule-of-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-automation-rules/update-an-automation-rule-of-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-components/create-a-component-on-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-components/delete-a-component-of-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-components/list-the-components-of-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-components/retrieve-a-single-component-of-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-components/update-a-component-of-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/delete-an-incident-of-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/delete-an-incident-update/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/edit-an-incident-update/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/list-the-incidents-of-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/list-the-updates-of-an-incident/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/open-an-incident-on-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/post-an-update-to-an-incident/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/replace-an-incident-s-component-impact-timeline/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/retrieve-an-incident-of-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/retrieve-an-incident-update/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-incidents/update-an-incident-of-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-subscribers/delete-a-subscriber-of-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-subscribers/list-the-subscribers-of-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3-subscribers/subscribe-multiple-email-addresses-to-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3/create-a-new-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3/delete-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3/list-v3-status-pages/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3/re-check-the-custom-domain-verification-of-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3/retrieve-a-single-v3-status-page-by-id/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3/retrieve-custom-domain-verification-details-for-a-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages-v3/update-an-existing-v3-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/status-pages/bulk-create-subscriptions-for-a-specific-status-page/</loc>
</url>
Expand Down