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": "[email protected]",
      "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": "[email protected]"
    },
    "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