sematext-api-client-ruby

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

•   sematext-api-client-ruby
  • Contents
  • Installation
    • Build a gem
    • Install from Git
    • Include the Ruby code directly
  • Authentication
  • Getting Started
  • Reference
  • Documentation for Models

To build the Ruby code into a gem:

gem build stcloud.gemspec

Then either install the gem locally:

gem install ./SematextCloud-0.1.3.gem

(for development, run gem install --dev ./SematextCloud-0.1.3.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'SematextCloud', '~> 0.1.3'

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'SematextCloud', :git => 'https://github.com/sematext/sematext-api-client-ruby.git'

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

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

Please follow the installation procedure and then run the following code:

# Load the gem
require 'SematextCloud'

# Setup authorization
SematextCloud.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SematextCloud::AlertNotificationsApi.new

app_id = 789 # Integer | appId

time_interval = SematextCloud::AlertNotificationRequest.new # AlertNotificationRequest | Time Interval


begin
  #Get alert notifications for an app
  result = api_instance.get_alert_notifications_for_app_using_post(app_id, time_interval)
  p result
rescue SematextCloud::ApiError => e
  puts "Exception when calling AlertNotificationsApi->get_alert_notifications_for_app_using_post: #{e}"
end

All URIs are relative to https://localhost

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