Jump to Content
API Reference
v1
Log In
API Reference
Log In
v1
API Reference
Update an incident
Search
JUMP TO
Getting Started
Authentication
Rate Limits
Checkly Public API
Accounts
[beta] Fetch user accounts
get
[beta] Fetch current account details
get
[beta] Fetch a given account details
get
Alert channels
List all alert channels
get
Create an alert channel
post
Delete an alert channel
delete
Retrieve an alert channel
get
Update an alert channel
put
Update the subscriptions of an alert channel
put
Alert notifications
Lists all alert notifications
get
Analytics
API checks
get
Browser checks
get
Heartbeat checks
get
List all available reporting metrics.
get
Multistep checks
get
TCP checks
get
Badges
/v1/badges/checks/{checkId}
get
/v1/badges/groups/{groupId}
get
Check alerts
List all alerts for your account
get
List alerts for a specific check
get
Check groups
List all check groups
get
Create a check group
post
Retrieve one check in a specific group with group settings applied
get
Delete a check group.
delete
Retrieve a check group
get
Update a check group
put
Retrieve all checks in a specific group with group settings applied
get
Check results
Lists all check results
get
Retrieve a check result
get
Lists all check results
get
Check status
List all check statuses
get
Retrieve check status details
get
Checks
List all checks
get
Create a check
post
Create an API check
post
Update an API check
put
Create a browser check
post
Update a browser check
put
Create a multi-step check
post
Update a multi-step check
put
Create a TCP check
post
Update an TCP check
put
Delete a check
delete
Retrieve a check
get
Update a check
put
Heartbeats
Create a heartbeat check
post
Update a heartbeat check
put
Get heartbeat availability
get
Get a list of events for a heartbeat
get
Get a specific Heartbeat event
get
Client certificates
Lists all client certificates.
get
Creates a new client certificate.
post
Deletes a client certificate.
delete
Shows one client certificate.
get
Dashboards
List all dashboards
get
Create a dashboard
post
Delete a dashboard
delete
Retrieve a dashboard
get
Update a dashboard
put
Incidents
Create an incident
post
Delete an incident
delete
Retrieve an incident
get
Update an incident
put
Incident Updates
Create an incident update
post
Delete an incident update
delete
Update an incident update
put
Location
Lists all supported locations
get
Maintenance windows
List all maintenance windows
get
Create a maintenance window
post
Delete a maintenance window
delete
Retrieve a maintenance window
get
Update a maintenance window
put
Private locations
List all private locations
get
Create a private location
post
Remove a private location
delete
Retrieve a private location
get
Update a private location
put
Generate a new API Key for a private location
post
Remove an existing API key for a private location
delete
Get private location health metrics from a window of time.
get
Reporting
Generates a report with aggregate statistics for checks and check groups.
get
Runtimes
Lists all supported runtimes
get
Shows details for one specific runtime
get
Snippets
List all snippets
get
Create a snippet
post
Delete a snippet
delete
Retrieve a snippet
get
Update a snippet
put
Static IPs
Lists all source IPs for check runs
get
Lists all source IPs for check runs
get
Lists all source IPs for check runs as txt file
get
Lists all source IPv6s for check runs
get
Lists all source IPv6s for check runs
get
Lists all source IPv6s for check runs as a txt file
get
Status Pages
Retrieve all status pages.
get
Create a new status page.
post
Delete a status page.
delete
Retrieve a single status page by id.
get
Update an existing status page.
put
Status Page Incidents
Retrieve the latest 100 incidents.
get
Create a new incident.
post
Delete an incident.
delete
Retrieve an incident by id.
get
Update an existing incident.
put
Retrieve the 100 latest incident updates of a specific incident.
get
Add a new incident update to a specific incident.
post
Delete an incident update.
delete
Retrieve an incident update by id.
get
Update an existing incident update.
put
Status Page Services
Get all services
get
Create a service
post
Delete a service
delete
Get a single service
get
Update a service
put
Triggers
Delete the check group trigger
delete
Get the check group trigger
get
Create the check group trigger
post
Delete the check trigger
delete
Get the check trigger
get
Create the check trigger
post
Environment variables
List all environment variables
get
Create an environment variable
post
Delete an environment variable
delete
Retrieve an environment variable
get
Update an environment variable
put
Update an incident
put
https://api.checklyhq.com/v1/incidents/
{id}
Updates an incident.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
RESPONSE
Click
Try It!
to start a request and see the response here!