sematext-api-client-python

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

• 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

• 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

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