Instatus (Independent Publisher) (Preview)

  • Reference

Get a status page that's resilient to downtime & quick to load. Your status page is static and loads independently from any backend.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connector Metadata
Publisher Troy Taylor
Website https://instatus.com/
Privacy policy https://instatus.com/policies/privacy
Categories Website;IT Operations

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key (in the form 'Bearer API_Key') securestring The API Key (in the form 'Bearer API_Key') for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add incident

Adds an incident on a page.
Add incident update

Add an update to a page incident.
Add incident using template

Adds an incident to a page using a template.
Add maintenance

Add a maintenance on a page.
Add maintenance update

Add an update to a maintenance on a page.
Add subscriber

Add a subscriber to a page.
Add team member

Add a member to your team on a page.
Add template

Create a template for a page.
Create component

Creates a component on a page.
Create status page

Create a new status page based on your requested parameters.
Delete component

Deletes a component on a page.
Delete incident

Deletes an incident on a page.
Delete incident update

Deletes an update for an incident on a page.
Delete maintenance

Deletes a maintenance for a page.
Delete maintenance update

Delete an update to a maintenance on a page.
Delete status page

Deletes a status page.
Delete team member

Deletes a team member from a page.
Delete template

Deletes a template for a page.
Edit incident update

Edits an update for an incident on a page.
Edit maintenance update

Edit an update for a maintenance on a page.
Get component

Retrieve a component on a page.
Get incident

Retrieve an incident on a page.
Get incident update

Retrieve an update on a page incident.
Get maintenance

Retrieve a maintenance for a page.
Get maintenance update

Retrieve an update for a maintenance on a page.
Get page incidents

Retrieve all incidents for a page.
Get page maintenances

Retrieve all maintenances for a page.
Get page templates

Retrieve a list of all page templates.
Get status page components

Retrieve a list of all your status page components.
Get status pages

Retrieve a list of your status pages.
Get subscribers

Retrieve a list of subscribers for a page.
Get teammates

Retrieve a list of teammates.
Get template

Retrieve a template for a page.
Remove subscriber

Remove a subscriber from a page.
Resolve incident with template

Resolves an incident on a page with a template.
Update component

Updates a component on a page.
Update incident

Updates an incident on a page.
Update maintenance

Updates a maintenance on a page.
Update status page

Update a created status page.
Update template

Updates a template for a page.

Add incident

Operation ID:
IncidentPost

Adds an incident on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Name
 name string

The name.
Message
 message string

The message.
Components
 components array of string

The components.
Started
 started string

When started.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
ID
 id string

The identifier.
Status
 status string

The status.

Returns

Name Path Type Description
ID
 id string

The identifier.
Name
 name string

The name.
Status
 status string

The status.
Started
 started string

When started.
Resolved
 resolved string

When resolved.
Updates
 updates array of string

The updates.
Components
 components array of object
ID
 components.id string

The identifier.
Name
 components.name string

The name.
Status
 components.status string

The status.
Show Uptime
 components.showUptime boolean

Whether to show uptime.
ID
 components.site.id string

The identifier.
Name
 components.site.name string

The name.
Subdomain
 components.site.subdomain string

The subdomain.
Color
 components.site.color string

The color.
Logo URL
 components.site.logoUrl string

The logo URL address.
Public Email
 components.site.publicEmail string

The public email address.

Add incident update

Operation ID:
IncidentUpdatePost

Add an update to a page incident.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Incident ID
 incident_id True string

The incident identifier.
Message
 message string

The message.
Components
 components array of string

The components.
Started
 started string

When started.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
ID
 id string

The identifier.
Status
 status string

The status.

Returns

Name Path Type Description
ID
 id string

The identifier.
Message
 message string

The message.
Message HTML
 messageHtml string

The message HTML.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
Started
 started string

When started.
ID
 incident.id string

The identifier.
Name
 incident.name string

The name.
Started
 incident.started string

When started.
Status
 incident.status string

The status.
Components
 incident.components array of object
ID
 incident.components.id string

The identifier.
Name
 incident.components.name string

The name.
Status
 incident.components.status string

The status.
Show Uptime
 incident.components.showUptime boolean

Whether to show uptime.
Subdomain
 incident.components.site.subdomain string

The subdomain.
Logo URL
 incident.components.site.logoUrl string

The logo URL address.
Name
 incident.components.site.name string

The name.
Slack Integrations
 incident.components.site.slackIntegrations array of string

The Slack integrations.
Subscribers
 incident.components.site.subscribers array of string

The subscribers.
Subscribers
 incident.components.subscribers array of string

The subscribers.

Add incident using template

Operation ID:
IncidentTemplatePost

Adds an incident to a page using a template.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Template
 template True string

The template.

Returns

Name Path Type Description
ID
 id string

The identifier.
Name
 name string

The name.
Name Translation ID
 nameTranslationId string

The name translation identifier.
Notify
 notify boolean

Whether to notify.
Status
 status string

The status.
Started
 started string

When started.
Resolved
 resolved string

When resolved.
Duration
 duration string

The duration.
Created At
 createdAt string

When created at.
Updated At
 updatedAt string

When updated at.
Automated
 automated boolean

Whether automated.
Impact
 impact string

The impact.
App ID
 appId string

The app identifier.
Site ID
 siteId string

The site identifier.
Imported From Status Page
 importedFromStatuspage boolean

Whether imported from status page.

Add maintenance

Operation ID:
MaintenancePost

Add a maintenance on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Name
 name string

The name.
Message
 message string

The message.
Components
 components array of string

The components.
Start
 start string

The start.
End
 end string

The end.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
Duration
 duration integer

The duration.
Notify Start
 notifyStart boolean

Whether to notify start.
Notify End
 notifyEnd boolean

Whether to notify end.
Notify Early
 notifyEarly boolean

Whether to notify early.
Notify Minutes
 notifyMinutes integer

The notify minutes.
Auto Start
 autoStart boolean

Whether to auto start.
Auto End
 autoEnd boolean

Whether to auto end.
ID
 id string

The identifier.
Status
 status string

The status.

Returns

Name Path Type Description
ID
 id string

The identifier.
Name
 name string

The name.
Duration
 duration string

The duration.
Start
 start string

The start.
End
 end string

The end.
Status
 status string

The status.
Updates
 updates array of string

The updates.
Components
 components array of object
ID
 components.id string

The identifier.
Name
 components.name string

The name.
Status
 components.status string

The status.
Show Uptime
 components.showUptime boolean

Whether to show uptime.
ID
 components.site.id string

The identifier.
Name
 components.site.name string

The name.
Subdomain
 components.site.subdomain string

The subdomain.
Color
 components.site.color string

The color.
Logo URL
 components.site.logoUrl string

The logo URL address.
Public Email
 components.site.publicEmail string

The public email address.

Add maintenance update

Operation ID:
MaintenanceUpdatePost

Add an update to a maintenance on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Maintenance ID
 maintenance_id True string

The maintenance identifier.
Message
 message string

The message.
Components
 components array of string

The components.
Started
 started string

When started.
End
 end string

The end.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
ID
 id string

The identifier.
Status
 status string

The status.

Returns

Name Path Type Description
ID
 id string

The identifier.
Message
 message string

The message.
Message HTML
 messageHtml string

The message HTML.
Notify
 notify boolean

Whether to notify.
Started
 started string

When started.
Status
 status string

The status.
ID
 maintenance.id string

The identifier.
Name
 maintenance.name string

The name.
Start
 maintenance.start string

The start.
Status
 maintenance.status string

The status.
Components
 maintenance.components array of object
ID
 maintenance.components.id string

The identifier.
Name
 maintenance.components.name string

The name.
Status
 maintenance.components.status string

The status.
Show Uptime
 maintenance.components.showUptime boolean

Whether to show uptime.
Subscribers
 maintenance.components.subscribers array of string

The subscribers.
ID
 maintenance.components.site.id string

The identifier.
Name
 maintenance.components.site.name string

The name.
Subdomain
 maintenance.components.site.subdomain string

The subdomain.
Color
 maintenance.components.site.color string

The color.
Logo URL
 maintenance.components.site.logoUrl string

The logo URL address.
Public Email
 maintenance.components.site.publicEmail string

The public email address.
Subscribers
 maintenance.components.site.subscribers array of string

The subscribers.

Add subscriber

Operation ID:
SubscriberPost

Add a subscriber to a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Email
 email string

The email address.
All
 all boolean

Whether all.
Auto Confirm
 autoConfirm boolean

Whether to auto confirm.

Returns

Name Path Type Description
ID
 id string

The identifier.
Email
 email string

The email address.
ID
 site.id string

The identifier.
Name
 site.name string

The name.
Logo URL
 site.logoUrl string

The logo URL address.
Subdomain
 site.subdomain string

The subdomain.
Public Email
 site.publicEmail string

The public email address.
Language
 site.language string

The language.

Add team member

Operation ID:
TeamMemberPost

Add a member to your team on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Email
 email string

The email address.

Returns

response
string

Add template

Operation ID:
TemplatePost

Create a template for a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Subdomain
 subdomain string

The subdomain.
Type
 type string

The type.
Name
 name string

The name.
Message
 message string

The message.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
ID
 id string

The identifier.
Status
 status string

The status.

Returns

Name Path Type Description
ID
 id string

The identifier.
Type
 type string

The type.
Name
 name string

The name.
Name Translation ID
 nameTranslationId string

The name translation identifier.
Message
 message string

The message.
Message Translation ID
 messageTranslationId string

The message translation identifier.
Message HTML
 messageHtml string

The message HTML.
Message HTML Translation ID
 messageHtmlTranslationId string

The message HTML translation identifier.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
Created At
 createdAt string

When created at.
Site ID
 siteId string

The site identifier.
Imported From Status Page
 importedFromStatuspage boolean

Whether imported from status page.
Deleted At
 deletedAt string

When deleted at.
Components
 components array of string

The components.
Name
 translations.name string

The name.
Message
 translations.message string

The message.

Create component

Operation ID:
ComponentPost

Creates a component on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Name
 name string

The name.
Description
 description string

The description.
Status
 status string

The status.
Order
 order integer

The order.
Show Uptime
 showUptime boolean

Whether to show uptime.
Grouped
 grouped boolean

Whether grouped.

Returns

Name Path Type Description
ID
 id string

The identifier.
Name
 name string

The name.
Description
 description string

The description.
Unique Email
 uniqueEmail string

The unique email address.
Status
 status string

The status.
Show Uptime
 showUptime boolean

Whether to show uptime.
Order
 order integer

The order.
Group
 group string

The group.

Create status page

Operation ID:
PagePost

Create a new status page based on your requested parameters.

Parameters

Name Key Required Type Description
Email
 email string

The email address.
Name
 name string

The name.
Subdomain
 subdomain string

The subdomain.
Components
 components array of string

The components.
Logo URL
 logoUrl string

The logo URL address.
Favicon URL
 faviconUrl string

The favicon URL address.
Website URL
 websiteUrl string

The website URL address.
Language
 language string

The language.
Use Large Header
 useLargeHeader boolean

Whether to use large header.
Brand Color
 brandColor string

The brand color.
OK Color
 okColor string

The OK color.
Disrupted Color
 disruptedColor string

The disrupted color.
Degraded Color
 degradedColor string

The degraded color.
Down Color
 downColor string

The down color.
Notice Color
 noticeColor string

The notice color.
Unknown Color
 unknownColor string

The unknown color.
Google Analytics
 googleAnalytics string

The Google Analytics.
Subscribe By SMS
 subscribeBySms boolean

Whether to subscribe by SMS.
SMS Service
 smsService string

The SMS service.
Twilio SID
 twilioSid string

The Twilio SID.
Twilio Token
 twilioToken string

The Twilio token.
Twilio Sender
 twilioSender string

The Twilio sender.
HTML In Meta
 htmlInMeta string

The HTML in meta.
HTML Above Header
 htmlAboveHeader string

The HTML above header.
HTML Below Header
 htmlBelowHeader string

The HTML below header.
HTML Above Footer
 htmlAboveFooter string

The HTML above footer.
HTML Below Footer
 htmlBelowFooter string

The HTML below footer.
HTML Below Summary
 htmlBelowSummary string

The HTML below summary.
CSS Global
 cssGlobal string

The CSS global.
Launch Date
 launchDate string

The launch date.
Date Format
 dateFormat string

The date format.
Date Format Short
 dateFormatShort string

The date format short.
Time Format
 timeFormat string

The time format.

Returns

Name Path Type Description
ID
 id string

The identifier.
Created At
 createdAt string

When created at.
Subdomain
 subdomain string

The subdomain.
Logo URL
 logoUrl string

The logo URL address.
Favicon URL
 faviconUrl string

The favicon URL address.
Website URL
 websiteUrl string

The website URL address.
Name
 name string

The name.
Status
 status string

The status.
Color
 color string

The color.
Language
 language string

The language.
Google Analytics
 googleAnalytics string

The Google Analytics.
Public Email
 publicEmail string

The public email address.
Custom Domain
 customDomain string

The custom domain.
Use Large Header
 useLargeHeader boolean

Whether to use large header.
Disable Dark Mode
 disableDarkMode string

The disabled dark mode.
Twitter
 twitter string

The Twitter handle.
Subscribe By SMS
 subscribeBySms string

The subscribe by SMS.
Brand Color
 brandColor string

The brand color.
OK Color
 okColor string

The OK color.
Disrupted Color
 disruptedColor string

The disrupted color.
Down Color
 downColor string

The down color.
Degraded Color
 degradedColor string

The degraded color.
Notice Color
 noticeColor string

The notice color.
HTML In Meta
 htmlInMeta string

The HTML in meta.
HTML Above Header
 htmlAboveHeader string

The HTML above header.
HTML Below Header
 htmlBelowHeader string

The HTML below header.
HTML Above Footer
 htmlAboveFooter string

The HTML above footer.
HTML Below Footer
 htmlBelowFooter string

The HTML below footer.
HTML Below Summary
 htmlBelowSummary string

The HTML below summary.
CSS Global
 cssGlobal string

The CSS global.
Onboarded
 onboarded string

The onboarded.
Launch Date
 launchDate string

The launch date.
Date Format
 dateFormat string

The date format.
Date Format Short
 dateFormatShort string

The date format short.
Time Format
 timeFormat string

The time format.
Private
 private boolean

Whether private.
Use Allow List
 useAllowList boolean

Whether to use allow list.
Allow List
 allowList array of string

The allow list.
Components
 components array of object
ID
 components.id string

The identifier.
Name
 components.name string

The name.
Status
 components.status string

The status.
Show Uptime
 components.showUptime boolean

Whether to show uptime.
Order
 components.order string

The order.
Group
 components.group string

The group.
Incidents
 components.incidents array of string

The incidents.

Delete component

Operation ID:
ComponentDelete

Deletes a component on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Component ID
 component_id True string

The component identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.

Delete incident

Operation ID:
IncidentDelete

Deletes an incident on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Incident ID
 incident_id True string

The incident identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.

Delete incident update

Operation ID:
IncidentUpdateDelete

Deletes an update for an incident on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Incident ID
 incident_id True string

The incident identifier.
Incident Update ID
 incident_update_id True string

The incident update identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.

Delete maintenance

Operation ID:
MaintenanceDelete

Deletes a maintenance for a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Maintenance ID
 maintenance_id True string

The maintenance identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.

Delete maintenance update

Operation ID:
MaintenanceUpdateDelete

Delete an update to a maintenance on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Maintenance ID
 maintenance_id True string

The maintenance identifier.
Maintenance Update ID
 maintenance_update_id True string

The maintenance update identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.

Delete status page

Operation ID:
PageDelete

Deletes a status page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.

Delete team member

Operation ID:
TeamMemberDelete

Deletes a team member from a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Member ID
 member_id True string

The member identifier.

Returns

response
string

Delete template

Operation ID:
TemplateDelete

Deletes a template for a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Template ID
 template_id True string

The template identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.
Name
 name string

The name.
Message
 message string

The message.
Created At
 createdAt string

When created at.
ID
 site.id string

The identifier.

Edit incident update

Operation ID:
IncidentUpdatePut

Edits an update for an incident on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Incident ID
 incident_id True string

The incident identifier.
Incident Update ID
 incident_update_id True string

The incident update identifier.
Message
 message string

The message.
Components
 components array of string

The components.
Started
 started string

When started.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
ID
 id string

The identifier.
Status
 status string

The status.

Returns

Name Path Type Description
ID
 id string

The identifier.
Message
 message string

The message.
Message HTML
 messageHtml string

The message HTML.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
Started
 started string

When started.
ID
 incident.id string

The identifier.
Name
 incident.name string

The name.
Started
 incident.started string

When started.
Status
 incident.status string

The status.
Components
 incident.components array of object
ID
 incident.components.id string

The identifier.
Name
 incident.components.name string

The name.
Status
 incident.components.status string

The status.
Show Uptime
 incident.components.showUptime boolean

Whether to show uptime.
Subdomain
 incident.components.site.subdomain string

The subdomain.
Logo URL
 incident.components.site.logoUrl string

The logo URL address.
Name
 incident.components.site.name string

The name.
Slack Integrations
 incident.components.site.slackIntegrations array of string

The Slack integrations.
Subscribers
 incident.components.site.subscribers array of string

The subscribers.
Subscribers
 incident.components.subscribers array of string

The subscribers.

Edit maintenance update

Operation ID:
MaintenanceUpdatePut

Edit an update for a maintenance on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Maintenance ID
 maintenance_id True string

The maintenance identifier.
Maintenance Update ID
 maintenance_update_id True string

The maintenance update identifier.
Message
 message string

The message.
Components
 components array of string

The components.
Started
 started string

When started.
End
 end string

The end.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
ID
 id string

The identifier.
Status
 status string

The status.

Returns

Name Path Type Description
ID
 id string

The identifier.
Message
 message string

The message.
Message HTML
 messageHtml string

The message HTML.
Notify
 notify boolean

Whether to notify.
Started
 started string

When started.
Status
 status string

The status.
ID
 maintenance.id string

The identifier.
Name
 maintenance.name string

The name.
Start
 maintenance.start string

The start.
Status
 maintenance.status string

The status.
Components
 maintenance.components array of object
ID
 maintenance.components.id string

The identifier.
Name
 maintenance.components.name string

The name.
Status
 maintenance.components.status string

The status.
Show Uptime
 maintenance.components.showUptime boolean

Whether to show uptime.
subscribers
 maintenance.components.subscribers array of string

The subscribers.
ID
 maintenance.components.site.id string

The identifier.
Name
 maintenance.components.site.name string

The name.
Subdomain
 maintenance.components.site.subdomain string

The subdomain.
Color
 maintenance.components.site.color string

The color.
Logo URL
 maintenance.components.site.logoUrl string

The logo URL address.
Public Email
 maintenance.components.site.publicEmail string

The public email address.
Subscribers
 maintenance.components.site.subscribers array of string

The subscribers.

Get component

Operation ID:
ComponentGet

Retrieve a component on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Component ID
 component_id True string

The component identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.
Name
 name string

The name.
Description
 description string

The description.
Status
 status string

The status.
Unique Email
 uniqueEmail string

The unique email address.
Show Uptime
 showUptime boolean

Whether to show uptime.
Order
 order integer

The order.
Group
 group string

The group.

Get incident

Operation ID:
IncidentGet

Retrieve an incident on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Incident ID
 incident_id True string

The incident identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.
Name
 name string

The name.
Status
 status string

The status.
Started
 started string

When started.
Resolved
 resolved string

When resolved.
Updates
 updates array of object
ID
 updates.id string

The identifier.
Message
 updates.message string

The message.
Message HTML
 updates.messageHtml string

The message HTML.
Status
 updates.status string

The status.
Notify
 updates.notify boolean

Whether to notify.
Started
 updates.started string

When started.
Ended
 updates.ended string

When ended.
Duration
 updates.duration string

The duration.
Created At
 updates.createdAt string

When created at.
Components
 components array of object
ID
 components.id string

The identifier.
Name
 components.name string

The name.
Status
 components.status string

The status.
Show Uptime
 components.showUptime boolean

Whether to show uptime.
ID
 components.site.id string

The identifier.
Name
 components.site.name string

The name.
Subdomain
 components.site.subdomain string

The subdomain.
Color
 components.site.color string

The color.
Logo URL
 components.site.logoUrl string

The logo URL address.
Public Email
 components.site.publicEmail string

The public email address.

Get incident update

Operation ID:
IncidentUpdateGet

Retrieve an update on a page incident.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Incident ID
 incident_id True string

The incident identifier.
Incident Update ID
 incident_update_id True string

The incident update identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.
Message
 message string

The message.
Message HTML
 messageHtml string

The message HTML.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
Started
 started string

When started.
ID
 incident.id string

The identifier.
Name
 incident.name string

The name.
Started
 incident.started string

When started.
Status
 incident.status string

The status.
Components
 incident.components array of object
ID
 incident.components.id string

The identifier.
Name
 incident.components.name string

The name.
Status
 incident.components.status string

The status.
Show Uptime
 incident.components.showUptime boolean

Whether to show uptime.
Subdomain
 incident.components.site.subdomain string

The subdomain.
Logo URL
 incident.components.site.logoUrl string

The logo URL address.
Name
 incident.components.site.name string

The name.
Slack Integrations
 incident.components.site.slackIntegrations array of string

The Slack integrations.
Subscribers
 incident.components.site.subscribers array of string

The subscribers.
Subscribers
 incident.components.subscribers array of string

The subscribers.

Get maintenance

Operation ID:
MaintenanceGet

Retrieve a maintenance for a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Maintenance ID
 maintenance_id True string

The maintenance identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.
Name
 name string

The name.
Status
 status string

The status.
Start
 start string

The start.
Duration
 duration integer

The duration.
Notify Start
 notifyStart boolean

Whether to notify start.
Notify End
 notifyEnd boolean

Whether to notify end.
Notify Early
 notifyEarly boolean

Whether to notify early.
Notify Minutes
 notifyMinutes integer

The notify minutes.
Auto Start
 autoStart boolean

Whether to auto start.
Auto End
 autoEnd boolean

Whether to auto end.
Updates
 updates array of object
ID
 updates.id string

The identifier.
Message
 updates.message string

The message.
Message HTML
 updates.messageHtml string

The message HTML.
Status
 updates.status string

The status.
Notify
 updates.notify boolean

Whether to notify.
Started
 updates.started string

When started.
Ended
 updates.ended string

When ended.
Duration
 updates.duration string

The duration.
Created At
 updates.createdAt string

When created at.
Components
 components array of object
ID
 components.id string

The identifier.
Name
 components.name string

The name.
Status
 components.status string

The status.
Show Uptime
 components.showUptime boolean

Whether to show uptime.
ID
 components.site.id string

The identifier.
Name
 components.site.name string

The name.
Subdomain
 components.site.subdomain string

The subdomain.
Color
 components.site.color string

The color.
Logo URL
 components.site.logoUrl string

The logo URL address.
Public Email
 components.site.publicEmail string

The public email address.

Get maintenance update

Operation ID:
MaintenanceUpdateGet

Retrieve an update for a maintenance on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Maintenance ID
 maintenance_id True string

The maintenance identifier.
Maintenance Update ID
 maintenance_update_id True string

The maintenance update identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.
Message
 message string

The message.
Message HTML
 messageHtml string

The message HTML.
Notify
 notify boolean

Whether to notify.
Started
 started string

When started.
Status
 status string

The status.
ID
 maintenance.id string

The identifier.
Name
 maintenance.name string

The name.
Start
 maintenance.start string

The start.
Status
 maintenance.status string

The status.
Components
 maintenance.components array of object
ID
 maintenance.components.id string

The identifier.
Name
 maintenance.components.name string

The name.
Status
 maintenance.components.status string

The status.
Show Uptime
 maintenance.components.showUptime boolean

Whether to show uptime.
ID
 maintenance.components.site.id string

The identifier.
Name
 maintenance.components.site.name string

The name.
Subdomain
 maintenance.components.site.subdomain string

The subdomain.
Color
 maintenance.components.site.color string

The color.
Logo URL
 maintenance.components.site.logoUrl string

The logo URL address.
Public Email
 maintenance.components.site.publicEmail string

The public email address.

Get page incidents

Operation ID:
IncidentsGet

Retrieve all incidents for a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Status
 status string

The status.
Page
 page integer

The page.
Number per Page
 per_page integer

The number per page.

Returns

Name Path Type Description
array of object
ID
 id string

The identifier.
Name
 name string

The name.
Started
 started string

When started.
Status
 status string

The status.
Resolved
 resolved string

When resolved.
Updates
 updates array of object
ID
 updates.id string

The identifier.
Message
 updates.message string

The message.
Message HTML
 updates.messageHtml string

The message HTML.
Status
 updates.status string

The status.
Notify
 updates.notify boolean

Whether to notify.
Started
 updates.started string

When started.
Ended
 updates.ended string

When ended.
Duration
 updates.duration string

The duration.
Created At
 updates.createdAt string

When created at.
Components
 components array of object
ID
 components.id string

The identifier.
Name
 components.name string

The name.
Status
 components.status string

The status.
Show Uptime
 components.showUptime boolean

Whether to show uptime.
ID
 components.site.id string

The identifier.
Name
 components.site.name string

The name.
Subdomain
 components.site.subdomain string

The subdomain.
Color
 components.site.color string

The color.
Logo URL
 components.site.logoUrl string

The logo URL address.
Public Email
 components.site.publicEmail string

The public email address.

Get page maintenances

Operation ID:
MaintenancesGet

Retrieve all maintenances for a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Page
 page integer

The page.
Number per Page
 per_page integer

The number per page.

Returns

Name Path Type Description
array of object
ID
 id string

The identifier.
Name
 name string

The name.
Status
 status string

The status.
Start
 start string

The start.
Duration
 duration integer

The duration.
Notify Start
 notifyStart boolean

Whether to notify start.
Notify End
 notifyEnd boolean

Whether to notify end.
Notify Early
 notifyEarly boolean

Whether to notify early.
Notify Minutes
 notifyMinutes integer

The notify minutes.
Auto Start
 autoStart boolean

Whether to auto start.
Auto End
 autoEnd boolean

Whether to auto end.
Updates
 updates array of object
ID
 updates.id string

The identifier.
Message
 updates.message string

The message.
Message HTML
 updates.messageHtml string

The message HTML.
Status
 updates.status string

The status.
Notify
 updates.notify boolean

Whether to notify.
Started
 updates.started string

When started.
Ended
 updates.ended string

When ended.
Duration
 updates.duration string

The duration.
Created At
 updates.createdAt string

When created at.
Components
 components array of object
ID
 components.id string

The identifier.
Name
 components.name string

The name.
Status
 components.status string

The status.
Show Uptime
 components.showUptime boolean

Whether to show uptime.
ID
 components.site.id string

The identifier.
Name
 components.site.name string

The name.
Subdomain
 components.site.subdomain string

The subdomain.
Color
 components.site.color string

The color.
Logo URL
 components.site.logoUrl string

The logo URL address.
Public Email
 components.site.publicEmail string

The public email address.

Get page templates

Operation ID:
PageTemplatesGet

Retrieve a list of all page templates.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Page
 page integer

The page.
Number per Page
 per_page integer

The number per page.

Returns

Name Path Type Description
array of object
ID
 id string

The identifier.
Type
 type string

The type.
Name
 name string

The name.
Name Translation ID
 nameTranslationId string

The name translation identifier.
Message
 message string

The message.
Message Translation ID
 messageTranslationId string

The message translation identifier.
Message HTML
 messageHtml string

The message HTML.
Message Html Translation ID
 messageHtmlTranslationId string

The message HTML translation identifier.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify .
Created At
 createdAt string

When created at.
Site ID
 siteId string

The site identifier.
Imported From Status Page
 importedFromStatuspage boolean

Whether imported from status page.
Deleted At
 deletedAt string

When deleted at.
Components
 components array of object
ID
 components.id string

The identifier.
Status
 components.status string

The status.
Component ID
 components.componentId string

The component identifier.
Template ID
 components.templateId string

The template identifier.
Imported From Status Page
 components.importedFromStatuspage boolean

Whether imported from status page.
Name
 translations.name string

The name.
Message
 translations.message string

The message.

Get status page components

Operation ID:
ComponentsGet

Retrieve a list of all your status page components.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Page
 page integer

The page.
Number per Page
 per_page integer

The number per page.

Returns

Name Path Type Description
array of object
ID
 id string

The identifier.
Name
 name string

The name.
Status
 status string

The status.
Unique Email
 uniqueEmail string

The unique email address.
Description
 description string

The description.
Show Uptime
 showUptime boolean

Whether to show uptime.
Order
 order integer

The order.
Group
 group string

The group.

Get status pages

Operation ID:
PagesGet

Retrieve a list of your status pages.

Parameters

Name Key Required Type Description
Page
 page integer

The page.
Number per Page
 per_page integer

The number per page.

Returns

Name Path Type Description
array of object
ID
 id string

The identifier.
Subdomain
 subdomain string

The subdomain.
Name
 name string

The name.
Logo URL
 logoUrl string

The logo URL address.
Favicon URL
 faviconUrl string

The favicon URL address.
Website URL
 websiteUrl string

The website URL address.
Custom Domain
 customDomain string

The custom domain.
Public Email
 publicEmail string

The public email.
Twitter
 twitter string

The Twitter handle.
Status
 status string

The status.
Subscribe By SMS
 subscribeBySms boolean

Whether subscribe by SMS is enabled.
Language
 language string

The language.
Use Large Header
 useLargeHeader boolean

Whether to use large header.
Brand Color
 brandColor string

The brand color.
OK Color
 okColor string

The OK color.
Disrupted Color
 disruptedColor string

The disrupted color.
Degraded Color
 degradedColor string

The degraded color.
Down Color
 downColor string

The down color.
Notice Color
 noticeColor string

The notice color.
Unknown Color
 unknownColor string

The unknown color.
Google Analytics
 googleAnalytics string

The Google Analytics.
SMS Service
 smsService string

The SMS service.
HTML In Meta
 htmlInMeta string

The HTML in meta.
HTML Above Header
 htmlAboveHeader string

The HTML above header.
HTML Below Header
 htmlBelowHeader string

The HTML below header.
HTML Above Footer
 htmlAboveFooter string

The HTML above footer.
HTML Below Footer
 htmlBelowFooter string

The HTML below footer.
HTML Below Summary
 htmlBelowSummary string

The HTML below summary.
Launch Date
 launchDate string

The launch date.
CSS Global
 cssGlobal string

The CSS global.
Onboarded
 onboarded string

The onboarded.
Created At
 createdAt string

When created at.
Updated At
 updatedAt string

When updated at.

Get subscribers

Operation ID:
SubscribersGet

Retrieve a list of subscribers for a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Page
 page integer

The page.
Number per Page
 per_page integer

The number per page.

Returns

Name Path Type Description
array of object
ID
 id string

The identifier.
Email
 email string

The email address.
Phone
 phone string

The phone number.
Webhook
 webhook string

The webhook.
Webhook Email
 webhookEmail string

The webhook email address.
Confirmed
 confirmed boolean

Whether confirmed.
All
 all boolean

Whether all.
Components
 components array of string

The components.

Get teammates

Operation ID:
TeammatesGet

Retrieve a list of teammates.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Page
 page integer

The page.
Number per Page
 per_page integer

The number per page.

Returns

Name Path Type Description
array of object
ID
 id string

The identifier.
ID
 user.id string

The identifier.
Name
 user.name string

The name.
Email
 user.email string

The email address.
Avatar
 user.avatar string

The avatar.

Get template

Operation ID:
TemplateGet

Retrieve a template for a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Template ID
 template_id True string

The template identifier.

Returns

Name Path Type Description
ID
 id string

The identifier.
Type
 type string

The type.
Name
 name string

The name.
Name Translation ID
 nameTranslationId string

The name translation identifier.
Message
 message string

The message.
Message Translation ID
 messageTranslationId string

The message translation identifier.
Message HTML
 messageHtml string

The message HTML.
Message HTML Translation ID
 messageHtmlTranslationId string

The message HTML translation identifier.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
Created At
 createdAt string

When created at.
Site ID
 siteId string

The site identifier.
Imported From Status Page
 importedFromStatuspage boolean

Whether imported from status page.
Deleted At
 deletedAt string

When deleted at.
Components
 components array of string

The components.
Name
 translations.name string

The name.
Message
 translations.message string

The message.

Remove subscriber

Operation ID:
SubscriberDelete

Remove a subscriber from a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Subscriber ID
 subscriber_id True string

The subscriber ID.

Returns

response
string

Resolve incident with template

Operation ID:
IncidentUpdateTemplatePost

Resolves an incident on a page with a template.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Incident ID
 incident_id True string

The incident identifier.
Template
 template True string

The template.

Returns

Name Path Type Description
ID
 id string

The identifier.
Message
 message string

The message.
Message Translation ID
 messageTranslationId string

The message translation identifier.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
Started
 started string

When started.
Ended
 ended string

When ended.
Duration
 duration string

The duration.
Created At
 createdAt string

When created at.
Updated At
 updatedAt string

When updated at.
Incident ID
 incidentId string

The incident identifier.
Message HTML
 messageHtml string

The message HTML.
Message HTML Translation ID
 messageHtmlTranslationId string

The message HTML translation identifier.
Imported From Status Page
 importedFromStatuspage boolean

Whether .

Update component

Operation ID:
ComponentPut

Updates a component on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Component ID
 component_id True string

The component identifier.
Name
 name string

The name.
Description
 description string

The description.
Status
 status string

The status.
Order
 order integer

The order.
Show Uptime
 showUptime boolean

Whether to show uptime.
Grouped
 grouped boolean

Whether grouped.

Returns

Name Path Type Description
ID
 id string

The identifier.
Name
 name string

The name.
Unique Email
 uniqueEmail string

The unique email address.
Status
 status string

The status.
Description
 description string

The description.
Show Uptime
 showUptime boolean

Whether to show uptime.
Order
 order integer

The order.
Group
 group string

The group.

Update incident

Operation ID:
IncidentPut

Updates an incident on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Incident ID
 incident_id True string

The incident identifier.
Name
 name string

The name.
Components
 components array of string

The components.
Started
 started string

When started.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
ID
 id string

The identifier.
Status
 status string

The status.

Returns

Name Path Type Description
ID
 id string

The identifier.
Name
 name string

The name.
Status
 status string

The status.
Started
 started string

When started.
Resolved
 resolved string

When resolved.
Updates
 updates array of string

The updates.
Components
 components array of object
ID
 components.id string

The identifier.
Name
 components.name string

The name.
Status
 components.status string

The status.
Show Uptime
 components.showUptime boolean

Whether to show uptime.
ID
 components.site.id string

The identifier.
Name
 components.site.name string

The name.
Subdomain
 components.site.subdomain string

The subdomain.
Color
 components.site.color string

The color.
Logo URL
 components.site.logoUrl string

The logo URL address.
Public Email
 components.site.publicEmail string

The public email address.

Update maintenance

Operation ID:
MaintenancePut

Updates a maintenance on a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Maintenance ID
 maintenance_id True string

The maintenance identifier.
Name
 name string

The name.
Message
 message string

The message.
Components
 components array of string

The components.
Start
 start string

The start.
End
 end string

The end.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
ID
 id string

The identifier.
Status
 status string

The status.

Returns

Name Path Type Description
ID
 id string

The identifier.
Name
 name string

The name.
Status
 status string

The status.
Start
 start string

The start.
Duration
 duration string

The duration.
Updates
 updates array of object
ID
 updates.id string

The identifier.
Message
 updates.message string

The message.
Message HTML
 updates.messageHtml string

The message HTML.
Status
 updates.status string

The status.
Notify
 updates.notify boolean

Whether to notify.
Started
 updates.started string

When started.
Ended
 updates.ended string

When ended.
Duration
 updates.duration string

The duration.
Created At
 updates.createdAt string

When created at.
Components
 components array of object
ID
 components.id string

The identifier.
Name
 components.name string

The name.
Status
 components.status string

The status.
Show Uptime
 components.showUptime boolean

Whether to show uptime.
ID
 components.site.id string

The identifier.
Name
 components.site.name string

The name.
Subdomain
 components.site.subdomain string

The subdomain.
Color
 components.site.color string

The color.
Logo URL
 components.site.logoUrl string

The logo URL address.
Public Email
 components.site.publicEmail string

The public email address.

Update status page

Operation ID:
PagePut

Update a created status page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
ID
 id string

The identifier.
Name
 name string

The name.
Status
 status string

The status.
Subdomain
 subdomain string

The subdomain.
Logo URL
 logoUrl string

The logo URL address.
Favicon URL
 faviconUrl string

The favicon URL address.
Website URL
 websiteUrl string

The website URL address.
Language
 language string

The language.
Public Email
 publicEmail string

The public email address.
Use Large Header
 useLargeHeader boolean

Whether to use large header.
Brand Color
 brandColor string

The brand color.
OK Color
 okColor string

The OK color.
Disrupted Color
 disruptedColor string

The disrupted color.
Degraded Color
 degradedColor string

The degraded color.
Down Color
 downColor string

The down color.
Notice Color
 noticeColor string

The notice color.
Unknown Color
 unknownColor string

The unknown color.
Google Analytics
 googleAnalytics string

The Google Analytics.
Subscribe By SMS
 subscribeBySms boolean

Whether to subscribe by SMS.
SMS Service
 smsService string

The SMS service.
Twilio SID
 twilioSid string

The Twilio SID.
Twilio Token
 twilioToken string

The Twilio token.
Twilio Sender
 twilioSender string

The Twilio sender.
HTML In Meta
 htmlInMeta string

The HTML in meta.
HTML Above Header
 htmlAboveHeader string

The HTML above header.
HTML Below Header
 htmlBelowHeader string

The HTML below header.
HTML Above Footer
 htmlAboveFooter string

The HTML above footer.
HTML Below Footer
 htmlBelowFooter string

The HTML below footer.
HTML Below Summary
 htmlBelowSummary string

The HTML below summary.
CSS Global
 cssGlobal string

The CSS global.
Launch Date
 launchDate string

The launch date.
Date Format
 dateFormat string

The date format.
Date Format Short
 dateFormatShort string

The date format short.
Time Format
 timeFormat string

The time format.
Private
 private boolean

Whether private.
Use Allow List
 useAllowList boolean

Whether to use allow list.

Returns

Name Path Type Description
ID
 id string

The identifier.
Created At
 createdAt string

When created at.
Subdomain
 subdomain string

The subdomain.
Name
 name string

The name.
Status
 status string

The status.
Logo URL
 logoUrl string

The logo URL address.
Favicon URL
 faviconUrl string

The favicon URL address.
Website URL
 websiteUrl string

The website URL address.
Color
 color string

The color.
Language
 language string

The language.
Google Analytics
 googleAnalytics string

The Google Analytics.
Public Email
 publicEmail string

The public email address.
Custom Domain
 customDomain string

The custom domain.
Use Large Header
 useLargeHeader boolean

Whether to use large header.
Disable Dark Mode
 disableDarkMode string

The disabled dark mode.
Twitter
 twitter string

The Twitter handle.
Subscribe By SMS
 subscribeBySms string

The subscribe by SMS.
Brand Color
 brandColor string

The brand color.
OK Color
 okColor string

The OK color.
Disrupted Color
 disruptedColor string

The disrupted color.
Down Color
 downColor string

The down color.
Degraded Color
 degradedColor string

The degraded color.
Notice Color
 noticeColor string

The notice color.
HTML In Meta
 htmlInMeta string

The HTML in meta.
HTML Above Header
 htmlAboveHeader string

The HTML above header.
HTML Below Header
 htmlBelowHeader string

The HTML below header.
HTML Above Footer
 htmlAboveFooter string

The HTML above footer.
HTML Below Footer
 htmlBelowFooter string

The HTML below footer.
HTML Below Summary
 htmlBelowSummary string

The HTML below summary.
CSS Global
 cssGlobal string

The CSS global.
Onboarded
 onboarded string

The onboarded.
Launch Date
 launchDate string

The launch date.
Date Format
 dateFormat string

The date format.
Date Format Short
 dateFormatShort string

The date format short.
Time Format
 timeFormat string

The time format.
Private
 private boolean

Whether private.
Use Allow List
 useAllowList boolean

Whether to use allow list.
Allow List
 allowList array of

The allow list.
Components
 components array of object
ID
 components.id string

The identifier.
Name
 components.name string

The name.
Status
 components.status string

The status.
Show Uptime
 components.showUptime boolean

Whether to show uptime.
Order
 components.order string

The order.
Group
 components.group string

The group.
Incidents
 components.incidents array of string

The incidents.

Update template

Operation ID:
TemplatePut

Updates a template for a page.

Parameters

Name Key Required Type Description
Page ID
 page_id True string

The page identifier.
Template ID
 template_id True string

The template identifier.
Type
 type string

The type.
Name
 name string

The name.
Message
 message string

The message.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
ID
 id string

The identifier.
Status
 status string

The status.

Returns

Name Path Type Description
ID
 id string

The identifier.
Type
 type string

The type.
Name
 name string

The name.
Name Translation ID
 nameTranslationId string

The name translation identifier.
Message
 message string

The message.
Message Translation ID
 messageTranslationId string

The message translation identifier.
Message HTML
 messageHtml string

The message HTML.
Message HTML Translation ID
 messageHtmlTranslationId string

The message HTML translation identifier.
Status
 status string

The status.
Notify
 notify boolean

Whether to notify.
Created At
 createdAt string

When created at.
Site ID
 siteId string

The site identifier.
Imported From Status Page
 importedFromStatuspage boolean

Whether imported from status page.
Deleted At
 deletedAt string

When deleted at.
Components
 components array of object
ID
 components.id string

The identifier.
Status
 components.status string

The status.
Component ID
 components.componentId string

The component identifier.
Template ID
 components.templateId string

The template identifier.
Imported From Status Page
 components.importedFromStatuspage boolean

Whether imported from status page.
Name
 translations.name string

The name.
Message
 translations.message string

The message.

Definitions

string

This is the basic data type 'string'.