Sematext Cloud API
Project description
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.
Contents
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_post | 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_delete | DELETE /users-web/api/v3/alerts/{updateableAlertId} | Delete alert rule |
AlertsApi | disable_alert_rule_using_put | PUT /users-web/api/v3/alerts/{updateableAlertId}/disable | Disable alert rule |
AlertsApi | enable_alert_rule_using_put | PUT /users-web/api/v3/alerts/{updateableAlertId}/enable | Enable alert rule |
AlertsApi | get_alert_rules_for_app_using_get | GET /users-web/api/v3/apps/{appId}/alerts | Get alert rules for an app |
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_get | GET /users-web/api/v3/apps/{anyStateAppId} | Gets defails for one particular App |
AppsApi | invite_app_guests_using_post | POST /users-web/api/v3/apps/guests | Invite guests to an app |
AppsApi | list_apps_users_using_get | 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_put1 | PUT /users-web/api/v3/apps/{anyStateAppId} | Update app |
BillingApi | get_detailed_invoice_using_get | 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 |
MetricsApi | list_data_series_using_post1 | POST /spm-reports/api/v3/apps/{appId}/metrics/data | Get metrics data points for an app |
MetricsApi | list_filters_using_post | POST /spm-reports/api/v3/apps/{appId}/metrics/filters | Get metrics filters and their values for an app |
MetricsApi | list_metrics_keys_using_get1 | GET /spm-reports/api/v3/apps/{appId}/metrics/keys | Get metrics keys for an app |
MetricsApi | list_metrics_using_get1 | GET /spm-reports/api/v3/apps/{appId}/metrics | Get metrics info for an app |
MonitoringAppApi | create_spm_application | POST /spm-reports/api/v3/apps | Create Monitoring App |
ResetPasswordApi | reset_password_using_post | POST /users-web/api/v3/account/password/reset | Reset Password |
SavedQueriesApi | delete_saved_query_using_delete | DELETE /users-web/api/v3/savedQueries/{updateableQueryId} | Delete saved query |
SavedQueriesApi | get_saved_queries_for_app_using_get | GET /users-web/api/v3/apps/{appId}/savedQueries | Get saved queries for an app |
SavedQueriesApi | save_query_using_post | POST /users-web/api/v3/savedQueries | Create saved query |
SavedQueriesApi | save_query_using_put | PUT /users-web/api/v3/savedQueries/{updateableQueryId} | Update saved query |
SubscriptionsApi | list_using_get1 | GET /users-web/api/v3/apps/{appId}/subscriptions | Get subscriptions for an app |
SubscriptionsApi | send_report_using_post | POST /users-web/api/v3/apps/{appId}/report/send | Trigger emailing of report for an app |
AwsSettingsControllerApi | update_using_put | PUT /users-web/api/v3/apps/{appId}/aws | Update App's AWS CloudWatch settings |
TagApiControllerApi | get_tag_names_using_get | 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_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. |
TagApiControllerApi | get_using_get3 | GET /spm-reports/api/v3/apps/{appIds}/tags | Gets values for specified tags for the given application identifiers appearing in the given time frame. |
Documentation For Models
- AlertNotificationRequest
- AlertRule
- AlertRuleScheduleTimeRangeDto
- AlertRuleScheduleWeekdayDto
- App
- AppDescription
- AppMetadata
- BasicAuthMethodDto
- BasicOrganizationDto
- BillingInfo
- CloudWatchSettings
- CreateAppInfo
- DataSeriesFilter
- DataSeriesRequest
- Error
- FilterValue
- GenericApiResponse
- Invitation
- NotificationIntegration
- Plan
- ReportInfo
- SavedQuery
- ServiceIntegration
- UpdateAppInfo
- UserInfo
- UserPermissions
- UserRole
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sematext-cloud-client-0.1.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae9486be9f330c603336224908015682675a0900a6f0c0739ea6342891c37094 |
|
MD5 | f482a5359fc79e3985ee2e3aa0de8c4d |
|
BLAKE2b-256 | a9a0ffd31a399985556e23d4beab300172b4f22ea60a3ebec7f4c082c0627572 |
Hashes for sematext_cloud_client-0.1.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e81e8b2558c5cbb8b71e73eb81f359a1a1101c069184e0fdb3f17cfcc89970aa |
|
MD5 | 49c54247278ea0f6463c4d927f668bdd |
|
BLAKE2b-256 | 7ae1fe943f5ab0548f1c2f57aa2adba7f81bba4beb10df08b81e33b2b3936ace |