Skip to content

bsneade/statuspageio-python

BranchesTags

Repository files navigation

statuspageio-python

Code of Conduct Please don't abuse the API, and please report all feature requests and issues to https://help.statuspage.io/help/contact-us-30 # Rate Limiting Each API token is limited to 1 request / second as measured on a 60 second rolling window. To get this limit increased or lifted, please contact us at https://help.statuspage.io/help/contact-us-30 # Basics ## HTTPS It's required ## URL Prefix In order to maintain version integrity into the future, the API is versioned. All calls currently begin with the following prefix: https://api.statuspage.io/v1/ ## RESTful Interface Wherever possible, the API seeks to implement repeatable patterns with logical, representative URLs and descriptive HTTP verbs. Below are some examples and conventions you will see throughout the documentation. * Collections are buckets: https://api.statuspage.io/v1/pages/asdf123/incidents.json * Elements have unique IDs: https://api.statuspage.io/v1/pages/asdf123/incidents/jklm456.json * GET will retrieve information about a collection/element * POST will create an element in a collection * PATCH will update a single element * PUT will replace a single element in a collection (rarely used) * DELETE will destroy a single element ## Sending Data Information can be sent in the body as form urlencoded or JSON, but make sure the Content-Type header matches the body structure or the server gremlins will be angry. All examples are provided in JSON format, however they can easily be converted to form encoding if required. Some examples of how to convert things are below: // JSON { "incident": { "name": "test incident", "components": ["8kbf7d35c070", "vtnh60py4yd7"] } } // Form Encoded (using curl as an example): curl -X POST https://api.statuspage.io/v1/example \ -d "incident[name]=test incident" \ -d "incident[components][]=8kbf7d35c070" \ -d "incident[components][]=vtnh60py4yd7" # Authentication

This Python package is automatically generated by the OpenAPI Generator project:

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/bsneade/statuspageio-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/bsneade/statuspageio-python.git)

Then import the package:

import spio

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import spio

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import spio
from spio.rest import ApiException
from pprint import pprint

configuration = spio.Configuration()
# Configure API key authorization: api_key
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Defining host is optional and default to https://api.statuspage.io/v1
configuration.host = "https://api.statuspage.io/v1"
# Create an instance of the API class
api_instance = spio.ComponentGroupsApi(spio.ApiClient(configuration))
page_id = 'page_id_example' # str | Page identifier
id = 56 # int | 

try:
    # Delete a component group
    api_response = api_instance.delete_pages_page_id_component_groups_id(page_id, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComponentGroupsApi->delete_pages_page_id_component_groups_id: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.statuspage.io/v1

Class Method HTTP request Description
ComponentGroupsApi delete_pages_page_id_component_groups_id DELETE /pages/{page_id}/component-groups/{id} Delete a component group
ComponentGroupsApi get_pages_page_id_component_groups GET /pages/{page_id}/component-groups Get a list of component groups
ComponentGroupsApi get_pages_page_id_component_groups_id GET /pages/{page_id}/component-groups/{id} Get a component group
ComponentGroupsApi patch_pages_page_id_component_groups_id PATCH /pages/{page_id}/component-groups/{id} Update a component group
ComponentGroupsApi post_pages_page_id_component_groups POST /pages/{page_id}/component-groups Create a component group
ComponentGroupsApi put_pages_page_id_component_groups_id PUT /pages/{page_id}/component-groups/{id} Update a component group
ComponentsApi delete_pages_page_id_components_component_id DELETE /pages/{page_id}/components/{component_id} Delete a component
ComponentsApi delete_pages_page_id_components_component_id_page_access_groups DELETE /pages/{page_id}/components/{component_id}/page_access_groups Remove page access groups from a component
ComponentsApi delete_pages_page_id_components_component_id_page_access_users DELETE /pages/{page_id}/components/{component_id}/page_access_users Remove page access users from component
ComponentsApi get_pages_page_id_components GET /pages/{page_id}/components Get a list of components
ComponentsApi get_pages_page_id_components_component_id GET /pages/{page_id}/components/{component_id} Get a component
ComponentsApi patch_pages_page_id_components_component_id PATCH /pages/{page_id}/components/{component_id} Update a component
ComponentsApi post_pages_page_id_components POST /pages/{page_id}/components Create a component
ComponentsApi post_pages_page_id_components_component_id_page_access_groups POST /pages/{page_id}/components/{component_id}/page_access_groups Add page access groups to a component
ComponentsApi post_pages_page_id_components_component_id_page_access_users POST /pages/{page_id}/components/{component_id}/page_access_users Add page access users to a component
ComponentsApi put_pages_page_id_components_component_id PUT /pages/{page_id}/components/{component_id} Update a component
IncidentPostmortemApi delete_pages_page_id_incidents_incident_id_postmortem DELETE /pages/{page_id}/incidents/{incident_id}/postmortem Delete Postmortem
IncidentPostmortemApi get_pages_page_id_incidents_incident_id_postmortem GET /pages/{page_id}/incidents/{incident_id}/postmortem Get Postmortem
IncidentPostmortemApi put_pages_page_id_incidents_incident_id_postmortem PUT /pages/{page_id}/incidents/{incident_id}/postmortem Create Postmortem
IncidentPostmortemApi put_pages_page_id_incidents_incident_id_postmortem_publish PUT /pages/{page_id}/incidents/{incident_id}/postmortem/publish Publish Postmortem
IncidentPostmortemApi put_pages_page_id_incidents_incident_id_postmortem_revert PUT /pages/{page_id}/incidents/{incident_id}/postmortem/revert Revert Postmortem
IncidentSubscribersApi delete_pages_page_id_incidents_incident_id_subscribers_subscriber_id DELETE /pages/{page_id}/incidents/{incident_id}/subscribers/{subscriber_id} Unsubscribe an incident subscriber
IncidentSubscribersApi get_pages_page_id_incidents_incident_id_subscribers GET /pages/{page_id}/incidents/{incident_id}/subscribers Get a list of incident subscribers
IncidentSubscribersApi get_pages_page_id_incidents_incident_id_subscribers_subscriber_id GET /pages/{page_id}/incidents/{incident_id}/subscribers/{subscriber_id} Get an incident subscriber
IncidentSubscribersApi post_pages_page_id_incidents_incident_id_subscribers POST /pages/{page_id}/incidents/{incident_id}/subscribers Create an incident subscriber
IncidentSubscribersApi post_pages_page_id_incidents_incident_id_subscribers_subscriber_id_resend_confirmation POST /pages/{page_id}/incidents/{incident_id}/subscribers/{subscriber_id}/resend_confirmation Resend confirmation to an incident subscriber
IncidentTemplatesApi get_pages_page_id_incident_templates GET /pages/{page_id}/incident_templates Get a list of incident templates
IncidentUpdatesApi patch_pages_page_id_incidents_incident_id_incident_updates_incident_update_id PATCH /pages/{page_id}/incidents/{incident_id}/incident_updates/{incident_update_id} Update a previous incident update
IncidentUpdatesApi put_pages_page_id_incidents_incident_id_incident_updates_incident_update_id PUT /pages/{page_id}/incidents/{incident_id}/incident_updates/{incident_update_id} Update a previous incident update
IncidentsApi delete_pages_page_id_incidents_incident_id DELETE /pages/{page_id}/incidents/{incident_id} Delete an incident
IncidentsApi get_pages_page_id_incidents GET /pages/{page_id}/incidents Get a list of incidents
IncidentsApi get_pages_page_id_incidents_active_maintenance GET /pages/{page_id}/incidents/active_maintenance Get a list of active maintenances
IncidentsApi get_pages_page_id_incidents_incident_id GET /pages/{page_id}/incidents/{incident_id} Get an incident
IncidentsApi get_pages_page_id_incidents_scheduled GET /pages/{page_id}/incidents/scheduled Get a list of scheduled incidents
IncidentsApi get_pages_page_id_incidents_unresolved GET /pages/{page_id}/incidents/unresolved Get a list of unresolved incidents
IncidentsApi get_pages_page_id_incidents_upcoming GET /pages/{page_id}/incidents/upcoming Get a list of upcoming incidents
IncidentsApi patch_pages_page_id_incidents_incident_id PATCH /pages/{page_id}/incidents/{incident_id} Update an incident
IncidentsApi post_pages_page_id_incidents POST /pages/{page_id}/incidents Create an incident
IncidentsApi put_pages_page_id_incidents_incident_id PUT /pages/{page_id}/incidents/{incident_id} Update an incident
MetricProvidersApi delete_pages_page_id_metrics_providers_metrics_provider_id DELETE /pages/{page_id}/metrics_providers/{metrics_provider_id} Delete a metric provider
MetricProvidersApi get_pages_page_id_metrics_providers GET /pages/{page_id}/metrics_providers Get a list of metric providers
MetricProvidersApi get_pages_page_id_metrics_providers_metrics_provider_id GET /pages/{page_id}/metrics_providers/{metrics_provider_id} Get a metric provider
MetricProvidersApi get_pages_page_id_metrics_providers_metrics_provider_id_metrics GET /pages/{page_id}/metrics_providers/{metrics_provider_id}/metrics List metrics for a metric provider
MetricProvidersApi patch_pages_page_id_metrics_providers_metrics_provider_id PATCH /pages/{page_id}/metrics_providers/{metrics_provider_id} Update a metric provider
MetricProvidersApi post_pages_page_id_metrics_providers POST /pages/{page_id}/metrics_providers Create a metric provider
MetricProvidersApi post_pages_page_id_metrics_providers_metrics_provider_id_metrics POST /pages/{page_id}/metrics_providers/{metrics_provider_id}/metrics Create a metric for a metric provider
MetricProvidersApi put_pages_page_id_metrics_providers_metrics_provider_id PUT /pages/{page_id}/metrics_providers/{metrics_provider_id} Update a metric provider
MetricsApi delete_pages_page_id_metrics_metric_id DELETE /pages/{page_id}/metrics/{metric_id} Delete a metric
MetricsApi delete_pages_page_id_metrics_metric_id_data DELETE /pages/{page_id}/metrics/{metric_id}/data Reset data for a metric
MetricsApi get_pages_page_id_metrics GET /pages/{page_id}/metrics Get a list of metrics
MetricsApi get_pages_page_id_metrics_metric_id GET /pages/{page_id}/metrics/{metric_id} Get a metric
MetricsApi get_pages_page_id_metrics_providers_metrics_provider_id_metrics GET /pages/{page_id}/metrics_providers/{metrics_provider_id}/metrics List metrics for a metric provider
MetricsApi patch_pages_page_id_metrics_metric_id PATCH /pages/{page_id}/metrics/{metric_id} Update a metric
MetricsApi post_pages_page_id_metrics_data POST /pages/{page_id}/metrics/data Add data points to metrics
MetricsApi post_pages_page_id_metrics_metric_id_data POST /pages/{page_id}/metrics/{metric_id}/data Add data to a metric
MetricsApi post_pages_page_id_metrics_providers_metrics_provider_id_metrics POST /pages/{page_id}/metrics_providers/{metrics_provider_id}/metrics Create a metric for a metric provider
MetricsApi put_pages_page_id_metrics_metric_id PUT /pages/{page_id}/metrics/{metric_id} Update a metric
PageAccessGroupComponentsApi delete_pages_page_id_page_access_groups_page_access_group_id_components DELETE /pages/{page_id}/page_access_groups/{page_access_group_id}/components Delete components for a page access group
PageAccessGroupComponentsApi delete_pages_page_id_page_access_groups_page_access_group_id_components_component_id DELETE /pages/{page_id}/page_access_groups/{page_access_group_id}/components/{component_id} Remove a component from a page access group
PageAccessGroupComponentsApi get_pages_page_id_page_access_groups_page_access_group_id_components GET /pages/{page_id}/page_access_groups/{page_access_group_id}/components List components for a page access group
PageAccessGroupComponentsApi patch_pages_page_id_page_access_groups_page_access_group_id_components PATCH /pages/{page_id}/page_access_groups/{page_access_group_id}/components Add components to page access group
PageAccessGroupComponentsApi post_pages_page_id_page_access_groups_page_access_group_id_components POST /pages/{page_id}/page_access_groups/{page_access_group_id}/components Replace components for a page access group
PageAccessGroupComponentsApi put_pages_page_id_page_access_groups_page_access_group_id_components PUT /pages/{page_id}/page_access_groups/{page_access_group_id}/components Add components to page access group
PageAccessGroupsApi delete_pages_page_id_page_access_groups_page_access_group_id DELETE /pages/{page_id}/page_access_groups/{page_access_group_id} Remove a page access group
PageAccessGroupsApi get_pages_page_id_page_access_groups GET /pages/{page_id}/page_access_groups Get a list of page access groups
PageAccessGroupsApi get_pages_page_id_page_access_groups_page_access_group_id GET /pages/{page_id}/page_access_groups/{page_access_group_id} Get a page access group
PageAccessGroupsApi patch_pages_page_id_page_access_groups_page_access_group_id PATCH /pages/{page_id}/page_access_groups/{page_access_group_id} Update a page access group
PageAccessGroupsApi post_pages_page_id_page_access_groups POST /pages/{page_id}/page_access_groups Create a page access group
PageAccessGroupsApi put_pages_page_id_page_access_groups_page_access_group_id PUT /pages/{page_id}/page_access_groups/{page_access_group_id} Update a page access group
PageAccessUserComponentsApi delete_pages_page_id_page_access_users_page_access_user_id_components DELETE /pages/{page_id}/page_access_users/{page_access_user_id}/components Remove components for page access user
PageAccessUserComponentsApi delete_pages_page_id_page_access_users_page_access_user_id_components_component_id DELETE /pages/{page_id}/page_access_users/{page_access_user_id}/components/{component_id} Remove component for page access user
PageAccessUserComponentsApi get_pages_page_id_page_access_users_page_access_user_id_components GET /pages/{page_id}/page_access_users/{page_access_user_id}/components Get components for page access user
PageAccessUserComponentsApi patch_pages_page_id_page_access_users_page_access_user_id_components PATCH /pages/{page_id}/page_access_users/{page_access_user_id}/components Add components for page access user
PageAccessUserComponentsApi post_pages_page_id_page_access_users_page_access_user_id_components POST /pages/{page_id}/page_access_users/{page_access_user_id}/components Replace components for page access user
PageAccessUserComponentsApi put_pages_page_id_page_access_users_page_access_user_id_components PUT /pages/{page_id}/page_access_users/{page_access_user_id}/components Add components for page access user
PageAccessUserMetricsApi delete_pages_page_id_page_access_users_page_access_user_id_metrics DELETE /pages/{page_id}/page_access_users/{page_access_user_id}/metrics Delete metrics for page access user
PageAccessUserMetricsApi delete_pages_page_id_page_access_users_page_access_user_id_metrics_metric_id DELETE /pages/{page_id}/page_access_users/{page_access_user_id}/metrics/{metric_id} Delete metric for page access user
PageAccessUserMetricsApi get_pages_page_id_page_access_users_page_access_user_id_metrics GET /pages/{page_id}/page_access_users/{page_access_user_id}/metrics Get metrics for page access user
PageAccessUserMetricsApi patch_pages_page_id_page_access_users_page_access_user_id_metrics PATCH /pages/{page_id}/page_access_users/{page_access_user_id}/metrics Add metrics for page access user
PageAccessUserMetricsApi post_pages_page_id_page_access_users_page_access_user_id_metrics POST /pages/{page_id}/page_access_users/{page_access_user_id}/metrics Replace metrics for page access user
PageAccessUserMetricsApi put_pages_page_id_page_access_users_page_access_user_id_metrics PUT /pages/{page_id}/page_access_users/{page_access_user_id}/metrics Add metrics for page access user
PageAccessUsersApi delete_pages_page_id_page_access_users_page_access_user_id DELETE /pages/{page_id}/page_access_users/{page_access_user_id} Delete page access user
PageAccessUsersApi get_pages_page_id_page_access_users GET /pages/{page_id}/page_access_users Get a list of page access users
PageAccessUsersApi get_pages_page_id_page_access_users_page_access_user_id GET /pages/{page_id}/page_access_users/{page_access_user_id} Get page access user
PageAccessUsersApi patch_pages_page_id_page_access_users_page_access_user_id PATCH /pages/{page_id}/page_access_users/{page_access_user_id} Update page access user
PageAccessUsersApi post_pages_page_id_page_access_users POST /pages/{page_id}/page_access_users Add a page access user
PageAccessUsersApi put_pages_page_id_page_access_users_page_access_user_id PUT /pages/{page_id}/page_access_users/{page_access_user_id} Update page access user
PagesApi get_pages GET /pages Get a list of pages
PagesApi get_pages_page_id GET /pages/{page_id} Get a page
PagesApi patch_pages_page_id PATCH /pages/{page_id} Update a page
PagesApi put_pages_page_id PUT /pages/{page_id} Update a page
StatusEmbedConfigApi get_pages_page_id_status_embed_config GET /pages/{page_id}/status_embed_config Get status embed config settings
StatusEmbedConfigApi patch_pages_page_id_status_embed_config PATCH /pages/{page_id}/status_embed_config Update status embed config settings
StatusEmbedConfigApi put_pages_page_id_status_embed_config PUT /pages/{page_id}/status_embed_config Update status embed config settings
SubscribersApi delete_pages_page_id_subscribers_subscriber_id DELETE /pages/{page_id}/subscribers/{subscriber_id} Unsubscribe a subscriber
SubscribersApi get_pages_page_id_subscribers GET /pages/{page_id}/subscribers Get a list of subscribers
SubscribersApi get_pages_page_id_subscribers_count GET /pages/{page_id}/subscribers/count Get a count of subscribers by type
SubscribersApi get_pages_page_id_subscribers_histogram_by_state GET /pages/{page_id}/subscribers/histogram_by_state Get a histogram of subscribers by type and then state
SubscribersApi get_pages_page_id_subscribers_subscriber_id GET /pages/{page_id}/subscribers/{subscriber_id} Get a subscriber
SubscribersApi get_pages_page_id_subscribers_unsubscribed GET /pages/{page_id}/subscribers/unsubscribed Get a list of unsubscribed subscribers
SubscribersApi post_pages_page_id_subscribers POST /pages/{page_id}/subscribers Create a subscriber
SubscribersApi post_pages_page_id_subscribers_reactivate POST /pages/{page_id}/subscribers/reactivate Reactivate a list of subscribers
SubscribersApi post_pages_page_id_subscribers_resend_confirmation POST /pages/{page_id}/subscribers/resend_confirmation Resend confirmations to a list of subscribers
SubscribersApi post_pages_page_id_subscribers_subscriber_id_resend_confirmation POST /pages/{page_id}/subscribers/{subscriber_id}/resend_confirmation Resend confirmation to a subscriber
SubscribersApi post_pages_page_id_subscribers_unsubscribe POST /pages/{page_id}/subscribers/unsubscribe Unsubscribe a list of subscribers
UsersApi delete_organizations_organization_id_users_user_id DELETE /organizations/{organization_id}/users/{user_id} Delete a user
UsersApi get_organizations_organization_id_users GET /organizations/{organization_id}/users Get a list of users
UsersApi post_organizations_organization_id_users POST /organizations/{organization_id}/users Create a user

Documentation For Models

Documentation For Authorization

api_key

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

About

Generated Python client for the StatusPage.io APIs

Resources

Readme

License

Apache-2.0 license
Activity

Stars

2 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages