fetch-statuspage
A simple and typed library, based on OpenAPI spec from developer.atlassian.com, for accessing product APIs.
Fetch Statuspage - Documentation
Contents
- ComponentGroupsApi
- ComponentsApi
- IncidentPostmortemApi
- IncidentSubscribersApi
- IncidentTemplatesApi
- IncidentUpdatesApi
- IncidentsApi
- MetricProvidersApi
- MetricsApi
- PageAccessGroupComponentsApi
- PageAccessGroupsApi
- PageAccessUserComponentsApi
- PageAccessUserMetricsApi
- PageAccessUsersApi
- PagesApi
- StatusEmbedConfigApi
- SubscribersApi
- UsersApi
Methods
The ComponentGroupsApi object
deletePagesPageIdComponentGroupsId() - Delete a component group
Delete a component group
Usage:
import { ComponentGroupsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new ComponentGroupsApi(config).deletePagesPageIdComponentGroupsId({ ...args });
getPagesPageIdComponentGroups() - Get a list of component groups
Get a list of component groups
Usage:
import { ComponentGroupsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new ComponentGroupsApi(config).getPagesPageIdComponentGroups({ ...args });
getPagesPageIdComponentGroupsId() - Get a component group
Get a component group
Usage:
import { ComponentGroupsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new ComponentGroupsApi(config).getPagesPageIdComponentGroupsId({ ...args });
patchPagesPageIdComponentGroupsId() - Update a component group
Update a component group
Usage:
import { ComponentGroupsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new ComponentGroupsApi(config).patchPagesPageIdComponentGroupsId({
page_id: string
id: integer
patchPagesPageIdComponentGroups: { ... }
});
postPagesPageIdComponentGroups() - Create a component group
Create a component group
Usage:
import { ComponentGroupsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new ComponentGroupsApi(config).postPagesPageIdComponentGroups({
page_id: string
postPagesPageIdComponentGroups: { ... }
});
putPagesPageIdComponentGroupsId() - Update a component group
Update a component group
Usage:
import { ComponentGroupsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new ComponentGroupsApi(config).putPagesPageIdComponentGroupsId({
page_id: string
id: integer
putPagesPageIdComponentGroups: { ... }
});
The ComponentsApi object
deletePagesPageIdComponentsComponentId() - Delete a component
Delete a component
Usage:
import { ComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new ComponentsApi(config).deletePagesPageIdComponentsComponentId({ ...args });
deletePagesPageIdComponentsComponentIdPageAccessGroups() - Remove page access groups from a component
Remove page access groups from a component
Usage:
import { ComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new ComponentsApi(config).deletePagesPageIdComponentsComponentIdPageAccessGroups({ ...args });
deletePagesPageIdComponentsComponentIdPageAccessUsers() - Remove page access users from component
Remove page access users from component
Usage:
import { ComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new ComponentsApi(config).deletePagesPageIdComponentsComponentIdPageAccessUsers({ ...args });
getPagesPageIdComponents() - Get a list of components
Get a list of components
Usage:
import { ComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new ComponentsApi(config).getPagesPageIdComponents({ ...args });
getPagesPageIdComponentsComponentId() - Get a component
Get a component
Usage:
import { ComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new ComponentsApi(config).getPagesPageIdComponentsComponentId({ ...args });
patchPagesPageIdComponentsComponentId() - Update a component
Update a component
Usage:
import { ComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new ComponentsApi(config).patchPagesPageIdComponentsComponentId({
page_id: string
component_id: string
patchPagesPageIdComponents: { ... }
});
postPagesPageIdComponents() - Create a component
Create a component
Usage:
import { ComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new ComponentsApi(config).postPagesPageIdComponents({
page_id: string
postPagesPageIdComponents: { ... }
});
postPagesPageIdComponentsComponentIdPageAccessGroups() - Add page access groups to a component
Add page access groups to a component
Usage:
import { ComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new ComponentsApi(config).postPagesPageIdComponentsComponentIdPageAccessGroups({ ...args });
postPagesPageIdComponentsComponentIdPageAccessUsers() - Add page access users to a component
Add page access users to a component
Usage:
import { ComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new ComponentsApi(config).postPagesPageIdComponentsComponentIdPageAccessUsers({
page_id: string
component_id: string
bodies_postPagesPageIdComponentsComponentIdPageAccessUsers: { ... }
});
putPagesPageIdComponentsComponentId() - Update a component
Update a component
Usage:
import { ComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new ComponentsApi(config).putPagesPageIdComponentsComponentId({
page_id: string
component_id: string
putPagesPageIdComponents: { ... }
});
The IncidentPostmortemApi object
deletePagesPageIdIncidentsIncidentIdPostmortem() - Delete Postmortem
Delete Postmortem
Usage:
import { IncidentPostmortemApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentPostmortemApi(config).deletePagesPageIdIncidentsIncidentIdPostmortem({ ...args });
getPagesPageIdIncidentsIncidentIdPostmortem() - Get Postmortem
Get Postmortem
Usage:
import { IncidentPostmortemApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentPostmortemApi(config).getPagesPageIdIncidentsIncidentIdPostmortem({ ...args });
putPagesPageIdIncidentsIncidentIdPostmortem() - Create Postmortem
Create Postmortem
Usage:
import { IncidentPostmortemApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentPostmortemApi(config).putPagesPageIdIncidentsIncidentIdPostmortem({
page_id: string
incident_id: string
putPagesPageIdIncidentsIncidentIdPostmortem: { ... }
});
putPagesPageIdIncidentsIncidentIdPostmortemPublish() - Publish Postmortem
Publish Postmortem
Usage:
import { IncidentPostmortemApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentPostmortemApi(config).putPagesPageIdIncidentsIncidentIdPostmortemPublish({
page_id: string
incident_id: string
putPagesPageIdIncidentsIncidentIdPostmortemPublish: { ... }
});
putPagesPageIdIncidentsIncidentIdPostmortemRevert() - Revert Postmortem
Revert Postmortem
Usage:
import { IncidentPostmortemApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentPostmortemApi(config).putPagesPageIdIncidentsIncidentIdPostmortemRevert({ ...args });
The IncidentSubscribersApi object
deletePagesPageIdIncidentsIncidentIdSubscribersSubscriberId() - Unsubscribe an incident subscriber
Unsubscribe an incident subscriber
Usage:
import { IncidentSubscribersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentSubscribersApi(config).deletePagesPageIdIncidentsIncidentIdSubscribersSubscriberId({ ...args });
getPagesPageIdIncidentsIncidentIdSubscribers() - Get a list of incident subscribers
Get a list of incident subscribers
Usage:
import { IncidentSubscribersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentSubscribersApi(config).getPagesPageIdIncidentsIncidentIdSubscribers({ ...args });
getPagesPageIdIncidentsIncidentIdSubscribersSubscriberId() - Get an incident subscriber
Get an incident subscriber
Usage:
import { IncidentSubscribersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentSubscribersApi(config).getPagesPageIdIncidentsIncidentIdSubscribersSubscriberId({ ...args });
postPagesPageIdIncidentsIncidentIdSubscribers() - Create an incident subscriber
Create an incident subscriber
Usage:
import { IncidentSubscribersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentSubscribersApi(config).postPagesPageIdIncidentsIncidentIdSubscribers({
page_id: string
incident_id: string
postPagesPageIdIncidentsIncidentIdSubscribers: { ... }
});
postPagesPageIdIncidentsIncidentIdSubscribersSubscriberIdResendConfirmation() - Resend confirmation to an incident subscriber
Resend confirmation to an incident subscriber
Usage:
import { IncidentSubscribersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentSubscribersApi(config).postPagesPageIdIncidentsIncidentIdSubscribersSubscriberIdResendConfirmation({ ...args });
The IncidentTemplatesApi object
getPagesPageIdIncidentTemplates() - Get a list of incident templates
Get a list of incident templates
Usage:
import { IncidentTemplatesApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentTemplatesApi(config).getPagesPageIdIncidentTemplates({ ...args });
The IncidentUpdatesApi object
patchPagesPageIdIncidentsIncidentIdIncidentUpdatesIncidentUpdateId() - Update a previous incident update
Update a previous incident update
Usage:
import { IncidentUpdatesApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentUpdatesApi(config).patchPagesPageIdIncidentsIncidentIdIncidentUpdatesIncidentUpdateId({
page_id: string
incident_id: string
incident_update_id: string
patchPagesPageIdIncidentsIncidentIdIncidentUpdates: { ... }
});
putPagesPageIdIncidentsIncidentIdIncidentUpdatesIncidentUpdateId() - Update a previous incident update
Update a previous incident update
Usage:
import { IncidentUpdatesApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentUpdatesApi(config).putPagesPageIdIncidentsIncidentIdIncidentUpdatesIncidentUpdateId({
page_id: string
incident_id: string
incident_update_id: string
putPagesPageIdIncidentsIncidentIdIncidentUpdates: { ... }
});
The IncidentsApi object
deletePagesPageIdIncidentsIncidentId() - Delete an incident
Delete an incident
Usage:
import { IncidentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentsApi(config).deletePagesPageIdIncidentsIncidentId({ ...args });
getPagesPageIdIncidents() - Get a list of incidents
Get a list of incidents
Usage:
import { IncidentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentsApi(config).getPagesPageIdIncidents({ ...args });
getPagesPageIdIncidentsActiveMaintenance() - Get a list of active maintenances
Get a list of active maintenances
Usage:
import { IncidentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentsApi(config).getPagesPageIdIncidentsActiveMaintenance({ ...args });
getPagesPageIdIncidentsIncidentId() - Get an incident
Get an incident
Usage:
import { IncidentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentsApi(config).getPagesPageIdIncidentsIncidentId({ ...args });
getPagesPageIdIncidentsScheduled() - Get a list of scheduled incidents
Get a list of scheduled incidents
Usage:
import { IncidentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentsApi(config).getPagesPageIdIncidentsScheduled({ ...args });
getPagesPageIdIncidentsUnresolved() - Get a list of unresolved incidents
Get a list of unresolved incidents
Usage:
import { IncidentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentsApi(config).getPagesPageIdIncidentsUnresolved({ ...args });
getPagesPageIdIncidentsUpcoming() - Get a list of upcoming incidents
Get a list of upcoming incidents
Usage:
import { IncidentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentsApi(config).getPagesPageIdIncidentsUpcoming({ ...args });
patchPagesPageIdIncidentsIncidentId() - Update an incident
Update an incident
Usage:
import { IncidentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentsApi(config).patchPagesPageIdIncidentsIncidentId({
page_id: string
incident_id: string
patchPagesPageIdIncidents: { ... }
});
postPagesPageIdIncidents() - Create an incident
Create an incident
Usage:
import { IncidentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentsApi(config).postPagesPageIdIncidents({
page_id: string
postPagesPageIdIncidents: { ... }
});
putPagesPageIdIncidentsIncidentId() - Update an incident
Update an incident
Usage:
import { IncidentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new IncidentsApi(config).putPagesPageIdIncidentsIncidentId({
page_id: string
incident_id: string
putPagesPageIdIncidents: { ... }
});
The MetricProvidersApi object
deletePagesPageIdMetricsProvidersMetricsProviderId() - Delete a metric provider
Delete a metric provider
Usage:
import { MetricProvidersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new MetricProvidersApi(config).deletePagesPageIdMetricsProvidersMetricsProviderId({ ...args });
getPagesPageIdMetricsProviders() - Get a list of metric providers
Get a list of metric providers
Usage:
import { MetricProvidersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new MetricProvidersApi(config).getPagesPageIdMetricsProviders({ ...args });
getPagesPageIdMetricsProvidersMetricsProviderId() - Get a metric provider
Get a metric provider
Usage:
import { MetricProvidersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new MetricProvidersApi(config).getPagesPageIdMetricsProvidersMetricsProviderId({ ...args });
patchPagesPageIdMetricsProvidersMetricsProviderId() - Update a metric provider
Update a metric provider
Usage:
import { MetricProvidersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new MetricProvidersApi(config).patchPagesPageIdMetricsProvidersMetricsProviderId({
page_id: string
metrics_provider_id: string
patchPagesPageIdMetricsProviders: { ... }
});
postPagesPageIdMetricsProviders() - Create a metric provider
Create a metric provider
Usage:
import { MetricProvidersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new MetricProvidersApi(config).postPagesPageIdMetricsProviders({
page_id: string
postPagesPageIdMetricsProviders: { ... }
});
putPagesPageIdMetricsProvidersMetricsProviderId() - Update a metric provider
Update a metric provider
Usage:
import { MetricProvidersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new MetricProvidersApi(config).putPagesPageIdMetricsProvidersMetricsProviderId({
page_id: string
metrics_provider_id: string
putPagesPageIdMetricsProviders: { ... }
});
The MetricsApi object
deletePagesPageIdMetricsMetricId() - Delete a metric
Delete a metric
Usage:
import { MetricsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new MetricsApi(config).deletePagesPageIdMetricsMetricId({ ...args });
deletePagesPageIdMetricsMetricIdData() - Reset data for a metric
Reset data for a metric
Usage:
import { MetricsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new MetricsApi(config).deletePagesPageIdMetricsMetricIdData({ ...args });
getPagesPageIdMetrics() - Get a list of metrics
Get a list of metrics
Usage:
import { MetricsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new MetricsApi(config).getPagesPageIdMetrics({ ...args });
getPagesPageIdMetricsMetricId() - Get a metric
Get a metric
Usage:
import { MetricsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new MetricsApi(config).getPagesPageIdMetricsMetricId({ ...args });
getPagesPageIdMetricsProvidersMetricsProviderIdMetrics() - List metrics for a metric provider
List metrics for a metric provider
Usage:
import { MetricsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new MetricsApi(config).getPagesPageIdMetricsProvidersMetricsProviderIdMetrics({ ...args });
patchPagesPageIdMetricsMetricId() - Update a metric
Update a metric
Usage:
import { MetricsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new MetricsApi(config).patchPagesPageIdMetricsMetricId({
page_id: string
metric_id: string
patchPagesPageIdMetrics: { ... }
});
postPagesPageIdMetricsData() - Add data points to metrics
Add data points to metrics
Usage:
import { MetricsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new MetricsApi(config).postPagesPageIdMetricsData({
page_id: string
postPagesPageIdMetricsData: { ... }
});
postPagesPageIdMetricsMetricIdData() - Add data to a metric
Add data to a metric
Usage:
import { MetricsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new MetricsApi(config).postPagesPageIdMetricsMetricIdData({
page_id: string
metric_id: string
postPagesPageIdMetricsMetricIdData: { ... }
});
postPagesPageIdMetricsProvidersMetricsProviderIdMetrics() - Create a metric for a metric provider
Create a metric for a metric provider
Usage:
import { MetricsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new MetricsApi(config).postPagesPageIdMetricsProvidersMetricsProviderIdMetrics({
page_id: string
metrics_provider_id: string
postPagesPageIdMetricsProvidersMetricsProviderIdMetrics: { ... }
});
putPagesPageIdMetricsMetricId() - Update a metric
Update a metric
Usage:
import { MetricsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new MetricsApi(config).putPagesPageIdMetricsMetricId({
page_id: string
metric_id: string
putPagesPageIdMetrics: { ... }
});
The PageAccessGroupComponentsApi object
deletePagesPageIdPageAccessGroupsPageAccessGroupIdComponents() - Delete components for a page access group
Delete components for a page access group
Usage:
import { PageAccessGroupComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessGroupComponentsApi(config).deletePagesPageIdPageAccessGroupsPageAccessGroupIdComponents({
page_id: string
page_access_group_id: string
deletePagesPageIdPageAccessGroupsPageAccessGroupIdComponents: { ... }
});
deletePagesPageIdPageAccessGroupsPageAccessGroupIdComponentsComponentId() - Remove a component from a page access group
Remove a component from a page access group
Usage:
import { PageAccessGroupComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessGroupComponentsApi(config).deletePagesPageIdPageAccessGroupsPageAccessGroupIdComponentsComponentId({ ...args });
getPagesPageIdPageAccessGroupsPageAccessGroupIdComponents() - List components for a page access group
List components for a page access group
Usage:
import { PageAccessGroupComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessGroupComponentsApi(config).getPagesPageIdPageAccessGroupsPageAccessGroupIdComponents({ ...args });
patchPagesPageIdPageAccessGroupsPageAccessGroupIdComponents() - Add components to page access group
Add components to page access group
Usage:
import { PageAccessGroupComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessGroupComponentsApi(config).patchPagesPageIdPageAccessGroupsPageAccessGroupIdComponents({
page_id: string
page_access_group_id: string
patchPagesPageIdPageAccessGroupsPageAccessGroupIdComponents: { ... }
});
postPagesPageIdPageAccessGroupsPageAccessGroupIdComponents() - Replace components for a page access group
Replace components for a page access group
Usage:
import { PageAccessGroupComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessGroupComponentsApi(config).postPagesPageIdPageAccessGroupsPageAccessGroupIdComponents({
page_id: string
page_access_group_id: string
postPagesPageIdPageAccessGroupsPageAccessGroupIdComponents: { ... }
});
putPagesPageIdPageAccessGroupsPageAccessGroupIdComponents() - Add components to page access group
Add components to page access group
Usage:
import { PageAccessGroupComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessGroupComponentsApi(config).putPagesPageIdPageAccessGroupsPageAccessGroupIdComponents({
page_id: string
page_access_group_id: string
putPagesPageIdPageAccessGroupsPageAccessGroupIdComponents: { ... }
});
The PageAccessGroupsApi object
deletePagesPageIdPageAccessGroupsPageAccessGroupId() - Remove a page access group
Remove a page access group
Usage:
import { PageAccessGroupsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessGroupsApi(config).deletePagesPageIdPageAccessGroupsPageAccessGroupId({ ...args });
getPagesPageIdPageAccessGroups() - Get a list of page access groups
Get a list of page access groups
Usage:
import { PageAccessGroupsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessGroupsApi(config).getPagesPageIdPageAccessGroups({ ...args });
getPagesPageIdPageAccessGroupsPageAccessGroupId() - Get a page access group
Get a page access group
Usage:
import { PageAccessGroupsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessGroupsApi(config).getPagesPageIdPageAccessGroupsPageAccessGroupId({ ...args });
patchPagesPageIdPageAccessGroupsPageAccessGroupId() - Update a page access group
Update a page access group
Usage:
import { PageAccessGroupsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessGroupsApi(config).patchPagesPageIdPageAccessGroupsPageAccessGroupId({
page_id: string
page_access_group_id: string
patchPagesPageIdPageAccessGroups: { ... }
});
postPagesPageIdPageAccessGroups() - Create a page access group
Create a page access group
Usage:
import { PageAccessGroupsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessGroupsApi(config).postPagesPageIdPageAccessGroups({
page_id: string
postPagesPageIdPageAccessGroups: { ... }
});
putPagesPageIdPageAccessGroupsPageAccessGroupId() - Update a page access group
Update a page access group
Usage:
import { PageAccessGroupsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessGroupsApi(config).putPagesPageIdPageAccessGroupsPageAccessGroupId({
page_id: string
page_access_group_id: string
putPagesPageIdPageAccessGroups: { ... }
});
The PageAccessUserComponentsApi object
deletePagesPageIdPageAccessUsersPageAccessUserIdComponents() - Remove components for page access user
Remove components for page access user
Usage:
import { PageAccessUserComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUserComponentsApi(config).deletePagesPageIdPageAccessUsersPageAccessUserIdComponents({
page_id: string
page_access_user_id: string
bodies_deletePagesPageIdPageAccessUsersPageAccessUserIdComponents: { ... }
});
deletePagesPageIdPageAccessUsersPageAccessUserIdComponentsComponentId() - Remove component for page access user
Remove component for page access user
Usage:
import { PageAccessUserComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUserComponentsApi(config).deletePagesPageIdPageAccessUsersPageAccessUserIdComponentsComponentId({ ...args });
getPagesPageIdPageAccessUsersPageAccessUserIdComponents() - Get components for page access user
Get components for page access user
Usage:
import { PageAccessUserComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUserComponentsApi(config).getPagesPageIdPageAccessUsersPageAccessUserIdComponents({ ...args });
patchPagesPageIdPageAccessUsersPageAccessUserIdComponents() - Add components for page access user
Add components for page access user
Usage:
import { PageAccessUserComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUserComponentsApi(config).patchPagesPageIdPageAccessUsersPageAccessUserIdComponents({
page_id: string
page_access_user_id: string
patchPagesPageIdPageAccessUsersPageAccessUserIdComponents: { ... }
});
postPagesPageIdPageAccessUsersPageAccessUserIdComponents() - Replace components for page access user
Replace components for page access user
Usage:
import { PageAccessUserComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUserComponentsApi(config).postPagesPageIdPageAccessUsersPageAccessUserIdComponents({
page_id: string
page_access_user_id: string
patchPagesPageIdPageAccessUsersPageAccessUserIdComponents: { ... }
});
putPagesPageIdPageAccessUsersPageAccessUserIdComponents() - Add components for page access user
Add components for page access user
Usage:
import { PageAccessUserComponentsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUserComponentsApi(config).putPagesPageIdPageAccessUsersPageAccessUserIdComponents({
page_id: string
page_access_user_id: string
patchPagesPageIdPageAccessUsersPageAccessUserIdComponents: { ... }
});
The PageAccessUserMetricsApi object
deletePagesPageIdPageAccessUsersPageAccessUserIdMetrics() - Delete metrics for page access user
Delete metrics for page access user
Usage:
import { PageAccessUserMetricsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUserMetricsApi(config).deletePagesPageIdPageAccessUsersPageAccessUserIdMetrics({
page_id: string
page_access_user_id: string
deletePagesPageIdPageAccessUsersPageAccessUserIdMetrics: { ... }
});
deletePagesPageIdPageAccessUsersPageAccessUserIdMetricsMetricId() - Delete metric for page access user
Delete metric for page access user
Usage:
import { PageAccessUserMetricsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUserMetricsApi(config).deletePagesPageIdPageAccessUsersPageAccessUserIdMetricsMetricId({ ...args });
getPagesPageIdPageAccessUsersPageAccessUserIdMetrics() - Get metrics for page access user
Get metrics for page access user
Usage:
import { PageAccessUserMetricsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUserMetricsApi(config).getPagesPageIdPageAccessUsersPageAccessUserIdMetrics({ ...args });
patchPagesPageIdPageAccessUsersPageAccessUserIdMetrics() - Add metrics for page access user
Add metrics for page access user
Usage:
import { PageAccessUserMetricsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUserMetricsApi(config).patchPagesPageIdPageAccessUsersPageAccessUserIdMetrics({
page_id: string
page_access_user_id: string
patchPagesPageIdPageAccessUsersPageAccessUserIdMetrics: { ... }
});
postPagesPageIdPageAccessUsersPageAccessUserIdMetrics() - Replace metrics for page access user
Replace metrics for page access user
Usage:
import { PageAccessUserMetricsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUserMetricsApi(config).postPagesPageIdPageAccessUsersPageAccessUserIdMetrics({
page_id: string
page_access_user_id: string
postPagesPageIdPageAccessUsersPageAccessUserIdMetrics: { ... }
});
putPagesPageIdPageAccessUsersPageAccessUserIdMetrics() - Add metrics for page access user
Add metrics for page access user
Usage:
import { PageAccessUserMetricsApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUserMetricsApi(config).putPagesPageIdPageAccessUsersPageAccessUserIdMetrics({
page_id: string
page_access_user_id: string
putPagesPageIdPageAccessUsersPageAccessUserIdMetrics: { ... }
});
The PageAccessUsersApi object
deletePagesPageIdPageAccessUsersPageAccessUserId() - Delete page access user
Delete page access user
Usage:
import { PageAccessUsersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUsersApi(config).deletePagesPageIdPageAccessUsersPageAccessUserId({ ...args });
getPagesPageIdPageAccessUsers() - Get a list of page access users
Get a list of page access users
Usage:
import { PageAccessUsersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUsersApi(config).getPagesPageIdPageAccessUsers({ ...args });
getPagesPageIdPageAccessUsersPageAccessUserId() - Get page access user
Get page access user
Usage:
import { PageAccessUsersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUsersApi(config).getPagesPageIdPageAccessUsersPageAccessUserId({ ...args });
patchPagesPageIdPageAccessUsersPageAccessUserId() - Update page access user
Update page access user
Usage:
import { PageAccessUsersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUsersApi(config).patchPagesPageIdPageAccessUsersPageAccessUserId({ ...args });
postPagesPageIdPageAccessUsers() - Add a page access user
Add a page access user
Usage:
import { PageAccessUsersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUsersApi(config).postPagesPageIdPageAccessUsers({
page_id: string
postPagesPageIdPageAccessUsers: { ... }
});
putPagesPageIdPageAccessUsersPageAccessUserId() - Update page access user
Update page access user
Usage:
import { PageAccessUsersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PageAccessUsersApi(config).putPagesPageIdPageAccessUsersPageAccessUserId({ ...args });
The PagesApi object
getPages() - Get a list of pages
Get a list of pages
Usage:
import { PagesApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PagesApi(config).getPages({ ...args });
getPagesPageId() - Get a page
Get a page
Usage:
import { PagesApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PagesApi(config).getPagesPageId({ ...args });
patchPagesPageId() - Update a page
Update a page
Usage:
import { PagesApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PagesApi(config).patchPagesPageId({
page_id: string
patchPages: { ... }
});
putPagesPageId() - Update a page
Update a page
Usage:
import { PagesApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new PagesApi(config).putPagesPageId({
page_id: string
putPages: { ... }
});
The StatusEmbedConfigApi object
getPagesPageIdStatusEmbedConfig() - Get status embed config settings
Get status embed config settings
Usage:
import { StatusEmbedConfigApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new StatusEmbedConfigApi(config).getPagesPageIdStatusEmbedConfig({ ...args });
patchPagesPageIdStatusEmbedConfig() - Update status embed config settings
Update status embed config settings
Usage:
import { StatusEmbedConfigApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new StatusEmbedConfigApi(config).patchPagesPageIdStatusEmbedConfig({
page_id: string
patchPagesPageIdStatusEmbedConfig: { ... }
});
putPagesPageIdStatusEmbedConfig() - Update status embed config settings
Update status embed config settings
Usage:
import { StatusEmbedConfigApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new StatusEmbedConfigApi(config).putPagesPageIdStatusEmbedConfig({
page_id: string
putPagesPageIdStatusEmbedConfig: { ... }
});
The SubscribersApi object
deletePagesPageIdSubscribersSubscriberId() - Unsubscribe a subscriber
Unsubscribe a subscriber
Usage:
import { SubscribersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new SubscribersApi(config).deletePagesPageIdSubscribersSubscriberId({ ...args });
getPagesPageIdSubscribers() - Get a list of subscribers
Get a list of subscribers
Usage:
import { SubscribersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new SubscribersApi(config).getPagesPageIdSubscribers({ ...args });
getPagesPageIdSubscribersCount() - Get a count of subscribers by type
Get a count of subscribers by type
Usage:
import { SubscribersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new SubscribersApi(config).getPagesPageIdSubscribersCount({ ...args });
getPagesPageIdSubscribersHistogramByState() - Get a histogram of subscribers by type and then state
Get a histogram of subscribers by type and then state
Usage:
import { SubscribersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new SubscribersApi(config).getPagesPageIdSubscribersHistogramByState({ ...args });
getPagesPageIdSubscribersSubscriberId() - Get a subscriber
Get a subscriber
Usage:
import { SubscribersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new SubscribersApi(config).getPagesPageIdSubscribersSubscriberId({ ...args });
getPagesPageIdSubscribersUnsubscribed() - Get a list of unsubscribed subscribers
Get a list of unsubscribed subscribers
Usage:
import { SubscribersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new SubscribersApi(config).getPagesPageIdSubscribersUnsubscribed({ ...args });
postPagesPageIdSubscribers() - Create a subscriber
Create a subscriber
Usage:
import { SubscribersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new SubscribersApi(config).postPagesPageIdSubscribers({
page_id: string
postPagesPageIdSubscribers: { ... }
});
postPagesPageIdSubscribersReactivate() - Reactivate a list of subscribers
Reactivate a list of subscribers
Usage:
import { SubscribersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new SubscribersApi(config).postPagesPageIdSubscribersReactivate({
page_id: string
postPagesPageIdSubscribersReactivate: { ... }
});
postPagesPageIdSubscribersResendConfirmation() - Resend confirmations to a list of subscribers
Resend confirmations to a list of subscribers
Usage:
import { SubscribersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new SubscribersApi(config).postPagesPageIdSubscribersResendConfirmation({
page_id: string
postPagesPageIdSubscribersResendConfirmation: { ... }
});
postPagesPageIdSubscribersSubscriberIdResendConfirmation() - Resend confirmation to a subscriber
Resend confirmation to a subscriber
Usage:
import { SubscribersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new SubscribersApi(config).postPagesPageIdSubscribersSubscriberIdResendConfirmation({ ...args });
postPagesPageIdSubscribersUnsubscribe() - Unsubscribe a list of subscribers
Unsubscribe a list of subscribers
Usage:
import { SubscribersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new SubscribersApi(config).postPagesPageIdSubscribersUnsubscribe({
page_id: string
postPagesPageIdSubscribersUnsubscribe: { ... }
});
The UsersApi object
deleteOrganizationsOrganizationIdUsersUserId() - Delete a user
Delete a user
Usage:
import { UsersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new UsersApi(config).deleteOrganizationsOrganizationIdUsersUserId({ ...args });
getOrganizationsOrganizationIdUsers() - Get a list of users
Get a list of users
Usage:
import { UsersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new UsersApi(config).getOrganizationsOrganizationIdUsers({ ...args });
postOrganizationsOrganizationIdUsers() - Create a user
Create a user
Usage:
import { UsersApi, Configuration } from 'fetch-statuspage';
const config: Configuration = new Configuration({
fetchApi: yourFetchClient,
basePath: "<your base path>"
});
const responsePromise = new UsersApi(config).postOrganizationsOrganizationIdUsers({
organization_id: string
postOrganizationsOrganizationIdUsers: { ... }
});
References
Page
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "053mk16y7gqh",
"description": "Page identifier"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp the record was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp the record was last updated"
},
"name": {
"type": "string",
"example": "My Company Status",
"description": "Name of your page to be displayed"
},
"page_description": {
"type": "string"
},
"headline": {
"type": "string"
},
"branding": {
"type": "string",
"description": "The main template your statuspage will use"
},
"subdomain": {
"type": "string",
"example": "your-subdomain.statuspage.io",
"description": "Subdomain at which to access your status page"
},
"domain": {
"type": "string",
"example": "status.mycompany.com",
"description": "CNAME alias for your status page"
},
"url": {
"type": "string",
"example": "https://www.mycompany.com",
"description": "Website of your page. Clicking on your statuspage image will link here."
},
"support_url": {
"type": "string"
},
"hidden_from_search": {
"type": "boolean",
"description": "Should your page hide itself from search engines"
},
"allow_page_subscribers": {
"type": "boolean",
"description": "Can your users subscribe to all notifications on the page"
},
"allow_incident_subscribers": {
"type": "boolean",
"description": "Can your users subscribe to notifications for a single incident"
},
"allow_email_subscribers": {
"type": "boolean",
"description": "Can your users choose to receive notifications via email"
},
"allow_sms_subscribers": {
"type": "boolean",
"description": "Can your users choose to receive notifications via SMS"
},
"allow_rss_atom_feeds": {
"type": "boolean",
"description": "Can your users choose to access incident feeds via RSS/Atom"
},
"allow_webhook_subscribers": {
"type": "boolean",
"description": "Can your users choose to receive notifications via Webhooks"
},
"notifications_from_email": {
"type": "string",
"example": "no-reply@status.mycompany.com",
"description": "Allows you to customize the email address your page notifications come from"
},
"notifications_email_footer": {
"type": "string",
"description": "Allows you to customize the footer appearing on your notification emails. Accepts Markdown for formatting"
},
"activity_score": {
"type": "number",
"format": "float"
},
"twitter_username": {
"type": "string"
},
"viewers_must_be_team_members": {
"type": "boolean"
},
"ip_restrictions": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"time_zone": {
"type": "string",
"example": "UTC",
"description": "Timezone configured for your page"
},
"css_body_background_color": {
"type": "string",
"description": "CSS Color"
},
"css_font_color": {
"type": "string",
"description": "CSS Color"
},
"css_light_font_color": {
"type": "string",
"description": "CSS Color"
},
"css_greens": {
"type": "string",
"description": "CSS Color"
},
"css_yellows": {
"type": "string",
"description": "CSS Color"
},
"css_oranges": {
"type": "string",
"description": "CSS Color"
},
"css_blues": {
"type": "string",
"description": "CSS Color"
},
"css_reds": {
"type": "string",
"description": "CSS Color"
},
"css_border_color": {
"type": "string",
"description": "CSS Color"
},
"css_graph_color": {
"type": "string",
"description": "CSS Color"
},
"css_link_color": {
"type": "string",
"description": "CSS Color"
},
"favicon_logo": {
"type": "string"
},
"transactional_logo": {
"type": "string"
},
"hero_cover": {
"type": "string"
},
"email_logo": {
"type": "string"
},
"twitter_logo": {
"type": "string"
}
},
"description": "Get a page"
}
ErrorEntity
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"description": "Get a list of users"
}
patchPages
{
"type": "object",
"properties": {
"page": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of your page to be displayed"
},
"domain": {
"type": "string",
"description": "CNAME alias for your status page"
},
"subdomain": {
"type": "string",
"description": "Subdomain at which to access your status page"
},
"url": {
"type": "string",
"description": "Website of your page. Clicking on your statuspage image will link here."
},
"branding": {
"type": "string",
"description": "The main template your statuspage will use",
"enum": [
"basic",
"premium"
]
},
"css_body_background_color": {
"type": "string",
"description": "CSS Color"
},
"css_font_color": {
"type": "string",
"description": "CSS Color"
},
"css_light_font_color": {
"type": "string",
"description": "CSS Color"
},
"css_greens": {
"type": "string",
"description": "CSS Color"
},
"css_yellows": {
"type": "string",
"description": "CSS Color"
},
"css_oranges": {
"type": "string",
"description": "CSS Color"
},
"css_reds": {
"type": "string",
"description": "CSS Color"
},
"css_blues": {
"type": "string",
"description": "CSS Color"
},
"css_border_color": {
"type": "string",
"description": "CSS Color"
},
"css_graph_color": {
"type": "string",
"description": "CSS Color"
},
"css_link_color": {
"type": "string",
"description": "CSS Color"
},
"hidden_from_search": {
"type": "boolean",
"description": "Should your page hide itself from search engines"
},
"viewers_must_be_team_members": {
"type": "boolean"
},
"allow_page_subscribers": {
"type": "boolean",
"description": "Can your users subscribe to all notifications on the page"
},
"allow_incident_subscribers": {
"type": "boolean",
"description": "Can your users subscribe to notifications for a single incident"
},
"allow_email_subscribers": {
"type": "boolean",
"description": "Can your users choose to receive notifications via email"
},
"allow_sms_subscribers": {
"type": "boolean",
"description": "Can your users choose to receive notifications via SMS"
},
"allow_rss_atom_feeds": {
"type": "boolean",
"description": "Can your users choose to access incident feeds via RSS/Atom"
},
"allow_webhook_subscribers": {
"type": "boolean",
"description": "Can your users choose to receive notifications via Webhooks"
},
"notifications_from_email": {
"type": "string",
"description": "Allows you to customize the email address your page notifications come from"
},
"time_zone": {
"type": "string",
"description": "Timezone configured for your page"
},
"notifications_email_footer": {
"type": "string",
"description": "Allows you to customize the footer appearing on your notification emails. Accepts Markdown for formatting"
}
}
}
},
"description": "Update a page",
"title": "patchPages"
}
putPages
{
"type": "object",
"properties": {
"page": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of your page to be displayed"
},
"domain": {
"type": "string",
"description": "CNAME alias for your status page"
},
"subdomain": {
"type": "string",
"description": "Subdomain at which to access your status page"
},
"url": {
"type": "string",
"description": "Website of your page. Clicking on your statuspage image will link here."
},
"branding": {
"type": "string",
"description": "The main template your statuspage will use",
"enum": [
"basic",
"premium"
]
},
"css_body_background_color": {
"type": "string",
"description": "CSS Color"
},
"css_font_color": {
"type": "string",
"description": "CSS Color"
},
"css_light_font_color": {
"type": "string",
"description": "CSS Color"
},
"css_greens": {
"type": "string",
"description": "CSS Color"
},
"css_yellows": {
"type": "string",
"description": "CSS Color"
},
"css_oranges": {
"type": "string",
"description": "CSS Color"
},
"css_reds": {
"type": "string",
"description": "CSS Color"
},
"css_blues": {
"type": "string",
"description": "CSS Color"
},
"css_border_color": {
"type": "string",
"description": "CSS Color"
},
"css_graph_color": {
"type": "string",
"description": "CSS Color"
},
"css_link_color": {
"type": "string",
"description": "CSS Color"
},
"hidden_from_search": {
"type": "boolean",
"description": "Should your page hide itself from search engines"
},
"viewers_must_be_team_members": {
"type": "boolean"
},
"allow_page_subscribers": {
"type": "boolean",
"description": "Can your users subscribe to all notifications on the page"
},
"allow_incident_subscribers": {
"type": "boolean",
"description": "Can your users subscribe to notifications for a single incident"
},
"allow_email_subscribers": {
"type": "boolean",
"description": "Can your users choose to receive notifications via email"
},
"allow_sms_subscribers": {
"type": "boolean",
"description": "Can your users choose to receive notifications via SMS"
},
"allow_rss_atom_feeds": {
"type": "boolean",
"description": "Can your users choose to access incident feeds via RSS/Atom"
},
"allow_webhook_subscribers": {
"type": "boolean",
"description": "Can your users choose to receive notifications via Webhooks"
},
"notifications_from_email": {
"type": "string",
"description": "Allows you to customize the email address your page notifications come from"
},
"time_zone": {
"type": "string",
"description": "Timezone configured for your page"
},
"notifications_email_footer": {
"type": "string",
"description": "Allows you to customize the footer appearing on your notification emails. Accepts Markdown for formatting"
}
}
}
},
"description": "Update a page",
"title": "putPages"
}
postPagesPageIdPageAccessUsers
{
"type": "object",
"properties": {
"page_access_user": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"page_access_group_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"description": "Add a page access user",
"title": "postPagesPageIdPageAccessUsers"
}
PageAccessUser
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "q831qnz8gr63",
"description": "Page Access User Identifier"
},
"page_id": {
"type": "string"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"external_login": {
"type": "string"
},
"page_access_group_id": {
"type": "string"
},
"page_access_group_ids": {
"type": "string",
"example": []
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"description": "Remove component for page access user"
}
patchPagesPageIdPageAccessUsersPageAccessUserIdMetrics
{
"type": "object",
"properties": {
"metric_ids": {
"type": "array",
"description": "List of metrics to add",
"items": {
"type": "string"
}
}
},
"required": [
"metric_ids"
],
"description": "Add metrics for page access user",
"title": "patchPagesPageIdPageAccessUsersPageAccessUserIdMetrics"
}
putPagesPageIdPageAccessUsersPageAccessUserIdMetrics
{
"type": "object",
"properties": {
"metric_ids": {
"type": "array",
"description": "List of metrics to add",
"items": {
"type": "string"
}
}
},
"required": [
"metric_ids"
],
"description": "Add metrics for page access user",
"title": "putPagesPageIdPageAccessUsersPageAccessUserIdMetrics"
}
postPagesPageIdPageAccessUsersPageAccessUserIdMetrics
{
"type": "object",
"properties": {
"metric_ids": {
"type": "array",
"description": "List of metrics to add",
"items": {
"type": "string"
}
}
},
"required": [
"metric_ids"
],
"description": "Replace metrics for page access user",
"title": "postPagesPageIdPageAccessUsersPageAccessUserIdMetrics"
}
deletePagesPageIdPageAccessUsersPageAccessUserIdMetrics
{
"type": "object",
"properties": {
"metric_ids": {
"type": "array",
"description": "List of metrics to remove",
"items": {
"type": "string"
}
}
},
"description": "Delete metrics for page access user",
"title": "deletePagesPageIdPageAccessUsersPageAccessUserIdMetrics"
}
PageAccessGroup
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "11v617jmnphg",
"description": "Page Access Group Identifier"
},
"page_id": {
"type": "string",
"description": "Page Identifier."
},
"name": {
"type": "string",
"description": "Name for this Group."
},
"page_access_user_ids": {
"type": "array",
"items": {
"type": "string",
"example": "265f2mjtv8jf"
}
},
"external_identifier": {
"type": "string",
"description": "Associates group with external group."
},
"metric_ids": {
"type": "array",
"items": {
"type": "string",
"example": "gl4hf7hq0pbv"
}
},
"component_ids": {
"type": "array",
"items": {
"type": "string",
"example": "scb6ygvcy62d"
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"description": "Remove a component from a page access group"
}
postPagesPageIdPageAccessGroups
{
"type": "object",
"properties": {
"page_access_group": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name for this Group."
},
"external_identifier": {
"type": "string",
"description": "Associates group with external group."
},
"component_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"metric_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"page_access_user_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"description": "Create a page access group",
"title": "postPagesPageIdPageAccessGroups"
}
patchPagesPageIdPageAccessGroups
{
"type": "object",
"properties": {
"page_access_group": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name for this Group."
},
"external_identifier": {
"type": "string",
"description": "Associates group with external group."
},
"component_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"metric_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"page_access_user_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"description": "Update a page access group",
"title": "patchPagesPageIdPageAccessGroups"
}
putPagesPageIdPageAccessGroups
{
"type": "object",
"properties": {
"page_access_group": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name for this Group."
},
"external_identifier": {
"type": "string",
"description": "Associates group with external group."
},
"component_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"metric_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"page_access_user_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"description": "Update a page access group",
"title": "putPagesPageIdPageAccessGroups"
}
patchPagesPageIdPageAccessGroupsPageAccessGroupIdComponents
{
"type": "object",
"properties": {
"component_ids": {
"type": "array",
"description": "List of Component identifiers",
"items": {
"type": "string"
}
}
},
"description": "Add components to page access group",
"title": "patchPagesPageIdPageAccessGroupsPageAccessGroupIdComponents"
}
putPagesPageIdPageAccessGroupsPageAccessGroupIdComponents
{
"type": "object",
"properties": {
"component_ids": {
"type": "array",
"description": "List of Component identifiers",
"items": {
"type": "string"
}
}
},
"description": "Add components to page access group",
"title": "putPagesPageIdPageAccessGroupsPageAccessGroupIdComponents"
}
postPagesPageIdPageAccessGroupsPageAccessGroupIdComponents
{
"type": "object",
"properties": {
"component_ids": {
"type": "array",
"description": "List of components codes to set on the page access group",
"items": {
"type": "string"
}
}
},
"required": [
"component_ids"
],
"description": "Replace components for a page access group",
"title": "postPagesPageIdPageAccessGroupsPageAccessGroupIdComponents"
}
deletePagesPageIdPageAccessGroupsPageAccessGroupIdComponents
{
"type": "object",
"properties": {
"component_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Delete components for a page access group",
"title": "deletePagesPageIdPageAccessGroupsPageAccessGroupIdComponents"
}
Component
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Identifier for component"
},
"page_id": {
"type": "string",
"description": "Page identifier"
},
"group_id": {
"type": "string",
"description": "Component Group identifier"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"group": {
"type": "boolean",
"description": "Is this component a group"
},
"name": {
"type": "string",
"description": "Display name for component"
},
"description": {
"type": "string",
"description": "More detailed description for component"
},
"position": {
"type": "integer",
"format": "int32",
"description": "Order the component will appear on the page"
},
"status": {
"type": "string",
"enum": [
"operational",
"under_maintenance",
"degraded_performance",
"partial_outage",
"major_outage",
""
],
"description": "Status of component"
},
"showcase": {
"type": "boolean",
"description": "Should this component be showcased"
},
"only_show_if_degraded": {
"type": "boolean",
"description": "Requires a special feature flag to be enabled"
},
"automation_email": {
"type": "string",
"description": "Requires a special feature flag to be enabled"
}
},
"description": "Add page access groups to a component"
}
postPagesPageIdSubscribersResendConfirmation
{
"type": "object",
"properties": {
"subscribers": {
"type": "string",
"description": "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."
}
},
"required": [
"subscribers"
],
"description": "Resend confirmations to a list of subscribers",
"title": "postPagesPageIdSubscribersResendConfirmation"
}
postPagesPageIdSubscribersUnsubscribe
{
"type": "object",
"properties": {
"subscribers": {
"type": "string",
"description": "The array of subscriber codes to unsubscribe, or \"all\" to unsubscribe all subscribers."
},
"type": {
"type": "string",
"description": "If this is present, only unsubscribe subscribers of this type.",
"enum": [
"email",
"sms",
"webhook",
"integration_partner"
]
},
"state": {
"type": "string",
"description": "If this is present, only unsubscribe subscribers in this state. Specify state \"all\" to unsubscribe subscribers in any states.",
"enum": [
"active",
"unconfirmed",
"quarantined",
"all"
],
"default": "active"
},
"skip_unsubscription_notification": {
"type": "boolean",
"description": "If skip_unsubscription_notification is true, the subscribers do not receive any notifications when they are unsubscribed."
}
},
"required": [
"subscribers"
],
"description": "Unsubscribe a list of subscribers",
"title": "postPagesPageIdSubscribersUnsubscribe"
}
postPagesPageIdSubscribersReactivate
{
"type": "object",
"properties": {
"subscribers": {
"type": "string",
"description": "The array of subscriber codes to reactivate, or \"all\" to reactivate all subscribers."
},
"type": {
"type": "string",
"description": "If this is present, only reactivate subscribers of this type.",
"enum": [
"email",
"sms",
"webhook",
"integration_partner"
]
}
},
"required": [
"subscribers"
],
"description": "Reactivate a list of subscribers",
"title": "postPagesPageIdSubscribersReactivate"
}
SubscriberCountByTypeAndState
{
"type": "object",
"properties": {
"email": {
"$ref": "#/components/schemas/SubscriberCountByState"
},
"sms": {
"$ref": "#/components/schemas/SubscriberCountByState"
},
"webhook": {
"$ref": "#/components/schemas/SubscriberCountByState"
},
"integration_partner": {
"$ref": "#/components/schemas/SubscriberCountByState"
}
},
"description": "Get a histogram of subscribers by type and then state"
}
SubscriberCountByState
{
"type": "object",
"properties": {
"active": {
"type": "integer",
"format": "int32",
"description": "The number of active subscribers found by the query."
},
"unconfirmed": {
"type": "integer",
"format": "int32",
"description": "The number of unconfirmed subscribers found by the query."
},
"quarantined": {
"type": "integer",
"format": "int32",
"description": "The number of quarantined subscribers found by the query."
},
"total": {
"type": "integer",
"format": "int32",
"description": "The total number of subscribers found by the query."
}
}
}
SubscriberCountByType
{
"type": "object",
"properties": {
"email": {
"type": "integer",
"format": "int32",
"description": "The number of Email subscribers found by the query."
},
"sms": {
"type": "integer",
"format": "int32",
"description": "The number of Webhook subscribers found by the query."
},
"webhook": {
"type": "integer",
"format": "int32",
"description": "The number of SMS subscribers found by the query."
},
"integration_partner": {
"type": "integer",
"format": "int32",
"description": "The number of integration partners found by the query."
}
},
"description": "Get a count of subscribers by type"
}
Subscriber
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "p3g5j51ld25x",
"description": "Subscriber Identifier"
},
"skip_confirmation_notification": {
"type": "boolean",
"description": "If this is true, do not notify the user with changes to their subscription."
},
"mode": {
"type": "string",
"example": "email",
"description": "The communication mode of the subscriber."
},
"email": {
"type": "string",
"example": "foo@example2.com",
"description": "The email address to use to contact the subscriber. Used for Email and Webhook subscribers."
},
"endpoint": {
"type": "string",
"example": "http://example.com/",
"description": "The URL where a webhook subscriber elects to receive updates."
},
"phone_number": {
"type": "string",
"example": "202-555-0105",
"description": "The phone number used to contact an SMS subscriber"
},
"phone_country": {
"type": "string",
"example": "US",
"description": "The two-character country code representing the country of which the phone_number is a part."
},
"display_phone_number": {
"type": "string",
"example": "+1 (202) 555-0105",
"description": "A formatted version of the phone_number and phone_country pair, nicely formatted for display."
},
"quarantined_at": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the subscriber was quarantined due to an issue reaching them."
},
"purge_at": {
"type": "string",
"format": "date-time",
"description": "The timestamp when a quarantined subscriber will be purged (unsubscribed)."
},
"components": {
"type": "string",
"example": [
"jc1tsf09v7kc"
],
"description": "The components for which the subscriber has elected to receive updates."
},
"page_access_user_id": {
"type": "string",
"example": "z0nnrh1dvgf8",
"description": "The Page Access user this subscriber belongs to (only for audience-specific pages)."
},
"created_at": {
"type": "string",
"format": "date-time"
}
},
"description": "Get an incident subscriber"
}
postPagesPageIdSubscribers
{
"type": "object",
"properties": {
"subscriber": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email address for creating Email and Webhook subscribers."
},
"endpoint": {
"type": "string",
"description": "The endpoint URI for creating Webhook subscribers."
},
"phone_country": {
"type": "string",
"description": "The two-character country where the phone number is located to use for the new SMS subscriber."
},
"phone_number": {
"type": "string",
"description": "The phone number (as you would dial from the phone_country) to use for the new SMS subscriber."
},
"skip_confirmation_notification": {
"type": "boolean",
"description": "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."
},
"page_access_user": {
"type": "string",
"description": "The code of the page access user to which the subscriber belongs."
},
"component_ids": {
"type": "array",
"description": "A list of component ids for which the subscriber should recieve updates for. Components must be an array with at least one element if it is passed at all. Each component must belong to the page indicated in the path.",
"items": {
"type": "string"
}
}
}
}
},
"description": "Create a subscriber",
"title": "postPagesPageIdSubscribers"
}
IncidentTemplate
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "h1sn7q43mvmf",
"description": "Incident Template Identifier"
},
"name": {
"type": "string",
"description": "Name of incident template, as shown in list on incident page"
},
"title": {
"type": "string",
"description": "Title to be applied to the incident when selecting this template"
},
"body": {
"type": "string",
"description": "Body of incident update to be applied when selecting this template"
},
"group_id": {
"type": "string",
"example": "rf6y72kl39xy",
"description": "Identifier of Incident Template Group this template belongs to"
},
"update_status": {
"type": "string",
"enum": [
"investigating",
"identified",
"monitoring",
"resolved",
"scheduled",
"in_progress",
"verifying",
"completed"
],
"description": "The status the incident should transition to when selecting this template"
},
"should_tweet": {
"type": "boolean",
"description": "Whether the \"tweet update\" checkbox should be selected when selecting this template"
},
"should_send_notifications": {
"type": "boolean",
"description": "Whether the \"deliver notifications\" checkbox should be selected when selecting this template"
}
},
"description": "Get a list of incident templates"
}
postPagesPageIdIncidents
{
"type": "object",
"properties": {
"incident": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Incident Name"
},
"status": {
"type": "string",
"description": "Incident status",
"enum": [
"scheduled",
"identified",
"in_progress",
"verifying",
"monitoring",
"completed",
"postmortem",
"investigating",
"update",
"resolved"
]
},
"impact_override": {
"type": "string",
"description": "value to override calculated impact value",
"enum": [
"maintenance",
"major",
"none",
"minor",
"critical"
]
},
"scheduled_for": {
"type": "string",
"format": "date-time",
"description": "The timestamp the incident is scheduled for."
},
"scheduled_until": {
"type": "string",
"format": "date-time",
"description": "The timestamp the incident is scheduled until."
},
"scheduled_remind_prior": {
"type": "boolean",
"description": "Controls whether to remind subscribers prior to scheduled incidents."
},
"scheduled_auto_in_progress": {
"type": "boolean",
"description": "Controls whether the incident is scheduled to automatically change to in progress."
},
"scheduled_auto_completed": {
"type": "boolean",
"description": "Controls whether the incident is scheduled to automatically change to complete."
},
"metadata": {
"type": "object",
"description": "Attach a json object to the incident. All top-level values in the object must also be objects."
},
"deliver_notifications": {
"type": "boolean",
"description": "Deliver notifications to subscribers if this is true. If this is false, create an incident without notifying customers.",
"default": true
},
"auto_transition_deliver_notifications_at_end": {
"type": "boolean",
"description": "Controls whether send notification when scheduled maintenances auto transition to completed."
},
"auto_transition_deliver_notifications_at_start": {
"type": "boolean",
"description": "Controls whether send notification when scheduled maintenances auto transition to started."
},
"auto_transition_to_maintenance_state": {
"type": "boolean",
"description": "Controls whether change components status to under_maintenance once scheduled maintenance is in progress."
},
"auto_transition_to_operational_state": {
"type": "boolean",
"description": "Controls whether change components status to operational once scheduled maintenance completes."
},
"auto_tweet_at_beginning": {
"type": "boolean",
"description": "Controls whether tweet automatically when scheduled maintenance starts."
},
"auto_tweet_on_completion": {
"type": "boolean",
"description": "Controls whether tweet automatically when scheduled maintenance completes."
},
"auto_tweet_on_creation": {
"type": "boolean",
"description": "Controls whether tweet automatically when scheduled maintenance is created."
},
"auto_tweet_one_hour_before": {
"type": "boolean",
"description": "Controls whether tweet automatically one hour before scheduled maintenance starts."
},
"backfill_date": {
"type": "string",
"description": "TimeStamp when incident was backfilled."
},
"backfilled": {
"type": "boolean",
"description": "Controls whether incident is backfilled. If true, components cannot be specified."
},
"body": {
"type": "string",
"description": "The initial message, created as the first incident update."
},
"components": {
"type": "object",
"description": "Map of status changes to apply to affected components",
"properties": {
"component_id": {
"type": "string",
"description": "Map of status changes to apply to affected components",
"enum": [
"operational",
"under_maintenance",
"degraded_performance",
"partial_outage",
"major_outage",
""
]
}
}
},
"component_ids": {
"type": "array",
"description": "List of component_ids affected by this incident",
"items": {
"type": "string",
"default": "wyv962tzxxh1"
}
},
"scheduled_auto_transition": {
"type": "boolean",
"description": "Same as :scheduled_auto_transition_in_progress. Controls whether the incident is scheduled to automatically change to in progress."
}
},
"required": [
"name"
]
}
},
"description": "Create an incident",
"title": "postPagesPageIdIncidents"
}
Incident
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "l93lfsx5v11z",
"description": "Incident Identifier"
},
"components": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Component"
},
"description": "Incident components"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the incident was created at."
},
"impact": {
"type": "string",
"example": "critical",
"description": "The impact of the incident."
},
"impact_override": {
"type": "string",
"example": "minor",
"description": "value to override calculated impact value"
},
"incident_updates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IncidentUpdate"
},
"description": "The incident updates for incident."
},
"monitoring_at": {
"type": "string",
"format": "date-time",
"description": "The timestamp when incident entered monitoring state."
},
"name": {
"type": "string",
"example": "Data Layer Migration",
"description": "Incident Name"
},
"page_id": {
"type": "string",
"description": "Incident Page Identifier"
},
"postmortem_body": {
"type": "string",
"example": "##### Issue\nAt approximately 17:02 UTC on 2013-04-21, our master database server unexpectedly went unresponsive to all network.\nA reboot of the machine at 17:05 UTC resulted in a failed mount of a corrupted EBS volume, and we made the decision\nat that time to fail over the slave database.\n\n##### Resolution\nAt 17:12 UTC, the slave database had been successfully promoted to master and the application recovered enough to\naccept web traffic again. A new slave database node was created and placed into the rotation to guard against future\nmaster failures. The promoted slave database performed slowly for the next couple of hours as the query cache began\nto warm up, and eventually settled into a reasonable performance profile around 20:00 UTC.\n\n##### Future Mitigation Plans\nOver the past few months, we have been working on an overhaul to our data storage layer with a migration from a Postgres\nsetup to a distributed, fault-tolerant, multi-region data layer using Riak. This initiative has been prioritized, and\nthe migration will be performed in the coming weeks. We will notify our clients of the scheduled downtime via an\nincident on this status site, and via a blog post.\n",
"description": "Body of the Postmortem."
},
"postmortem_body_last_updated_at": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the incident postmortem body was last updated at."
},
"postmortem_ignored": {
"type": "boolean",
"description": "Controls whether the incident will have postmortem."
},
"postmortem_notified_subscribers": {
"type": "boolean",
"description": "Indicates whether subscribers are already notificed about postmortem."
},
"postmortem_notified_twitter": {
"type": "boolean",
"description": "Controls whether to decide if notify postmortem on twitter."
},
"postmortem_published_at": {
"type": "boolean",
"description": "The timestamp when the postmortem was published."
},
"resolved_at": {
"type": "string",
"format": "date-time",
"description": "The timestamp when incident was resolved."
},
"scheduled_auto_completed": {
"type": "boolean",
"description": "Controls whether the incident is scheduled to automatically change to complete."
},
"scheduled_auto_in_progress": {
"type": "boolean",
"description": "Controls whether the incident is scheduled to automatically change to in progress."
},
"scheduled_for": {
"type": "string",
"format": "date-time",
"description": "The timestamp the incident is scheduled for."
},
"scheduled_remind_prior": {
"type": "boolean",
"description": "Controls whether to remind subscribers prior to scheduled incidents."
},
"scheduled_reminded_at": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the scheduled incident reminder was sent at."
},
"scheduled_until": {
"type": "string",
"format": "date-time",
"description": "The timestamp the incident is scheduled until."
},
"shortlink": {
"type": "string",
"example": "http://stspg.io/803310a12",
"description": "Incident Shortlink."
},
"status": {
"type": "string",
"example": "scheduled",
"description": "Incident status"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the incident was updated at."
}
},
"description": "Get an incident"
}
IncidentUpdate
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Incident Update Identifier."
},
"incident_id": {
"type": "string",
"description": "Incident Identifier."
},
"affected_components": {
"type": "array",
"items": {
"type": "string"
},
"description": "Affected components."
},
"body": {
"type": "string",
"description": "Incident update body."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the incident update was created at."
},
"custom_tweet": {
"type": "string",
"description": "An optional customized tweet message for incident postmortem."
},
"deliver_notifications": {
"type": "boolean",
"description": "Controls whether to delivery notifications."
},
"display_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when incident update is happened."
},
"status": {
"type": "string",
"description": "Incident status."
},
"tweet_id": {
"type": "string",
"description": "Tweet identifier associated to this incident update."
},
"twitter_updated_at": {
"type": "string",
"format": "date-time",
"description": "The timestamp when twitter updated at."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the incident update is updated."
},
"wants_twitter_update": {
"type": "boolean",
"description": "Controls whether to create twitter update."
}
},
"description": "Update a previous incident update"
}
patchPagesPageIdIncidents
{
"type": "object",
"properties": {
"incident": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Incident Name"
},
"status": {
"type": "string",
"description": "Incident status",
"enum": [
"scheduled",
"identified",
"in_progress",
"verifying",
"monitoring",
"completed",
"postmortem",
"investigating",
"update",
"resolved"
]
},
"impact_override": {
"type": "string",
"description": "value to override calculated impact value",
"enum": [
"maintenance",
"major",
"none",
"minor",
"critical"
]
},
"scheduled_for": {
"type": "string",
"format": "date-time",
"description": "The timestamp the incident is scheduled for."
},
"scheduled_until": {
"type": "string",
"format": "date-time",
"description": "The timestamp the incident is scheduled until."
},
"scheduled_remind_prior": {
"type": "boolean",
"description": "Controls whether to remind subscribers prior to scheduled incidents."
},
"scheduled_auto_in_progress": {
"type": "boolean",
"description": "Controls whether the incident is scheduled to automatically change to in progress."
},
"scheduled_auto_completed": {
"type": "boolean",
"description": "Controls whether the incident is scheduled to automatically change to complete."
},
"metadata": {
"type": "object",
"description": "Attach a json object to the incident. All top-level values in the object must also be objects."
},
"deliver_notifications": {
"type": "boolean",
"description": "Deliver notifications to subscribers if this is true. If this is false, create an incident without notifying customers.",
"default": true
},
"auto_transition_deliver_notifications_at_end": {
"type": "boolean",
"description": "Controls whether send notification when scheduled maintenances auto transition to completed."
},
"auto_transition_deliver_notifications_at_start": {
"type": "boolean",
"description": "Controls whether send notification when scheduled maintenances auto transition to started."
},
"auto_transition_to_maintenance_state": {
"type": "boolean",
"description": "Controls whether change components status to under_maintenance once scheduled maintenance is in progress."
},
"auto_transition_to_operational_state": {
"type": "boolean",
"description": "Controls whether change components status to operational once scheduled maintenance completes."
},
"auto_tweet_at_beginning": {
"type": "boolean",
"description": "Controls whether tweet automatically when scheduled maintenance starts."
},
"auto_tweet_on_completion": {
"type": "boolean",
"description": "Controls whether tweet automatically when scheduled maintenance completes."
},
"auto_tweet_on_creation": {
"type": "boolean",
"description": "Controls whether tweet automatically when scheduled maintenance is created."
},
"auto_tweet_one_hour_before": {
"type": "boolean",
"description": "Controls whether tweet automatically one hour before scheduled maintenance starts."
},
"backfill_date": {
"type": "string",
"description": "TimeStamp when incident was backfilled."
},
"backfilled": {
"type": "boolean",
"description": "Controls whether incident is backfilled. If true, components cannot be specified."
},
"body": {
"type": "string",
"description": "The initial message, created as the first incident update."
},
"components": {
"type": "object",
"description": "Map of status changes to apply to affected components",
"properties": {
"component_id": {
"type": "string",
"description": "Map of status changes to apply to affected components",
"enum": [
"operational",
"under_maintenance",
"degraded_performance",
"partial_outage",
"major_outage",
""
]
}
}
},
"component_ids": {
"type": "array",
"description": "List of component_ids affected by this incident",
"items": {
"type": "string",
"default": "x9t0tt2728zm"
}
},
"scheduled_auto_transition": {
"type": "boolean",
"description": "Same as :scheduled_auto_transition_in_progress. Controls whether the incident is scheduled to automatically change to in progress."
}
}
}
},
"description": "Update an incident",
"title": "patchPagesPageIdIncidents"
}
putPagesPageIdIncidents
{
"type": "object",
"properties": {
"incident": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Incident Name"
},
"status": {
"type": "string",
"description": "Incident status",
"enum": [
"scheduled",
"identified",
"in_progress",
"verifying",
"monitoring",
"completed",
"postmortem",
"investigating",
"update",
"resolved"
]
},
"impact_override": {
"type": "string",
"description": "value to override calculated impact value",
"enum": [
"maintenance",
"major",
"none",
"minor",
"critical"
]
},
"scheduled_for": {
"type": "string",
"format": "date-time",
"description": "The timestamp the incident is scheduled for."
},
"scheduled_until": {
"type": "string",
"format": "date-time",
"description": "The timestamp the incident is scheduled until."
},
"scheduled_remind_prior": {
"type": "boolean",
"description": "Controls whether to remind subscribers prior to scheduled incidents."
},
"scheduled_auto_in_progress": {
"type": "boolean",
"description": "Controls whether the incident is scheduled to automatically change to in progress."
},
"scheduled_auto_completed": {
"type": "boolean",
"description": "Controls whether the incident is scheduled to automatically change to complete."
},
"metadata": {
"type": "object",
"description": "Attach a json object to the incident. All top-level values in the object must also be objects."
},
"deliver_notifications": {
"type": "boolean",
"description": "Deliver notifications to subscribers if this is true. If this is false, create an incident without notifying customers.",
"default": true
},
"auto_transition_deliver_notifications_at_end": {
"type": "boolean",
"description": "Controls whether send notification when scheduled maintenances auto transition to completed."
},
"auto_transition_deliver_notifications_at_start": {
"type": "boolean",
"description": "Controls whether send notification when scheduled maintenances auto transition to started."
},
"auto_transition_to_maintenance_state": {
"type": "boolean",
"description": "Controls whether change components status to under_maintenance once scheduled maintenance is in progress."
},
"auto_transition_to_operational_state": {
"type": "boolean",
"description": "Controls whether change components status to operational once scheduled maintenance completes."
},
"auto_tweet_at_beginning": {
"type": "boolean",
"description": "Controls whether tweet automatically when scheduled maintenance starts."
},
"auto_tweet_on_completion": {
"type": "boolean",
"description": "Controls whether tweet automatically when scheduled maintenance completes."
},
"auto_tweet_on_creation": {
"type": "boolean",
"description": "Controls whether tweet automatically when scheduled maintenance is created."
},
"auto_tweet_one_hour_before": {
"type": "boolean",
"description": "Controls whether tweet automatically one hour before scheduled maintenance starts."
},
"backfill_date": {
"type": "string",
"description": "TimeStamp when incident was backfilled."
},
"backfilled": {
"type": "boolean",
"description": "Controls whether incident is backfilled. If true, components cannot be specified."
},
"body": {
"type": "string",
"description": "The initial message, created as the first incident update."
},
"components": {
"type": "object",
"description": "Map of status changes to apply to affected components",
"properties": {
"component_id": {
"type": "string",
"description": "Map of status changes to apply to affected components",
"enum": [
"operational",
"under_maintenance",
"degraded_performance",
"partial_outage",
"major_outage",
""
]
}
}
},
"component_ids": {
"type": "array",
"description": "List of component_ids affected by this incident",
"items": {
"type": "string",
"default": "x9t0tt2728zm"
}
},
"scheduled_auto_transition": {
"type": "boolean",
"description": "Same as :scheduled_auto_transition_in_progress. Controls whether the incident is scheduled to automatically change to in progress."
}
}
}
},
"description": "Update an incident",
"title": "putPagesPageIdIncidents"
}
patchPagesPageIdIncidentsIncidentIdIncidentUpdates
{
"type": "object",
"properties": {
"incident_update": {
"type": "object",
"properties": {
"wants_twitter_update": {
"type": "boolean",
"description": "Controls whether to create twitter update."
},
"body": {
"type": "string",
"description": "Incident update body."
},
"display_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when incident update is happened."
},
"deliver_notifications": {
"type": "boolean",
"description": "Controls whether to delivery notifications."
}
}
}
},
"description": "Update a previous incident update",
"title": "patchPagesPageIdIncidentsIncidentIdIncidentUpdates"
}
putPagesPageIdIncidentsIncidentIdIncidentUpdates
{
"type": "object",
"properties": {
"incident_update": {
"type": "object",
"properties": {
"wants_twitter_update": {
"type": "boolean",
"description": "Controls whether to create twitter update."
},
"body": {
"type": "string",
"description": "Incident update body."
},
"display_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when incident update is happened."
},
"deliver_notifications": {
"type": "boolean",
"description": "Controls whether to delivery notifications."
}
}
}
},
"description": "Update a previous incident update",
"title": "putPagesPageIdIncidentsIncidentIdIncidentUpdates"
}
postPagesPageIdIncidentsIncidentIdSubscribers
{
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email address for creating Email subscribers."
},
"phone_country": {
"type": "string",
"description": "The two-character country where the phone number is located to use for the new SMS subscriber."
},
"phone_number": {
"type": "string",
"description": "The phone number (as you would dial from the phone_country) to use for the new SMS subscriber."
},
"skip_confirmation_notification": {
"type": "boolean",
"description": "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."
}
},
"description": "Create an incident subscriber",
"title": "postPagesPageIdIncidentsIncidentIdSubscribers"
}
Postmortem
{
"type": "object",
"properties": {
"preview_key": {
"type": "string",
"description": "Preview Key"
},
"body": {
"type": "string",
"description": "Postmortem body"
},
"body_updated_at": {
"type": "string",
"format": "date-time"
},
"body_draft": {
"type": "string",
"description": "Body draft"
},
"body_draft_updated_at": {
"type": "string",
"format": "date-time"
},
"published_at": {
"type": "string",
"format": "date-time"
},
"notify_subscribers": {
"type": "boolean",
"description": "Should email subscribers be notified."
},
"notify_twitter": {
"type": "boolean",
"description": "Should Twitter followers be notified."
},
"custom_tweet": {
"type": "string",
"description": "Custom tweet for Incident Postmortem"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"description": "Revert Postmortem"
}
putPagesPageIdIncidentsIncidentIdPostmortem
{
"type": "object",
"properties": {
"postmortem": {
"type": "object",
"properties": {
"body_draft": {
"type": "string",
"description": "Body of Postmortem to create."
}
},
"required": [
"body_draft"
]
}
},
"description": "Create Postmortem",
"title": "putPagesPageIdIncidentsIncidentIdPostmortem"
}
putPagesPageIdIncidentsIncidentIdPostmortemPublish
{
"type": "object",
"properties": {
"postmortem": {
"type": "object",
"properties": {
"notify_twitter": {
"type": "boolean",
"description": "Whether to notify Twitter followers"
},
"notify_subscribers": {
"type": "boolean",
"description": "Whether to notify e-mail subscribers"
},
"custom_tweet": {
"type": "string",
"description": "Custom postmortem tweet to publish"
}
}
}
},
"description": "Publish Postmortem",
"title": "putPagesPageIdIncidentsIncidentIdPostmortemPublish"
}
postPagesPageIdComponents
{
"type": "object",
"properties": {
"component": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "More detailed description for component"
},
"status": {
"type": "string",
"description": "Status of component",
"enum": [
"operational",
"under_maintenance",
"degraded_performance",
"partial_outage",
"major_outage",
""
]
},
"name": {
"type": "string",
"description": "Display name for component"
},
"only_show_if_degraded": {
"type": "boolean",
"description": "Requires a special feature flag to be enabled"
},
"group_id": {
"type": "string",
"description": "Component Group identifier"
},
"showcase": {
"type": "boolean",
"description": "Should this component be showcased"
}
}
}
},
"description": "Create a component",
"title": "postPagesPageIdComponents"
}
patchPagesPageIdComponents
{
"type": "object",
"properties": {
"component": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "More detailed description for component"
},
"status": {
"type": "string",
"description": "Status of component",
"enum": [
"operational",
"under_maintenance",
"degraded_performance",
"partial_outage",
"major_outage",
""
]
},
"name": {
"type": "string",
"description": "Display name for component"
},
"only_show_if_degraded": {
"type": "boolean",
"description": "Requires a special feature flag to be enabled"
},
"group_id": {
"type": "string",
"description": "Component Group identifier"
},
"showcase": {
"type": "boolean",
"description": "Should this component be showcased"
}
}
}
},
"description": "Update a component",
"title": "patchPagesPageIdComponents"
}
putPagesPageIdComponents
{
"type": "object",
"properties": {
"component": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "More detailed description for component"
},
"status": {
"type": "string",
"description": "Status of component",
"enum": [
"operational",
"under_maintenance",
"degraded_performance",
"partial_outage",
"major_outage",
""
]
},
"name": {
"type": "string",
"description": "Display name for component"
},
"only_show_if_degraded": {
"type": "boolean",
"description": "Requires a special feature flag to be enabled"
},
"group_id": {
"type": "string",
"description": "Component Group identifier"
},
"showcase": {
"type": "boolean",
"description": "Should this component be showcased"
}
}
}
},
"description": "Update a component",
"title": "putPagesPageIdComponents"
}
postPagesPageIdComponentGroups
{
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description of the component group."
},
"component_group": {
"type": "object",
"properties": {
"components": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
}
},
"required": [
"components",
"name"
]
}
},
"description": "Create a component group",
"title": "postPagesPageIdComponentGroups"
}
GroupComponent
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "nwkf2yd0g2pf",
"description": "Component Group Identifier"
},
"page_id": {
"type": "string"
},
"name": {
"type": "string",
"example": "API Components"
},
"description": {
"type": "string"
},
"components": {
"type": "string",
"example": [
"abc123",
"abc124"
]
},
"position": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"description": "Get a component group"
}
patchPagesPageIdComponentGroups
{
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Updated description of the component group."
},
"component_group": {
"type": "object",
"properties": {
"components": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
}
},
"required": [
"components",
"name"
]
}
},
"description": "Update a component group",
"title": "patchPagesPageIdComponentGroups"
}
putPagesPageIdComponentGroups
{
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Updated description of the component group."
},
"component_group": {
"type": "object",
"properties": {
"components": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
}
},
"required": [
"components",
"name"
]
}
},
"description": "Update a component group",
"title": "putPagesPageIdComponentGroups"
}
MetricAddResponse
{
"type": "object",
"properties": {
"metric_id": {
"type": "object",
"properties": {
"timestamp": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "number",
"format": "float"
}
},
"description": "Metric identifier to add data to"
}
},
"description": "Add data points to metrics"
}
postPagesPageIdMetricsData
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/MetricAddResponse"
}
},
"required": [
"data"
],
"description": "Add data points to metrics",
"title": "postPagesPageIdMetricsData"
}
Metric
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Metric identifier"
},
"metrics_provider_id": {
"type": "string",
"description": "Metric Provider identifier"
},
"metrics_display_id": {
"type": "string",
"description": "Metric Display identifier"
},
"name": {
"type": "string",
"description": "Name of metric"
},
"display": {
"type": "boolean",
"description": "Should the metric be displayed"
},
"tooltip_description": {
"type": "string"
},
"backfilled": {
"type": "boolean"
},
"y_axis_min": {
"type": "integer",
"format": "int32"
},
"y_axis_max": {
"type": "integer",
"format": "int32"
},
"y_axis_hidden": {
"type": "boolean",
"description": "Should the values on the y axis be hidden on render"
},
"suffix": {
"type": "string",
"description": "Suffix to describe the units on the graph"
},
"decimal_places": {
"type": "integer",
"format": "int32"
},
"most_recent_data_at": {
"type": "string",
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"description": "Create a metric for a metric provider"
}
patchPagesPageIdMetrics
{
"type": "object",
"properties": {
"metric": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of metric"
}
}
}
},
"description": "Update a metric",
"title": "patchPagesPageIdMetrics"
}
putPagesPageIdMetrics
{
"type": "object",
"properties": {
"metric": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of metric"
}
}
}
},
"description": "Update a metric",
"title": "putPagesPageIdMetrics"
}
postPagesPageIdMetricsMetricIdData
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "integer",
"format": "int32",
"description": "Time to store the metric against"
},
"value": {
"type": "number",
"format": "float"
}
}
}
},
"required": [
"data"
],
"description": "Add data to a metric",
"title": "postPagesPageIdMetricsMetricIdData"
}
SingleMetricAddResponse
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"timestamp": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "number",
"format": "float"
}
}
}
},
"description": "Add data to a metric"
}
MetricsProvider
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Identifier for Metrics Provider"
},
"name": {
"type": "string",
"description": "Display name for the metric."
},
"metric_identifier": {
"type": "string"
},
"suffix": {
"type": "string",
"description": "Suffix or units for the metric."
},
"display": {
"type": "string",
"description": "Boolean to determine whether or not to show metric immediately on page."
},
"tooltip_description": {
"type": "string",
"description": "Description of the metric as displayed on the page in a tooltip."
},
"y_axis_min": {
"type": "string",
"description": "Minimum value for Y-axis display"
},
"y_axis_max": {
"type": "string",
"description": "Maximum value for Y-axis display"
},
"decimal_places": {
"type": "string",
"description": "Amount of decimal values to use in display in values and average over a time period."
},
"type": {
"type": "string"
},
"email": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"api_key": {
"type": "string"
},
"api_token": {
"type": "string"
},
"application_key": {
"type": "string"
},
"account_id": {
"type": "string"
},
"last_revalidated_at": {
"type": "string",
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"description": "Delete a metric provider"
}
postPagesPageIdMetricsProviders
{
"type": "object",
"properties": {
"metrics_provider": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Required by the Librato and Pingdom type metrics providers."
},
"password": {
"type": "string",
"description": "Required by the Pingdom-type metrics provider."
},
"api_key": {
"type": "string",
"description": "Required by the Datadog and NewRelic type metrics providers."
},
"api_token": {
"type": "string",
"description": "Required by the Librato and Datadog type metrics providers."
},
"application_key": {
"type": "string",
"description": "Required by the Pingdom-type metrics provider."
},
"type": {
"type": "string",
"description": "One of \"Pingdom\", \"NewRelic\", \"Librato\", \"Datadog\", or \"Self\""
}
}
}
},
"description": "Create a metric provider",
"title": "postPagesPageIdMetricsProviders"
}
patchPagesPageIdMetricsProviders
{
"type": "object",
"properties": {
"metrics_provider": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"api_key": {
"type": "string"
},
"api_token": {
"type": "string"
},
"application_key": {
"type": "string"
},
"account_id": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
},
"description": "Update a metric provider",
"title": "patchPagesPageIdMetricsProviders"
}
putPagesPageIdMetricsProviders
{
"type": "object",
"properties": {
"metrics_provider": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"api_key": {
"type": "string"
},
"api_token": {
"type": "string"
},
"application_key": {
"type": "string"
},
"account_id": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
},
"description": "Update a metric provider",
"title": "putPagesPageIdMetricsProviders"
}
postPagesPageIdMetricsProvidersMetricsProviderIdMetrics
{
"type": "object",
"properties": {
"metric": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of metric"
},
"metric_identifier": {
"type": "string",
"description": "The identifier used to look up the metric data from the provider"
},
"transform": {
"type": "string",
"description": "The transform to apply to metric before pulling into Statuspage. One of: \"average\", \"count\", \"max\", \"min\", or \"sum\""
},
"suffix": {
"type": "string",
"description": "Suffix to describe the units on the graph"
},
"y_axis_min": {
"type": "integer",
"format": "int32",
"description": "The lower bound of the y axis"
},
"y_axis_max": {
"type": "integer",
"format": "int32",
"description": "The upper bound of the y axis"
},
"y_axis_hidden": {
"type": "boolean",
"description": "Should the values on the y axis be hidden on render"
},
"display": {
"type": "boolean",
"description": "Should the metric be displayed"
},
"decimal_places": {
"type": "integer",
"format": "int32",
"description": "How many decimal places to render on the graph"
},
"tooltip_description": {
"type": "string"
}
}
}
},
"description": "Create a metric for a metric provider",
"title": "postPagesPageIdMetricsProvidersMetricsProviderIdMetrics"
}
StatusEmbedConfig
{
"type": "object",
"properties": {
"page_id": {
"type": "string",
"description": "Page identifier"
},
"position": {
"type": "string",
"description": "Corner where status embed iframe will appear on page"
},
"incident_background_color": {
"type": "string",
"description": "Color of status embed iframe background when displaying incident"
},
"incident_text_color": {
"type": "string",
"description": "Color of status embed iframe text when displaying incident"
},
"maintenance_background_color": {
"type": "string",
"description": "Color of status embed iframe background when displaying maintenance"
},
"maintenance_text_color": {
"type": "string",
"description": "Color of status embed iframe text when displaying maintenance"
}
},
"description": "Update status embed config settings"
}
patchPagesPageIdStatusEmbedConfig
{
"type": "object",
"properties": {
"status_embed_config": {
"type": "object",
"properties": {
"position": {
"type": "string",
"description": "Corner where status embed iframe will appear on page"
},
"incident_background_color": {
"type": "string",
"description": "Color of status embed iframe background when displaying incident"
},
"incident_text_color": {
"type": "string",
"description": "Color of status embed iframe text when displaying incident"
},
"maintenance_background_color": {
"type": "string",
"description": "Color of status embed iframe background when displaying maintenance"
},
"maintenance_text_color": {
"type": "string",
"description": "Color of status embed iframe text when displaying maintenance"
}
}
}
},
"description": "Update status embed config settings",
"title": "patchPagesPageIdStatusEmbedConfig"
}
putPagesPageIdStatusEmbedConfig
{
"type": "object",
"properties": {
"status_embed_config": {
"type": "object",
"properties": {
"position": {
"type": "string",
"description": "Corner where status embed iframe will appear on page"
},
"incident_background_color": {
"type": "string",
"description": "Color of status embed iframe background when displaying incident"
},
"incident_text_color": {
"type": "string",
"description": "Color of status embed iframe text when displaying incident"
},
"maintenance_background_color": {
"type": "string",
"description": "Color of status embed iframe background when displaying maintenance"
},
"maintenance_text_color": {
"type": "string",
"description": "Color of status embed iframe text when displaying maintenance"
}
}
}
},
"description": "Update status embed config settings",
"title": "putPagesPageIdStatusEmbedConfig"
}
User
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "User identifier"
},
"organization_id": {
"type": "string",
"description": "Organization identifier"
},
"email": {
"type": "string",
"description": "Email address for the team member"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"description": "Get a list of users"
}
postOrganizationsOrganizationIdUsers
{
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email address for the team member"
},
"password": {
"type": "string",
"description": "Password the team member uses to access the site"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
}
}
}
},
"required": [
"user"
],
"description": "Create a user",
"title": "postOrganizationsOrganizationIdUsers"
}
bodies_patchPagesPageIdPageAccessUsersPageAccessUserIdComponents
{
"type": "object",
"properties": {
"component_ids": {
"description": "List of component codes to allow access to",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"component_ids"
]
}
bodies
{
"type": "object",
"properties": {
"component_ids": {
"description": "List of component codes to allow access to",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"component_ids"
],
"title": "bodies_patchPagesPageIdPageAccessUsersPageAccessUserIdComponents"
}
bodies_deletePagesPageIdPageAccessUsersPageAccessUserIdComponents
{
"type": "object",
"properties": {
"component_ids": {
"description": "List of components codes to remove. If omitted, all components will be removed.",
"type": "array",
"items": {
"type": "string"
}
}
}
}
bodies_postPagesPageIdComponentsComponentIdPageAccessUsers
{
"type": "object",
"properties": {
"page_access_user_ids": {
"description": "List of page access users to add to compponent",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"page_access_user_ids"
]
}