add_components_to_page_access_group
Add components to page access group
Parameters
page_access_group_id (required)
Page Access Group Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Add components to page access group
Type: object
{
"component_ids" : [ "string" ]
}
add_components_to_page_access_user
Add components for page access user
Parameters
page_access_user_id (required)
Page Access User Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Type: object
{
"component_ids" : [ "string" ]
}
add_data_points_to_metrics
Add data points to metrics
Parameters
page_id (required)
Page identifier
Type: string
$body
Add data points to metrics
Type: object
{
"data" : {
"metric_id" : {
"value" : "number",
"timestamp" : "integer"
}
}
}
add_data_to_metric
Add data to a metric
Parameters
metric_id (required)
Metric Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Add data to a metric
Type: object
{
"data" : {
"value" : "number",
"timestamp" : "Time to store the metric against"
}
}
add_page_access_group_to_component
Add page access groups to a component
Parameters
component_id (required)
Component Identifier
Type: string
page_id (required)
Page identifier
Type: string
add_page_access_user
Add a page access user
Parameters
page_id (required)
Page identifier
Type: string
$body
Add a page access user
Type: object
{
"page_access_user" : {
"email" : "string",
"page_access_group_ids" : [ "string" ]
}
}
add_page_access_user_to_component
Add page access users to a component
Parameters
component_id (required)
Component Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Type: object
{
"page_access_user_ids" : [ "string" ]
}
create_component
Create a component
Parameters
page_id (required)
Page identifier
Type: string
$body
Create a component
Type: object
{
"component" : {
"group_id" : "Component Group identifier",
"name" : "Display name for component",
"description" : "More detailed description for component",
"showcase" : "Should this component be showcased",
"only_show_if_degraded" : "Requires a special feature flag to be enabled",
"status" : "Status of component"
}
}
create_component_group
Create a component group
Parameters
page_id (required)
Page identifier
Type: string
$body
Create a component group
Type: object
{
"description" : "Description of the component group.",
"component_group" : {
"components" : [ "string" ],
"name" : "Required string"
}
}
create_incident
Create an incident
Parameters
page_id (required)
Page identifier
Type: string
$body
Create an incident
Type: object
{
"incident" : {
"scheduled_auto_in_progress" : "Controls whether the incident is scheduled to automatically change to in progress.",
"impact_override" : "value to override calculated impact value",
"metadata" : { },
"components" : {
"component_id" : "Map of status changes to apply to affected components"
},
"scheduled_remind_prior" : "Controls whether to remind subscribers prior to scheduled incidents.",
"scheduled_auto_transition" : "Same as :scheduled_auto_transition_in_progress. Controls whether the incident is scheduled to automatically change to in progress.",
"scheduled_for" : "The timestamp the incident is scheduled for.",
"auto_transition_to_operational_state" : "Controls whether change components status to operational once scheduled maintenance completes.",
"backfilled" : "Controls whether incident is backfilled. If true, components cannot be specified.",
"body" : "The initial message, created as the first incident update.",
"deliver_notifications" : "Deliver notifications to subscribers if this is true. If this is false, create an incident without notifying customers.",
"component_ids" : [ "string" ],
"auto_tweet_on_creation" : "Controls whether tweet automatically when scheduled maintenance is created.",
"auto_tweet_on_completion" : "Controls whether tweet automatically when scheduled maintenance completes.",
"auto_tweet_one_hour_before" : "Controls whether tweet automatically one hour before scheduled maintenance starts.",
"backfill_date" : "TimeStamp when incident was backfilled.",
"name" : "Incident Name",
"auto_transition_to_maintenance_state" : "Controls whether change components status to under_maintenance once scheduled maintenance is in progress.",
"auto_tweet_at_beginning" : "Controls whether tweet automatically when scheduled maintenance starts.",
"scheduled_auto_completed" : "Controls whether the incident is scheduled to automatically change to complete.",
"auto_transition_deliver_notifications_at_start" : "Controls whether send notification when scheduled maintenances auto transition to started.",
"scheduled_until" : "The timestamp the incident is scheduled until.",
"auto_transition_deliver_notifications_at_end" : "Controls whether send notification when scheduled maintenances auto transition to completed.",
"status" : "Incident status"
}
}
create_incident_subscriber
Create an incident subscriber
Parameters
incident_id (required)
Incident Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Create an incident subscriber
Type: object
{
"phone_country" : "The two-character country where the phone number is located to use for the new SMS subscriber.",
"phone_number" : "The phone number (as you would dial from the phone_country) to use for the new SMS subscriber.",
"skip_confirmation_notification" : "If skip_confirmation_notification is true, the subscriber does not receive any notifications when their subscription changes. Email subscribers will be automatically opted in. This option is only available for paying customers. This option has no effect for trial customers.",
"email" : "The email address for creating Email subscribers."
}
create_metric_for_metric_provider
Create a metric for a metric provider
Parameters
metrics_provider_id (required)
Metric Provider Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Create a metric for a metric provider
Type: object
{
"metric" : {
"transform" : "The transform to apply to metric before pulling into Statuspage. One of: \"average\", \"count\", \"max\", \"min\", or \"sum\"",
"y_axis_hidden" : "Should the values on the y axis be hidden on render",
"display" : "Should the metric be displayed",
"name" : "Name of metric",
"y_axis_max" : "The upper bound of the y axis",
"suffix" : "Suffix to describe the units on the graph",
"y_axis_min" : "The lower bound of the y axis",
"tooltip_description" : "string",
"metric_identifier" : "The identifier used to look up the metric data from the provider",
"decimal_places" : "How many decimal places to render on the graph"
}
}
create_metric_provider
Create a metric provider
Parameters
page_id (required)
Page identifier
Type: string
$body
Create a metric provider
Type: object
{
"metrics_provider" : {
"password" : "Required by the Pingdom-type metrics provider.",
"api_key" : "Required by the Datadog and NewRelic type metrics providers.",
"api_token" : "Required by the Librato and Datadog type metrics providers.",
"type" : "One of \"Pingdom\", \"NewRelic\", \"Librato\", \"Datadog\", or \"Self\"",
"application_key" : "Required by the Pingdom-type metrics provider.",
"email" : "Required by the Librato and Pingdom type metrics providers."
}
}
create_page_access_group
Create a page access group
Parameters
page_id (required)
Page identifier
Type: string
$body
Create a page access group
Type: object
{
"page_access_group" : {
"external_identifier" : "Associates group with external group.",
"name" : "Name for this Group.",
"metric_ids" : [ "string" ],
"component_ids" : [ "string" ],
"page_access_user_ids" : [ "string" ]
}
}
create_postmortem_for_incident
Create Postmortem
Parameters
incident_id (required)
Incident Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Create Postmortem
Type: object
{
"postmortem" : {
"body_draft" : "Body of Postmortem to create."
}
}
create_subscriber
Create a subscriber
Parameters
page_id (required)
Page identifier
Type: string
$body
Create a subscriber
Type: object
{
"subscriber" : {
"page_access_user" : "The code of the page access user to which the subscriber belongs.",
"endpoint" : "The endpoint URI for creating Webhook subscribers.",
"phone_country" : "The two-character country where the phone number is located to use for the new SMS subscriber.",
"phone_number" : "The phone number (as you would dial from the phone_country) to use for the new SMS subscriber.",
"skip_confirmation_notification" : "If skip_confirmation_notification is true, the subscriber does not receive any notifications when their subscription changes. Email subscribers will be automatically opted in. This option is only available for paying customers. This option has no effect for trial customers.",
"component_ids" : [ "string" ],
"email" : "The email address for creating Email and Webhook subscribers."
}
}
create_user_in_organization
Create a user
Parameters
organization_id (required)
Organization Identifier
Type: string
$body
Create a user
Type: object
{
"user" : {
"password" : "Password the team member uses to access the site",
"last_name" : "string",
"first_name" : "string",
"email" : "Email address for the team member"
}
}
delete_all_components_for_page_access_user
Remove components for page access user
Parameters
page_access_user_id (required)
Page Access User Identifier
Type: string
page_id (required)
Page identifier
Type: string
delete_all_components_from_page_access_group
Delete components for a page access group
Parameters
page_access_group_id (required)
Page Access Group Identifier
Type: string
page_id (required)
Page identifier
Type: string
delete_all_metrics_for_page_access_user
Delete metrics for page access user
Parameters
page_access_user_id (required)
Page Access User Identifier
Type: string
page_id (required)
Page identifier
Type: string
delete_all_page_access_groups_from_component
Remove page access groups from a component
Parameters
component_id (required)
Component Identifier
Type: string
page_id (required)
Page identifier
Type: string
delete_all_page_access_users_from_component
Remove page access users from component
Parameters
component_id (required)
Component Identifier
Type: string
page_id (required)
Page identifier
Type: string
delete_component
Delete a component
Parameters
component_id (required)
Component Identifier
Type: string
page_id (required)
Page identifier
Type: string
delete_component_for_page_access_user
Remove component for page access user
Parameters
component_id (required)
Component identifier
Type: string
page_access_user_id (required)
Page Access User Identifier
Type: string
page_id (required)
Page identifier
Type: string
delete_component_from_page_access_group
Remove a component from a page access group
Parameters
component_id (required)
Component identifier
Type: string
page_access_group_id (required)
Page Access Group Identifier
Type: string
page_id (required)
Page identifier
Type: string
delete_component_group
Delete a component group
Parameters
id (required)
Type: integer
page_id (required)
Page identifier
Type: string
delete_incident
Delete an incident
Parameters
incident_id (required)
Incident Identifier
Type: string
page_id (required)
Page identifier
Type: string
delete_metric
Delete a metric
Parameters
metric_id (required)
Metric Identifier
Type: string
page_id (required)
Page identifier
Type: string
delete_metric_for_page_access_user
Delete metric for page access user
Parameters
metric_id (required)
Identifier of metric requested
Type: string
page_access_user_id (required)
Page Access User Identifier
Type: string
page_id (required)
Page identifier
Type: string
delete_metric_provider
Delete a metric provider
Parameters
metrics_provider_id (required)
Metric Provider Identifier
Type: string
page_id (required)
Page identifier
Type: string
delete_page_access_group
Remove a page access group
Parameters
page_access_group_id (required)
Page Access Group Identifier
Type: string
page_id (required)
Page identifier
Type: string
delete_page_access_user
Delete page access user
Parameters
page_access_user_id (required)
Page Access User Identifier
Type: string
page_id (required)
Page identifier
Type: string
delete_postmortem_from_incident
Delete Postmortem
Parameters
incident_id (required)
Incident Identifier
Type: string
page_id (required)
Page identifier
Type: string
delete_user_from_organization
Delete a user
Parameters
organization_id (required)
Organization Identifier
Type: string
user_id (required)
User Identifier
Type: string
get_component
Get a component
Parameters
component_id (required)
Component Identifier
Type: string
page_id (required)
Page identifier
Type: string
get_component_group
Get a component group
Parameters
id (required)
Type: integer
page_id (required)
Page identifier
Type: string
get_incident
Get an incident
Parameters
incident_id (required)
Incident Identifier
Type: string
page_id (required)
Page identifier
Type: string
get_metric
Get a metric
Parameters
metric_id (required)
Metric Identifier
Type: string
page_id (required)
Page identifier
Type: string
get_metric_provider
Get a metric provider
Parameters
metrics_provider_id (required)
Metric Provider Identifier
Type: string
page_id (required)
Page identifier
Type: string
get_page
Get a page
Parameters
page_id (required)
Page identifier
Type: string
get_page_access_group
Get a page access group
Parameters
page_access_group_id (required)
Page Access Group Identifier
Type: string
page_id (required)
Page identifier
Type: string
get_page_access_user
Get page access user
Parameters
page_access_user_id (required)
Page Access User Identifier
Type: string
page_id (required)
Page identifier
Type: string
get_postmortem_for_incident
Get Postmortem
Parameters
incident_id (required)
Incident Identifier
Type: string
page_id (required)
Page identifier
Type: string
get_status_embed_config
Get status embed config settings
Parameters
page_id (required)
Page identifier
Type: string
get_subscriber_for_incident
Get an incident subscriber
Parameters
incident_id (required)
Incident Identifier
Type: string
page_id (required)
Page identifier
Type: string
subscriber_id (required)
Subscriber Identifier
Type: string
get_subscribers
Get a subscriber
Parameters
page_id (required)
Page identifier
Type: string
subscriber_id (required)
Subscriber Identifier
Type: string
get_subscribers_count
Get a count of subscribers by type
Parameters
page_id (required)
Page identifier
Type: string
state
If this is present, only count subscribers in this state. Specify state "all" to count subscribers in any states.
Type: string
Potential values: active, unconfirmed, quarantined, all
type
If this is present, only count subscribers of this type.
Type: string
Potential values: email, sms, webhook, integration_partner
get_subscribers_histogram_by_state
Get a histogram of subscribers by type and then state
Parameters
page_id (required)
Page identifier
Type: string
list_active_maintenance_incidents
Get a list of active maintenances
Parameters
page_id (required)
Page identifier
Type: string
list_component_groups
Get a list of component groups
Parameters
page_id (required)
Page identifier
Type: string
list_components
Get a list of components
Parameters
page_id (required)
Page identifier
Type: string
list_components_for_page_access_group
List components for a page access group
Parameters
page_access_group_id (required)
Page Access Group Identifier
Type: string
page_id (required)
Page identifier
Type: string
list_components_for_page_access_user
Get components for page access user
Parameters
page_access_user_id (required)
Page Access User Identifier
Type: string
page_id (required)
Page identifier
Type: string
list_incident_templates
Get a list of incident templates
Parameters
page_id (required)
Page identifier
Type: string
list_incidents
Get a list of incidents
Parameters
page_id (required)
Page identifier
Type: string
q
If this is specified, search for the text query string in the incidents' name, status, postmortem_body, and incident_updates fields.
Type: string
list_metric_providers
Get a list of metric providers
Parameters
page_id (required)
Page identifier
Type: string
list_metrics
Get a list of metrics
Parameters
page_id (required)
Page identifier
Type: string
list_metrics_for_metric_provider
List metrics for a metric provider
Parameters
metrics_provider_id (required)
Metric Provider Identifier
Type: string
page_id (required)
Page identifier
Type: string
list_metrics_for_page_access_user
Get metrics for page access user
Parameters
page_access_user_id (required)
Page Access User Identifier
Type: string
page_id (required)
Page identifier
Type: string
list_page_access_groups
Get a list of page access groups
Parameters
page_id (required)
Page identifier
Type: string
list_page_access_users
Get a list of page access users
Parameters
page_id (required)
Page identifier
Type: string
Email address to search for
Type: string
list_pages
This operation has no parameters
list_scheduled_incidents
Get a list of scheduled incidents
Parameters
page_id (required)
Page identifier
Type: string
list_subscribers
Get a list of subscribers
Parameters
page_id (required)
Page identifier
Type: string
q
If this is specified, search the contact information (email, endpoint, or phone number) for the provided value.
Type: string
sort_direction
The sort direction of the listing.
Type: string
Potential values: asc, desc
sort_field
The field on which to sort: 'primary' to indicate sorting by the identifying field, 'created_at' for sorting by creation timestamp, 'quarantined_at' for sorting by quarantine timestamp, and 'relevance' which sorts by the relevancy of the search text. 'relevance' is not a valid parameter if no search text is supplied.
Type: string
Potential values: primary, created_at, quarantined_at, relevance
state
If this is present, only return subscribers in this state. Specify state "all" to find subscribers in any states.
Type: string
Potential values: active, unconfirmed, quarantined, all
type
If specified, only return subscribers of the indicated type.
Type: string
Potential values: email, sms, webhook, integration_partner
list_subscribers_for_incident
Get a list of incident subscribers
Parameters
incident_id (required)
Incident Identifier
Type: string
page_id (required)
Page identifier
Type: string
list_unresolved_incidents
Get a list of unresolved incidents
Parameters
page_id (required)
Page identifier
Type: string
list_unsubscribed_subscribers
Get a list of unsubscribed subscribers
Parameters
page_id (required)
Page identifier
Type: string
list_upcoming_incidents
Get a list of upcoming incidents
Parameters
page_id (required)
Page identifier
Type: string
list_users_for_organization
Get a list of users
Parameters
organization_id (required)
Organization Identifier
Type: string
publish_postmortem_for_incident
Publish Postmortem
Parameters
incident_id (required)
Incident Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Publish Postmortem
Type: object
{
"postmortem" : {
"notify_subscribers" : "Whether to notify e-mail subscribers",
"notify_twitter" : "Whether to notify Twitter followers",
"custom_tweet" : "Custom postmortem tweet to publish"
}
}
reactivate_subscriber
Reactivate a list of subscribers
Parameters
page_id (required)
Page identifier
Type: string
$body
Reactivate a list of subscribers
Type: object
{
"subscribers" : "The array of subscriber codes to reactivate, or \"all\" to reactivate all subscribers.",
"type" : "If this is present, only reactivate subscribers of this type."
}
replace_component
Update a component
Parameters
component_id (required)
Component Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Update a component
Type: object
{
"component" : {
"group_id" : "Component Group identifier",
"name" : "Display name for component",
"description" : "More detailed description for component",
"showcase" : "Should this component be showcased",
"only_show_if_degraded" : "Requires a special feature flag to be enabled",
"status" : "Status of component"
}
}
replace_component_group
Update a component group
Parameters
id (required)
Type: integer
page_id (required)
Page identifier
Type: string
$body
Update a component group
Type: object
{
"description" : "Updated description of the component group.",
"component_group" : {
"components" : [ "string" ],
"name" : "Required string"
}
}
replace_components_for_page_access_group
Replace components for a page access group
Parameters
page_access_group_id (required)
Page Access Group Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Replace components for a page access group
Type: object
{
"component_ids" : [ "string" ]
}
replace_components_for_page_access_user
Replace components for page access user
Parameters
page_access_user_id (required)
Page Access User Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Type: object
{
"component_ids" : [ "string" ]
}
replace_incident
Update an incident
Parameters
incident_id (required)
Incident Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Update an incident
Type: object
{
"incident" : {
"scheduled_auto_in_progress" : "Controls whether the incident is scheduled to automatically change to in progress.",
"impact_override" : "value to override calculated impact value",
"metadata" : { },
"components" : {
"component_id" : "Map of status changes to apply to affected components"
},
"scheduled_remind_prior" : "Controls whether to remind subscribers prior to scheduled incidents.",
"scheduled_auto_transition" : "Same as :scheduled_auto_transition_in_progress. Controls whether the incident is scheduled to automatically change to in progress.",
"scheduled_for" : "The timestamp the incident is scheduled for.",
"auto_transition_to_operational_state" : "Controls whether change components status to operational once scheduled maintenance completes.",
"backfilled" : "Controls whether incident is backfilled. If true, components cannot be specified.",
"body" : "The initial message, created as the first incident update.",
"deliver_notifications" : "Deliver notifications to subscribers if this is true. If this is false, create an incident without notifying customers.",
"component_ids" : [ "string" ],
"auto_tweet_on_creation" : "Controls whether tweet automatically when scheduled maintenance is created.",
"auto_tweet_on_completion" : "Controls whether tweet automatically when scheduled maintenance completes.",
"auto_tweet_one_hour_before" : "Controls whether tweet automatically one hour before scheduled maintenance starts.",
"backfill_date" : "TimeStamp when incident was backfilled.",
"name" : "Incident Name",
"auto_transition_to_maintenance_state" : "Controls whether change components status to under_maintenance once scheduled maintenance is in progress.",
"auto_tweet_at_beginning" : "Controls whether tweet automatically when scheduled maintenance starts.",
"scheduled_auto_completed" : "Controls whether the incident is scheduled to automatically change to complete.",
"auto_transition_deliver_notifications_at_start" : "Controls whether send notification when scheduled maintenances auto transition to started.",
"scheduled_until" : "The timestamp the incident is scheduled until.",
"auto_transition_deliver_notifications_at_end" : "Controls whether send notification when scheduled maintenances auto transition to completed.",
"status" : "Incident status"
}
}
replace_incident_update_for_incident
Update a previous incident update
Parameters
incident_id (required)
Incident Identifier
Type: string
incident_update_id (required)
Incident Update Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Update a previous incident update
Type: object
{
"incident_update" : {
"wants_twitter_update" : "Controls whether to create twitter update.",
"body" : "Incident update body.",
"display_at" : "Timestamp when incident update is happened.",
"deliver_notifications" : "Controls whether to delivery notifications."
}
}
replace_metric
Update a metric
Parameters
metric_id (required)
Metric Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Update a metric
Type: object
{
"metric" : {
"name" : "Name of metric"
}
}
replace_metrics_for_page_access_user
Replace metrics for page access user
Parameters
page_access_user_id (required)
Page Access User Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Replace metrics for page access user
Type: object
{
"metric_ids" : [ "string" ]
}
replace_metrics_for_page_access_user_put
Add metrics for page access user
Parameters
page_access_user_id (required)
Page Access User Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Add metrics for page access user
Type: object
{
"metric_ids" : [ "string" ]
}
replace_metrics_provider
Update a metric provider
Parameters
metrics_provider_id (required)
Metric Provider Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Update a metric provider
Type: object
{
"metrics_provider" : {
"account_id" : "string",
"api_key" : "string",
"api_token" : "string",
"type" : "string",
"application_key" : "string",
"email" : "string"
}
}
replace_page
Update a page
Parameters
page_id (required)
Page identifier
Type: string
$body
Update a page
Type: object
{
"page" : {
"css_link_color" : "CSS Color",
"allow_sms_subscribers" : "Can your users choose to receive notifications via SMS",
"branding" : "The main template your statuspage will use",
"css_yellows" : "CSS Color",
"css_graph_color" : "CSS Color",
"css_reds" : "CSS Color",
"notifications_email_footer" : "Allows you to customize the footer appearing on your notification emails. Accepts Markdown for formatting",
"allow_incident_subscribers" : "Can your users subscribe to notifications for a single incident",
"notifications_from_email" : "Allows you to customize the email address your page notifications come from",
"css_blues" : "CSS Color",
"css_body_background_color" : "CSS Color",
"allow_email_subscribers" : "Can your users choose to receive notifications via email",
"css_oranges" : "CSS Color",
"css_light_font_color" : "CSS Color",
"hidden_from_search" : "Should your page hide itself from search engines",
"time_zone" : "Timezone configured for your page",
"url" : "Website of your page. Clicking on your statuspage image will link here.",
"viewers_must_be_team_members" : "boolean",
"allow_webhook_subscribers" : "Can your users choose to receive notifications via Webhooks",
"domain" : "CNAME alias for your status page",
"name" : "Name of your page to be displayed",
"css_greens" : "CSS Color",
"subdomain" : "Subdomain at which to access your status page",
"css_border_color" : "CSS Color",
"css_font_color" : "CSS Color",
"allow_page_subscribers" : "Can your users subscribe to all notifications on the page",
"allow_rss_atom_feeds" : "Can your users choose to access incident feeds via RSS/Atom"
}
}
replace_page_access_group
Update a page access group
Parameters
page_access_group_id (required)
Page Access Group Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Update a page access group
Type: object
{
"page_access_group" : {
"external_identifier" : "Associates group with external group.",
"name" : "Name for this Group.",
"metric_ids" : [ "string" ],
"component_ids" : [ "string" ],
"page_access_user_ids" : [ "string" ]
}
}
replace_page_access_user
Update page access user
Parameters
page_access_user_id (required)
Page Access User Identifier
Type: string
page_id (required)
Page identifier
Type: string
replace_status_embed_config
Update status embed config settings
Parameters
page_id (required)
Page identifier
Type: string
$body
Update status embed config settings
Type: object
{
"status_embed_config" : {
"incident_background_color" : "Color of status embed iframe background when displaying incident",
"maintenance_background_color" : "Color of status embed iframe background when displaying maintenance",
"position" : "Corner where status embed iframe will appear on page",
"incident_text_color" : "Color of status embed iframe text when displaying incident",
"maintenance_text_color" : "Color of status embed iframe text when displaying maintenance"
}
}
resend_confirmation_for_incident_subscriber
Resend confirmation to an incident subscriber
Parameters
incident_id (required)
Incident Identifier
Type: string
page_id (required)
Page identifier
Type: string
subscriber_id (required)
Subscriber Identifier
Type: string
resend_confirmation_to_many_subscribers
Resend confirmations to a list of subscribers
Parameters
page_id (required)
Page identifier
Type: string
$body
Resend confirmations to a list of subscribers
Type: object
{
"subscribers" : "The array of subscriber codes to resend confirmations for, or \"all\" to resend confirmations to all subscribers. Only unconfirmed email subscribers will receive this notification."
}
resend_confirmation_to_subscriber
Resend confirmation to a subscriber
Parameters
page_id (required)
Page identifier
Type: string
subscriber_id (required)
Subscriber Identifier
Type: string
reset_data_for_metric
Reset data for a metric
Parameters
metric_id (required)
Metric Identifier
Type: string
page_id (required)
Page identifier
Type: string
revert_postmortem_for_incident
Revert Postmortem
Parameters
incident_id (required)
Incident Identifier
Type: string
page_id (required)
Page identifier
Type: string
unsubscribe_many_subscribers
Unsubscribe a list of subscribers
Parameters
page_id (required)
Page identifier
Type: string
$body
Unsubscribe a list of subscribers
Type: object
{
"subscribers" : "The array of subscriber codes to unsubscribe (limited to 100), or \"all\" to unsubscribe all subscribers if the number of subscribers is less than 100.",
"state" : "If this is present, only unsubscribe subscribers in this state. Specify state \"all\" to unsubscribe subscribers in any states.",
"type" : "If this is present, only unsubscribe subscribers of this type.",
"skip_unsubscription_notification" : "If skip_unsubscription_notification is true, the subscribers do not receive any notifications when they are unsubscribed."
}
unsubscribe_subscriber
Unsubscribe a subscriber
Parameters
page_id (required)
Page identifier
Type: string
subscriber_id (required)
Subscriber Identifier
Type: string
skip_unsubscription_notification
If skip_unsubscription_notification is true, the subscriber does not receive any notifications when they are unsubscribed.
Type: boolean
unsubscribe_subscriber_from_incident
Unsubscribe an incident subscriber
Parameters
incident_id (required)
Incident Identifier
Type: string
page_id (required)
Page identifier
Type: string
subscriber_id (required)
Subscriber Identifier
Type: string
update_component
Update a component
Parameters
component_id (required)
Component Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Update a component
Type: object
{
"component" : {
"group_id" : "Component Group identifier",
"name" : "Display name for component",
"description" : "More detailed description for component",
"showcase" : "Should this component be showcased",
"only_show_if_degraded" : "Requires a special feature flag to be enabled",
"status" : "Status of component"
}
}
update_component_group
Update a component group
Parameters
id (required)
Type: integer
page_id (required)
Page identifier
Type: string
$body
Update a component group
Type: object
{
"description" : "Updated description of the component group.",
"component_group" : {
"components" : [ "string" ],
"name" : "Required string"
}
}
update_components_for_page_access_group
Add components to page access group
Parameters
page_access_group_id (required)
Page Access Group Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Add components to page access group
Type: object
{
"component_ids" : [ "string" ]
}
update_components_for_page_access_user
Add components for page access user
Parameters
page_access_user_id (required)
Page Access User Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Type: object
{
"component_ids" : [ "string" ]
}
update_incident
Update an incident
Parameters
incident_id (required)
Incident Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Update an incident
Type: object
{
"incident" : {
"scheduled_auto_in_progress" : "Controls whether the incident is scheduled to automatically change to in progress.",
"impact_override" : "value to override calculated impact value",
"metadata" : { },
"components" : {
"component_id" : "Map of status changes to apply to affected components"
},
"scheduled_remind_prior" : "Controls whether to remind subscribers prior to scheduled incidents.",
"scheduled_auto_transition" : "Same as :scheduled_auto_transition_in_progress. Controls whether the incident is scheduled to automatically change to in progress.",
"scheduled_for" : "The timestamp the incident is scheduled for.",
"auto_transition_to_operational_state" : "Controls whether change components status to operational once scheduled maintenance completes.",
"backfilled" : "Controls whether incident is backfilled. If true, components cannot be specified.",
"body" : "The initial message, created as the first incident update.",
"deliver_notifications" : "Deliver notifications to subscribers if this is true. If this is false, create an incident without notifying customers.",
"component_ids" : [ "string" ],
"auto_tweet_on_creation" : "Controls whether tweet automatically when scheduled maintenance is created.",
"auto_tweet_on_completion" : "Controls whether tweet automatically when scheduled maintenance completes.",
"auto_tweet_one_hour_before" : "Controls whether tweet automatically one hour before scheduled maintenance starts.",
"backfill_date" : "TimeStamp when incident was backfilled.",
"name" : "Incident Name",
"auto_transition_to_maintenance_state" : "Controls whether change components status to under_maintenance once scheduled maintenance is in progress.",
"auto_tweet_at_beginning" : "Controls whether tweet automatically when scheduled maintenance starts.",
"scheduled_auto_completed" : "Controls whether the incident is scheduled to automatically change to complete.",
"auto_transition_deliver_notifications_at_start" : "Controls whether send notification when scheduled maintenances auto transition to started.",
"scheduled_until" : "The timestamp the incident is scheduled until.",
"auto_transition_deliver_notifications_at_end" : "Controls whether send notification when scheduled maintenances auto transition to completed.",
"status" : "Incident status"
}
}
update_incident_update_for_incident
Update a previous incident update
Parameters
incident_id (required)
Incident Identifier
Type: string
incident_update_id (required)
Incident Update Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Update a previous incident update
Type: object
{
"incident_update" : {
"wants_twitter_update" : "Controls whether to create twitter update.",
"body" : "Incident update body.",
"display_at" : "Timestamp when incident update is happened.",
"deliver_notifications" : "Controls whether to delivery notifications."
}
}
update_metric
Update a metric
Parameters
metric_id (required)
Metric Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Update a metric
Type: object
{
"metric" : {
"name" : "Name of metric"
}
}
update_metrics_for_page_access_user
Add metrics for page access user
Parameters
page_access_user_id (required)
Page Access User Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Add metrics for page access user
Type: object
{
"metric_ids" : [ "string" ]
}
update_metrics_provider
Update a metric provider
Parameters
metrics_provider_id (required)
Metric Provider Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Update a metric provider
Type: object
{
"metrics_provider" : {
"account_id" : "string",
"api_key" : "string",
"api_token" : "string",
"type" : "string",
"application_key" : "string",
"email" : "string"
}
}
update_page
Update a page
Parameters
page_id (required)
Page identifier
Type: string
$body
Update a page
Type: object
{
"page" : {
"css_link_color" : "CSS Color",
"allow_sms_subscribers" : "Can your users choose to receive notifications via SMS",
"branding" : "The main template your statuspage will use",
"css_yellows" : "CSS Color",
"css_graph_color" : "CSS Color",
"css_reds" : "CSS Color",
"notifications_email_footer" : "Allows you to customize the footer appearing on your notification emails. Accepts Markdown for formatting",
"allow_incident_subscribers" : "Can your users subscribe to notifications for a single incident",
"notifications_from_email" : "Allows you to customize the email address your page notifications come from",
"css_blues" : "CSS Color",
"css_body_background_color" : "CSS Color",
"allow_email_subscribers" : "Can your users choose to receive notifications via email",
"css_oranges" : "CSS Color",
"css_light_font_color" : "CSS Color",
"hidden_from_search" : "Should your page hide itself from search engines",
"time_zone" : "Timezone configured for your page",
"url" : "Website of your page. Clicking on your statuspage image will link here.",
"viewers_must_be_team_members" : "boolean",
"allow_webhook_subscribers" : "Can your users choose to receive notifications via Webhooks",
"domain" : "CNAME alias for your status page",
"name" : "Name of your page to be displayed",
"css_greens" : "CSS Color",
"subdomain" : "Subdomain at which to access your status page",
"css_border_color" : "CSS Color",
"css_font_color" : "CSS Color",
"allow_page_subscribers" : "Can your users subscribe to all notifications on the page",
"allow_rss_atom_feeds" : "Can your users choose to access incident feeds via RSS/Atom"
}
}
update_page_access_group
Update a page access group
Parameters
page_access_group_id (required)
Page Access Group Identifier
Type: string
page_id (required)
Page identifier
Type: string
$body
Update a page access group
Type: object
{
"page_access_group" : {
"external_identifier" : "Associates group with external group.",
"name" : "Name for this Group.",
"metric_ids" : [ "string" ],
"component_ids" : [ "string" ],
"page_access_user_ids" : [ "string" ]
}
}
update_page_access_user
Update page access user
Parameters
page_access_user_id (required)
Page Access User Identifier
Type: string
page_id (required)
Page identifier
Type: string
update_status_embed_config
Update status embed config settings
Parameters
page_id (required)
Page identifier
Type: string
$body
Update status embed config settings
Type: object
{
"status_embed_config" : {
"incident_background_color" : "Color of status embed iframe background when displaying incident",
"maintenance_background_color" : "Color of status embed iframe background when displaying maintenance",
"position" : "Corner where status embed iframe will appear on page",
"incident_text_color" : "Color of status embed iframe text when displaying incident",
"maintenance_text_color" : "Color of status embed iframe text when displaying maintenance"
}
}