sematext-api-client-python

A Sematext Cloud API client, for interaction with Sematext Cloud solution monitoring, alerting and log shipping.

One of a family of clients in following flavours:

• sematext-api-client-javascript
• sematext-api-client-rust
• sematext-api-client-ruby
• sematext-api-client-python
• sematext-api-client-php
• sematext-api-client-java
• sematext-api-client-go

Refer to below link for deeper information on the API itself.

• Sematext Cloud API Reference

Contents

•   sematext-api-client-python
  • Contents
  • Getting Started
  • Authentication
  • Requirements.
  • Installation
    • pip install
    • Testing
    • Setuptools
  • Getting Started
  • Reference
  • Documentation For Models

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Authentication

This client code requires a Sematext API Access token to function. You can find this by logging into your Sematext Cloud Account

Requirements.

Python 2.7 and 3.4+

Installation

pip install

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

pip install git+https://github.com/sematext/sematext-api-client-python.git

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

Then import the package:

import stcloud

Testing

python -m unittest discover

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 stcloud

Getting Started

Please follow the installation procedure and then run the following:

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

# Configure API key authorization: api_key
configuration = stcloud.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 = stcloud.AlertNotificationsApi(stcloud.ApiClient(configuration))
app_id = 789 # int | appId
time_interval = stcloud.AlertNotificationRequest() # AlertNotificationRequest | Time Interval

try:
    # Get alert notifications for an app
    api_response = api_instance.get_alert_notifications_for_app_using_post(app_id, time_interval)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertNotificationsApi->get_alert_notifications_for_app_using_post: %s\n" % e)

Reference

All URIs are relative to https://localhost

Class	Method	HTTP request	Description
AlertNotificationsApi	get_alert_notifications_for_app_using_post	POST /users-web/api/v3/apps/{appId}/notifications/alerts	Get alert notifications for an app
AlertNotificationsApi	get_alert_notifications_for_user_using_post1	POST /users-web/api/v3/notifications/alerts	Get alert notifications for a user
AlertsApi	create_alert_using_post	POST /users-web/api/v3/alerts	Create alert rule
AlertsApi	delete_alert_rule_using_delete1	DELETE /users-web/api/v3/alerts/{updateableAlertId}	Delete alert rule
AlertsApi	disable_alert_rule_using_put1	PUT /users-web/api/v3/alerts/{updateableAlertId}/disable	Disable alert rule
AlertsApi	enable_alert_rule_using_put1	PUT /users-web/api/v3/alerts/{updateableAlertId}/enable	Enable alert rule
AlertsApi	get_alert_rules_for_app_using_get1	GET /users-web/api/v3/apps/{appId}/alerts	Get alert rules for an app
AppsApi	delete_using_delete1	DELETE /users-web/api/v3/apps/{anyStateAppId}	delete
AppsApi	get_app_types_using_get	GET /users-web/api/v3/apps/types	Get all App types supported for the account identified with apiKey
AppsApi	get_using_get1	GET /users-web/api/v3/apps/{anyStateAppId}	Gets defails for one particular App
AppsApi	invite_app_guests_using_post1	POST /users-web/api/v3/apps/guests	Invite guests to an app
AppsApi	list_apps_users_using_get1	GET /users-web/api/v3/apps/users	Get all users of apps accessible to this account
AppsApi	list_using_get	GET /users-web/api/v3/apps	Get all apps accessible by account identified with apiKey
AppsApi	update_description_using_put	PUT /users-web/api/v3/apps/{anyStateAppId}/description	Update description of the app
AppsApi	update_using_put2	PUT /users-web/api/v3/apps/{anyStateAppId}	Update app
BillingApi	get_detailed_invoice_using_get1	GET /users-web/api/v3/billing/invoice/{service}/{year}/{month}	Get invoice details
BillingApi	list_available_plans_using_get	GET /users-web/api/v3/billing/availablePlans	Get available plans
BillingApi	update_plan_using_put	PUT /users-web/api/v3/billing/info/{appId}	Update plan for an app
LogsAppApi	create_logsene_application	POST /logsene-reports/api/v3/apps	Create Logs App
MonitoringAppApi	create_spm_application1	POST /spm-reports/api/v3/apps	Create Monitoring App
ResetPasswordApi	reset_password_using_post1	POST /users-web/api/v3/account/password/reset	Reset Password
SubscriptionsApi	create_for_app_using_post1	POST /users-web/api/v3/apps/{appId}/subscription	Create App subscription
SubscriptionsApi	create_for_dash_using_post1	POST /users-web/api/v3/dashboards/{dashId}/subscription	Create dashboard subscription
SubscriptionsApi	delete_using_delete3	DELETE /users-web/api/v3/subscriptions/{updateableSubscriptionId}	Delete subscription
SubscriptionsApi	list_using_get3	GET /users-web/api/v3/apps/{appId}/subscriptions	Get subscriptions for an App
SubscriptionsApi	list_using_get4	GET /users-web/api/v3/subscriptions	Get current account's subscriptions
SubscriptionsApi	send_app_report_using_post1	POST /users-web/api/v3/apps/{appId}/report/send	Email an App report
SubscriptionsApi	send_dash_report_using_post1	POST /users-web/api/v3/dashboards/{dashId}/report/send	Email a dashboard report
SubscriptionsApi	toggle_enabled_using_put1	PUT /users-web/api/v3/subscriptions/{updateableSubscriptionId}	Toggle subscription status
SubscriptionsApi	update_for_app_using_put	PUT /users-web/api/v3/apps/{appId}/subscription	Update App subscription
SubscriptionsApi	update_for_dash_using_put1	PUT /users-web/api/v3/dashboards/{dashId}/subscription	Update dashboard subscription
AwsSettingsControllerApi	update_using_put	PUT /users-web/api/v3/apps/{appId}/aws	Update App's AWS CloudWatch settings
TagApiControllerApi	get_tag_names_using_get1	GET /spm-reports/api/v3/apps/{appIds}/tagNames	Gets tag names for the given application identifiers appearing in the given time frame.
TagApiControllerApi	get_using_get1	GET /spm-reports/api/v3/apps/{appIds}/tags	Gets values for specified tags for the given application identifiers appearing in the given time frame.
TagApiControllerApi	get_using_get2	GET /spm-reports/api/v3/apps/{appIds}/metrics/filters	Gets values for specified tags for the given application identifiers appearing in the given time frame.
TokensApiControllerApi	create_app_token1	POST /users-web/api/v3/apps/{appId}/tokens	Create new app token
TokensApiControllerApi	delete_app_token1	DELETE /users-web/api/v3/apps/{appId}/tokens/{tokenId}	Delete app token
TokensApiControllerApi	get_app_tokens	GET /users-web/api/v3/apps/{appId}/tokens	Get app available tokens
TokensApiControllerApi	regenerate_app_token1	POST /users-web/api/v3/apps/{appId}/tokens/{tokenId}/regenerate	Regenerate app token)
TokensApiControllerApi	update_app_token	PUT /users-web/api/v3/apps/{appId}/tokens/{tokenId}	Update app token (enable/disable or name)

Documentation For Models

• AlertNotificationRequest
• AlertRule
• AlertRuleScheduleTimeRangeDto
• AlertRuleScheduleWeekdayDto
• App
• AppDescription
• AppMetadata
• BasicAuthMethodDto
• BasicOrganizationDto
• BillingInfo
• CloudWatchSettings
• CreateAppInfo
• CreateTokenDto
• Error
• FilterValue
• GenericApiResponse
• Invitation
• NotificationIntegration
• Plan
• ReportInfo
• ServiceIntegration
• SubscriptionDashboardDto
• SubscriptionDto
• UpdateAppInfo
• UpdateSubscriptionDto
• UpdateTokenDto
• UserInfo
• UserPermissions
• UserRole