squacapi_client

API for accessing squac data

This Python package is automatically generated by the Swagger Codegen project:

• API version: v1
• Package version: 2.2.0
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import squacapi_client 

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 squacapi_client

Getting Started

Please follow the installation procedure and then run the following:

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

# Configure API key authorization: Token
configuration = squacapi_client.Configuration()
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'

# create an instance of the API class
api_instance = squacapi_client.DefaultApi(squacapi_client.ApiClient(configuration))

try:
    api_instance.list()
except ApiException as e:
    print("Exception when calling DefaultApi->list: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://squacapi.pnsn.org/

Class	Method	HTTP request	Description
DefaultApi	list	GET /
ApiApi	api_dashboard_dashboards_create	POST /api/dashboard/dashboards/
ApiApi	api_dashboard_dashboards_delete	DELETE /api/dashboard/dashboards/{id}/
ApiApi	api_dashboard_dashboards_list	GET /api/dashboard/dashboards/
ApiApi	api_dashboard_dashboards_partial_update	PATCH /api/dashboard/dashboards/{id}/
ApiApi	api_dashboard_dashboards_read	GET /api/dashboard/dashboards/{id}/
ApiApi	api_dashboard_dashboards_update	PUT /api/dashboard/dashboards/{id}/
ApiApi	api_dashboard_widgets_create	POST /api/dashboard/widgets/
ApiApi	api_dashboard_widgets_delete	DELETE /api/dashboard/widgets/{id}/
ApiApi	api_dashboard_widgets_list	GET /api/dashboard/widgets/
ApiApi	api_dashboard_widgets_partial_update	PATCH /api/dashboard/widgets/{id}/
ApiApi	api_dashboard_widgets_read	GET /api/dashboard/widgets/{id}/
ApiApi	api_dashboard_widgets_update	PUT /api/dashboard/widgets/{id}/
ApiApi	api_list	GET /api/
ApiApi	api_measurement_aggregated_list	GET /api/measurement/aggregated/
ApiApi	api_measurement_alerts_create	POST /api/measurement/alerts/
ApiApi	api_measurement_alerts_delete	DELETE /api/measurement/alerts/{id}/
ApiApi	api_measurement_alerts_list	GET /api/measurement/alerts/
ApiApi	api_measurement_alerts_partial_update	PATCH /api/measurement/alerts/{id}/
ApiApi	api_measurement_alerts_read	GET /api/measurement/alerts/{id}/
ApiApi	api_measurement_alerts_update	PUT /api/measurement/alerts/{id}/
ApiApi	api_measurement_day_archives_list	GET /api/measurement/day-archives/
ApiApi	api_measurement_day_archives_read	GET /api/measurement/day-archives/{id}/
ApiApi	api_measurement_hour_archives_list	GET /api/measurement/hour-archives/
ApiApi	api_measurement_hour_archives_read	GET /api/measurement/hour-archives/{id}/
ApiApi	api_measurement_measurements_create	POST /api/measurement/measurements/
ApiApi	api_measurement_measurements_delete	DELETE /api/measurement/measurements/{id}/
ApiApi	api_measurement_measurements_list	GET /api/measurement/measurements/
ApiApi	api_measurement_measurements_partial_update	PATCH /api/measurement/measurements/{id}/
ApiApi	api_measurement_measurements_read	GET /api/measurement/measurements/{id}/
ApiApi	api_measurement_measurements_update	PUT /api/measurement/measurements/{id}/
ApiApi	api_measurement_metrics_create	POST /api/measurement/metrics/
ApiApi	api_measurement_metrics_delete	DELETE /api/measurement/metrics/{id}/
ApiApi	api_measurement_metrics_list	GET /api/measurement/metrics/
ApiApi	api_measurement_metrics_partial_update	PATCH /api/measurement/metrics/{id}/
ApiApi	api_measurement_metrics_read	GET /api/measurement/metrics/{id}/
ApiApi	api_measurement_metrics_update	PUT /api/measurement/metrics/{id}/
ApiApi	api_measurement_monitors_create	POST /api/measurement/monitors/
ApiApi	api_measurement_monitors_delete	DELETE /api/measurement/monitors/{id}/
ApiApi	api_measurement_monitors_list	GET /api/measurement/monitors/
ApiApi	api_measurement_monitors_partial_update	PATCH /api/measurement/monitors/{id}/
ApiApi	api_measurement_monitors_read	GET /api/measurement/monitors/{id}/
ApiApi	api_measurement_monitors_update	PUT /api/measurement/monitors/{id}/
ApiApi	api_measurement_month_archives_list	GET /api/measurement/month-archives/
ApiApi	api_measurement_month_archives_read	GET /api/measurement/month-archives/{id}/
ApiApi	api_measurement_triggers_create	POST /api/measurement/triggers/
ApiApi	api_measurement_triggers_delete	DELETE /api/measurement/triggers/{id}/
ApiApi	api_measurement_triggers_list	GET /api/measurement/triggers/
ApiApi	api_measurement_triggers_partial_update	PATCH /api/measurement/triggers/{id}/
ApiApi	api_measurement_triggers_read	GET /api/measurement/triggers/{id}/
ApiApi	api_measurement_triggers_unsubscribe_create	POST /api/measurement/triggers/{id}/unsubscribe/{token}/
ApiApi	api_measurement_triggers_unsubscribe_read	GET /api/measurement/triggers/{id}/unsubscribe/{token}/
ApiApi	api_measurement_triggers_update	PUT /api/measurement/triggers/{id}/
ApiApi	api_measurement_week_archives_list	GET /api/measurement/week-archives/
ApiApi	api_measurement_week_archives_read	GET /api/measurement/week-archives/{id}/
ApiApi	api_nslc_channels_create	POST /api/nslc/channels/
ApiApi	api_nslc_channels_delete	DELETE /api/nslc/channels/{id}/
ApiApi	api_nslc_channels_list	GET /api/nslc/channels/
ApiApi	api_nslc_channels_partial_update	PATCH /api/nslc/channels/{id}/
ApiApi	api_nslc_channels_read	GET /api/nslc/channels/{id}/
ApiApi	api_nslc_channels_update	PUT /api/nslc/channels/{id}/
ApiApi	api_nslc_groups_create	POST /api/nslc/groups/
ApiApi	api_nslc_groups_delete	DELETE /api/nslc/groups/{id}/
ApiApi	api_nslc_groups_list	GET /api/nslc/groups/
ApiApi	api_nslc_groups_partial_update	PATCH /api/nslc/groups/{id}/
ApiApi	api_nslc_groups_read	GET /api/nslc/groups/{id}/
ApiApi	api_nslc_groups_update	PUT /api/nslc/groups/{id}/
ApiApi	api_nslc_matching_rules_create	POST /api/nslc/matching-rules/
ApiApi	api_nslc_matching_rules_delete	DELETE /api/nslc/matching-rules/{id}/
ApiApi	api_nslc_matching_rules_list	GET /api/nslc/matching-rules/
ApiApi	api_nslc_matching_rules_partial_update	PATCH /api/nslc/matching-rules/{id}/
ApiApi	api_nslc_matching_rules_read	GET /api/nslc/matching-rules/{id}/
ApiApi	api_nslc_matching_rules_update	PUT /api/nslc/matching-rules/{id}/
ApiApi	api_nslc_networks_create	POST /api/nslc/networks/
ApiApi	api_nslc_networks_delete	DELETE /api/nslc/networks/{code}/
ApiApi	api_nslc_networks_list	GET /api/nslc/networks/
ApiApi	api_nslc_networks_partial_update	PATCH /api/nslc/networks/{code}/
ApiApi	api_nslc_networks_read	GET /api/nslc/networks/{code}/
ApiApi	api_nslc_networks_update	PUT /api/nslc/networks/{code}/
ApiApi	api_organization_organizations_create	POST /api/organization/organizations/
ApiApi	api_organization_organizations_delete	DELETE /api/organization/organizations/{id}/
ApiApi	api_organization_organizations_list	GET /api/organization/organizations/
ApiApi	api_organization_organizations_partial_update	PATCH /api/organization/organizations/{id}/
ApiApi	api_organization_organizations_read	GET /api/organization/organizations/{id}/
ApiApi	api_organization_organizations_update	PUT /api/organization/organizations/{id}/
ApiApi	api_organization_users_create	POST /api/organization/users/
ApiApi	api_organization_users_delete	DELETE /api/organization/users/{id}/
ApiApi	api_organization_users_list	GET /api/organization/users/
ApiApi	api_organization_users_partial_update	PATCH /api/organization/users/{id}/
ApiApi	api_organization_users_read	GET /api/organization/users/{id}/
ApiApi	api_organization_users_update	PUT /api/organization/users/{id}/
ApiApi	api_password_reset_confirm_create	POST /api/password_reset/confirm/
ApiApi	api_password_reset_create	POST /api/password_reset/	An Api View which provides a method to request a password reset token based on an e-mail address
ApiApi	api_password_reset_validate_token_create	POST /api/password_reset/validate_token/
ApiApi	api_user_create_create	POST /api/user/create/
ApiApi	api_user_groups_create	POST /api/user/groups/
ApiApi	api_user_groups_delete	DELETE /api/user/groups/{id}/
ApiApi	api_user_groups_list	GET /api/user/groups/
ApiApi	api_user_groups_partial_update	PATCH /api/user/groups/{id}/
ApiApi	api_user_groups_read	GET /api/user/groups/{id}/
ApiApi	api_user_groups_update	PUT /api/user/groups/{id}/
ApiApi	api_user_me_partial_update	PATCH /api/user/me/
ApiApi	api_user_me_read	GET /api/user/me/
ApiApi	api_user_token_create	POST /api/user/token/
InviteApi	invite_invite_create	POST /invite/invite/
InviteApi	invite_register_create	POST /invite/register/

Documentation For Models

• Alert
• AuthToken
• Channel
• Measurement
• Metric
• ReadOnlyAlertDetailSerializer
• ReadOnlyAlertSerializer
• ReadOnlyArchiveDaySerializer
• ReadOnlyArchiveHourSerializer
• ReadOnlyArchiveMonthSerializer
• ReadOnlyArchiveWeekSerializer
• ReadOnlyChannelSerializer
• ReadOnlyDashboardDetailSerializer
• ReadOnlyDashboardSerializer
• ReadOnlyEmailSerializer
• ReadOnlyGroupDetailSerializer
• ReadOnlyGroupSerializer
• ReadOnlyInviteRegisterSerializer
• ReadOnlyInviteTokenSerializer
• ReadOnlyMatchingRuleSerializer
• ReadOnlyMeasurementSerializer
• ReadOnlyMetricSerializer
• ReadOnlyMonitorDetailSerializer
• ReadOnlyMonitorSerializer
• ReadOnlyNetworkSerializer
• ReadOnlyOrganizationSerializer
• ReadOnlyPasswordTokenSerializer
• ReadOnlyResetTokenSerializer
• ReadOnlyTriggerSerializer
• ReadOnlyTriggerUnsubscribeSerializer
• ReadOnlyUserGroupSerializer
• ReadOnlyUserMeSerializer
• ReadOnlyUserSerializer
• ReadOnlyUserSimpleSerializer
• ReadOnlyUserUpdateSerializer
• ReadOnlyWidgetDetailSerializer
• ReadOnlyWidgetSerializer
• ResetToken
• Trigger
• UserSimple
• WriteOnlyAlertSerializer
• WriteOnlyChannelSerializer
• WriteOnlyDashboardSerializer
• WriteOnlyEmailSerializer
• WriteOnlyGroupSerializer
• WriteOnlyInviteRegisterSerializer
• WriteOnlyInviteTokenSerializer
• WriteOnlyMatchingRuleSerializer
• WriteOnlyMeasurementSerializer
• WriteOnlyMetricSerializer
• WriteOnlyMonitorSerializer
• WriteOnlyNetworkSerializer
• WriteOnlyOrganizationSerializer
• WriteOnlyPasswordTokenSerializer
• WriteOnlyResetTokenSerializer
• WriteOnlyTriggerSerializer
• WriteOnlyTriggerUnsubscribeSerializer
• WriteOnlyUserGroupSerializer
• WriteOnlyUserMeSerializer
• WriteOnlyUserSerializer
• WriteOnlyUserUpdateSerializer
• WriteOnlyWidgetSerializer

Documentation For Authorization

Token

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

Author

contact@snippets.local