{"id":19653557,"url":"https://github.com/sematext/sematext-api-client-ruby","last_synced_at":"2026-01-05T20:05:33.983Z","repository":{"id":45296630,"uuid":"260439482","full_name":"sematext/sematext-api-client-ruby","owner":"sematext","description":"Sematext API Client for Ruby","archived":false,"fork":false,"pushed_at":"2024-07-22T14:34:06.000Z","size":373,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-01-29T14:45:34.829Z","etag":null,"topics":["alerting","api-client","cloud","log-shipping","monitoring","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sematext.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-01T11:07:20.000Z","updated_at":"2021-12-23T11:31:47.000Z","dependencies_parsed_at":"2022-09-14T05:12:05.351Z","dependency_job_id":null,"html_url":"https://github.com/sematext/sematext-api-client-ruby","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sematext%2Fsematext-api-client-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sematext%2Fsematext-api-client-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sematext%2Fsematext-api-client-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sematext%2Fsematext-api-client-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sematext","download_url":"https://codeload.github.com/sematext/sematext-api-client-ruby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245240828,"owners_count":20583102,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alerting","api-client","cloud","log-shipping","monitoring","ruby"],"created_at":"2024-11-11T15:14:29.927Z","updated_at":"2026-01-05T20:05:33.698Z","avatar_url":"https://github.com/sematext.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# \u003cimg src=\"https://sematext.com/wp-content/uploads/2020/09/just-octi-blue.png\" valign=\"bottom\" width=\"60px\"/\u003e**\u0026nbsp;\u0026nbsp;sematext-api-client-ruby**\n\n\u003cbr\u003e\n\n\u003e*A [Sematext Cloud](https://sematext.com/cloud/) API client, for interaction with Sematext Cloud solution monitoring, alerting and log shipping.*\n\n\u003cbr\u003e\n\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n\u003cbr\u003e\nOne of a family of clients in following flavours:\n\u003cbr\u003e\n\u003cbr\u003e\n\n* [sematext-api-client-javascript](https://github.com/sematext/sematext-api-client-javascript \"Javascript\")\n* [sematext-api-client-rust](https://github.com/sematext/sematext-api-client-rust \"Rust\")\n* [sematext-api-client-ruby](https://github.com/sematext/sematext-api-client-ruby \"Ruby\")\n* [sematext-api-client-python](https://github.com/sematext/sematext-api-client-python \"Python\")\n* [sematext-api-client-php](https://github.com/sematext/sematext-api-client-php \"PHP\")\n* [sematext-api-client-java](https://github.com/sematext/sematext-api-client-java \"Java\")\n* [sematext-api-client-go](https://github.com/sematext/sematext-api-client-go \"Go/Golang\")\n\n\u003cbr\u003e\nRefer to below link for deeper information on the API itself.\n\u003cbr\u003e\n\u003cbr\u003e\n\n* [Sematext Cloud API Reference](https://sematext.com/docs/api/ \"API Reference\")\n\n\u003cbr\u003e\n\n## Contents\n\n- [\u003cimg src=\"https://sematext.com/wp-content/uploads/2020/09/just-octi-blue.png\" valign=\"bottom\" width=\"60px\"/\u003e**\u0026nbsp;\u0026nbsp;sematext-api-client-ruby**](#sematext-api-client-ruby)\n  - [Contents](#contents)\n  - [Installation](#installation)\n    - [Build a gem](#build-a-gem)\n    - [Install from Git](#install-from-git)\n    - [Include the Ruby code directly](#include-the-ruby-code-directly)\n  - [Authentication](#authentication)\n  - [Getting Started](#getting-started)\n  - [Reference](#reference)\n  - [Documentation for Models](#documentation-for-models)\n\n\u003cbr\u003e\n\n## Installation\n\n### Build a gem\n\nTo build the Ruby code into a gem:\n\n```shell\ngem build stcloud.gemspec\n```\n\nThen either install the gem locally:\n\n```shell\ngem install ./SematextCloud-0.1.3.gem\n```\n(for development, run `gem install --dev ./SematextCloud-0.1.3.gem` to install the development dependencies)\n\nor publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).\n\nFinally add this to the Gemfile:\n\n    gem 'SematextCloud', '~\u003e 0.1.3'\n\n### Install from Git\n\nIf 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:\n\n    gem 'SematextCloud', :git =\u003e 'https://github.com/sematext/sematext-api-client-ruby.git'\n\n### Include the Ruby code directly\n\nInclude the Ruby code directly using `-I` as follows:\n\n```shell\nruby -Ilib script.rb\n```\n\n## Authentication\n\nThis client code requires a Sematext API Access token to function. You can find this by logging into your [Sematext Cloud Account](https://apps.sematext.com/ui/account/api)\n\n\n## Getting Started\n\nPlease follow the [installation](#installation) procedure and then run the following code:\n```ruby\n# Load the gem\nrequire 'SematextCloud'\n\n# Setup authorization\nSematextCloud.configure do |config|\n  # Configure API key authorization: api_key\n  config.api_key['Authorization'] = 'YOUR API KEY'\n  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)\n  #config.api_key_prefix['Authorization'] = 'Bearer'\nend\n\napi_instance = SematextCloud::AlertNotificationsApi.new\n\napp_id = 789 # Integer | appId\n\ntime_interval = SematextCloud::AlertNotificationRequest.new # AlertNotificationRequest | Time Interval\n\n\nbegin\n  #Get alert notifications for an app\n  result = api_instance.get_alert_notifications_for_app_using_post(app_id, time_interval)\n  p result\nrescue SematextCloud::ApiError =\u003e e\n  puts \"Exception when calling AlertNotificationsApi-\u003eget_alert_notifications_for_app_using_post: #{e}\"\nend\n\n```\n\n## Reference\n\nAll URIs are relative to *https://localhost*\n\n| Class                               | Method                                                                                                                         | HTTP request                                                          | Description                                                                                             |\n| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |\n| *stcloud::AlertNotificationsApi*    | [**get_alert_notifications_for_app_using_post**](docs/AlertNotificationsApi.md#get_alert_notifications_for_app_using_post)     | **POST** /users-web/api/v3/apps/{appId}/notifications/alerts          | Get alert notifications for an app                                                                      |\n| *stcloud::AlertNotificationsApi*    | [**get_alert_notifications_for_user_using_post1**](docs/AlertNotificationsApi.md#get_alert_notifications_for_user_using_post1) | **POST** /users-web/api/v3/notifications/alerts                       | Get alert notifications for a user                                                                      |\n| *stcloud::AlertsApi*                | [**create_alert_using_post**](docs/AlertsApi.md#create_alert_using_post)                                                       | **POST** /users-web/api/v3/alerts                                     | Create alert rule                                                                                       |\n| *stcloud::AlertsApi*                | [**delete_alert_rule_using_delete1**](docs/AlertsApi.md#delete_alert_rule_using_delete1)                                       | **DELETE** /users-web/api/v3/alerts/{updateableAlertId}               | Delete alert rule                                                                                       |\n| *stcloud::AlertsApi*                | [**disable_alert_rule_using_put1**](docs/AlertsApi.md#disable_alert_rule_using_put1)                                           | **PUT** /users-web/api/v3/alerts/{updateableAlertId}/disable          | Disable alert rule                                                                                      |\n| *stcloud::AlertsApi*                | [**enable_alert_rule_using_put1**](docs/AlertsApi.md#enable_alert_rule_using_put1)                                             | **PUT** /users-web/api/v3/alerts/{updateableAlertId}/enable           | Enable alert rule                                                                                       |\n| *stcloud::AlertsApi*                | [**get_alert_rules_for_app_using_get1**](docs/AlertsApi.md#get_alert_rules_for_app_using_get1)                                 | **GET** /users-web/api/v3/apps/{appId}/alerts                         | Get alert rules for an app                                                                              |\n| *stcloud::AppsApi*                  | [**delete_using_delete1**](docs/AppsApi.md#delete_using_delete1)                                                               | **DELETE** /users-web/api/v3/apps/{anyStateAppId}                     | delete                                                                                                  |\n| *stcloud::AppsApi*                  | [**get_app_types_using_get**](docs/AppsApi.md#get_app_types_using_get)                                                         | **GET** /users-web/api/v3/apps/types                                  | Get all App types supported for the account identified with apiKey                                      |\n| *stcloud::AppsApi*                  | [**get_using_get1**](docs/AppsApi.md#get_using_get1)                                                                           | **GET** /users-web/api/v3/apps/{anyStateAppId}                        | Gets defails for one particular App                                                                     |\n| *stcloud::AppsApi*                  | [**invite_app_guests_using_post1**](docs/AppsApi.md#invite_app_guests_using_post1)                                             | **POST** /users-web/api/v3/apps/guests                                | Invite guests to an app                                                                                 |\n| *stcloud::AppsApi*                  | [**list_apps_users_using_get1**](docs/AppsApi.md#list_apps_users_using_get1)                                                   | **GET** /users-web/api/v3/apps/users                                  | Get all users of apps accessible to this account                                                        |\n| *stcloud::AppsApi*                  | [**list_using_get**](docs/AppsApi.md#list_using_get)                                                                           | **GET** /users-web/api/v3/apps                                        | Get all apps accessible by account identified with apiKey                                               |\n| *stcloud::AppsApi*                  | [**update_description_using_put**](docs/AppsApi.md#update_description_using_put)                                               | **PUT** /users-web/api/v3/apps/{anyStateAppId}/description            | Update description of the app                                                                           |\n| *stcloud::AppsApi*                  | [**update_using_put2**](docs/AppsApi.md#update_using_put2)                                                                     | **PUT** /users-web/api/v3/apps/{anyStateAppId}                        | Update app                                                                                              |\n| *stcloud::AwsSettingsControllerApi* | [**update_using_put**](docs/AwsSettingsControllerApi.md#update_using_put)                                                      | **PUT** /users-web/api/v3/apps/{appId}/aws                            | Update App's AWS CloudWatch settings                                                                    |\n| *stcloud::BillingApi*               | [**get_detailed_invoice_using_get1**](docs/BillingApi.md#get_detailed_invoice_using_get1)                                      | **GET** /users-web/api/v3/billing/invoice/{service}/{year}/{month}    | Get invoice details                                                                                     |\n| *stcloud::BillingApi*               | [**list_available_plans_using_get**](docs/BillingApi.md#list_available_plans_using_get)                                        | **GET** /users-web/api/v3/billing/availablePlans                      | Get available plans                                                                                     |\n| *stcloud::BillingApi*               | [**update_plan_using_put**](docs/BillingApi.md#update_plan_using_put)                                                          | **PUT** /users-web/api/v3/billing/info/{appId}                        | Update plan for an app                                                                                  |\n| *stcloud::LogsAppApi*               | [**create_logsene_application**](docs/LogsAppApi.md#create_logsene_application)                                                | **POST** /logsene-reports/api/v3/apps                                 | Create Logs App                                                                                         |\n| *stcloud::MonitoringAppApi*         | [**create_spm_application1**](docs/MonitoringAppApi.md#create_spm_application1)                                                | **POST** /spm-reports/api/v3/apps                                     | Create Monitoring App                                                                                   |\n| *stcloud::ResetPasswordApi*         | [**reset_password_using_post1**](docs/ResetPasswordApi.md#reset_password_using_post1)                                          | **POST** /users-web/api/v3/account/password/reset                     | Reset Password                                                                                          |\n| *stcloud::SubscriptionsApi*         | [**create_for_app_using_post1**](docs/SubscriptionsApi.md#create_for_app_using_post1)                                          | **POST** /users-web/api/v3/apps/{appId}/subscription                  | Create App subscription                                                                                 |\n| *stcloud::SubscriptionsApi*         | [**create_for_dash_using_post1**](docs/SubscriptionsApi.md#create_for_dash_using_post1)                                        | **POST** /users-web/api/v3/dashboards/{dashId}/subscription           | Create dashboard subscription                                                                           |\n| *stcloud::SubscriptionsApi*         | [**delete_using_delete3**](docs/SubscriptionsApi.md#delete_using_delete3)                                                      | **DELETE** /users-web/api/v3/subscriptions/{updateableSubscriptionId} | Delete subscription                                                                                     |\n| *stcloud::SubscriptionsApi*         | [**list_using_get3**](docs/SubscriptionsApi.md#list_using_get3)                                                                | **GET** /users-web/api/v3/apps/{appId}/subscriptions                  | Get subscriptions for an App                                                                            |\n| *stcloud::SubscriptionsApi*         | [**list_using_get4**](docs/SubscriptionsApi.md#list_using_get4)                                                                | **GET** /users-web/api/v3/subscriptions                               | Get current account's subscriptions                                                                     |\n| *stcloud::SubscriptionsApi*         | [**send_app_report_using_post1**](docs/SubscriptionsApi.md#send_app_report_using_post1)                                        | **POST** /users-web/api/v3/apps/{appId}/report/send                   | Email an App report                                                                                     |\n| *stcloud::SubscriptionsApi*         | [**send_dash_report_using_post1**](docs/SubscriptionsApi.md#send_dash_report_using_post1)                                      | **POST** /users-web/api/v3/dashboards/{dashId}/report/send            | Email a dashboard report                                                                                |\n| *stcloud::SubscriptionsApi*         | [**toggle_enabled_using_put1**](docs/SubscriptionsApi.md#toggle_enabled_using_put1)                                            | **PUT** /users-web/api/v3/subscriptions/{updateableSubscriptionId}    | Toggle subscription status                                                                              |\n| *stcloud::SubscriptionsApi*         | [**update_for_app_using_put**](docs/SubscriptionsApi.md#update_for_app_using_put)                                              | **PUT** /users-web/api/v3/apps/{appId}/subscription                   | Update App subscription                                                                                 |\n| *stcloud::SubscriptionsApi*         | [**update_for_dash_using_put1**](docs/SubscriptionsApi.md#update_for_dash_using_put1)                                          | **PUT** /users-web/api/v3/dashboards/{dashId}/subscription            | Update dashboard subscription                                                                           |\n| *stcloud::TagApiControllerApi*      | [**get_tag_names_using_get1**](docs/TagApiControllerApi.md#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.                 |\n| *stcloud::TagApiControllerApi*      | [**get_using_get1**](docs/TagApiControllerApi.md#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. |\n| *stcloud::TagApiControllerApi*      | [**get_using_get2**](docs/TagApiControllerApi.md#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. |\n| *stcloud::TokensApiControllerApi*   | [**create_app_token1**](docs/TokensApiControllerApi.md#create_app_token1)                                                      | **POST** /users-web/api/v3/apps/{appId}/tokens                        | Create new app token                                                                                    |\n| *stcloud::TokensApiControllerApi*   | [**delete_app_token1**](docs/TokensApiControllerApi.md#delete_app_token1)                                                      | **DELETE** /users-web/api/v3/apps/{appId}/tokens/{tokenId}            | Delete app token                                                                                        |\n| *stcloud::TokensApiControllerApi*   | [**get_app_tokens**](docs/TokensApiControllerApi.md#get_app_tokens)                                                            | **GET** /users-web/api/v3/apps/{appId}/tokens                         | Get app available tokens                                                                                |\n| *stcloud::TokensApiControllerApi*   | [**regenerate_app_token1**](docs/TokensApiControllerApi.md#regenerate_app_token1)                                              | **POST** /users-web/api/v3/apps/{appId}/tokens/{tokenId}/regenerate   | Regenerate app token)                                                                                   |\n| *stcloud::TokensApiControllerApi*   | [**update_app_token**](docs/TokensApiControllerApi.md#update_app_token)                                                        | **PUT** /users-web/api/v3/apps/{appId}/tokens/{tokenId}               | Update app token (enable/disable or name)                                                               |\n\n\n## Documentation for Models\n\n - [stcloud::AlertNotificationRequest](docs/AlertNotificationRequest.md)\n - [stcloud::AlertRule](docs/AlertRule.md)\n - [stcloud::AlertRuleScheduleTimeRangeDto](docs/AlertRuleScheduleTimeRangeDto.md)\n - [stcloud::AlertRuleScheduleWeekdayDto](docs/AlertRuleScheduleWeekdayDto.md)\n - [stcloud::App](docs/App.md)\n - [stcloud::AppDescription](docs/AppDescription.md)\n - [stcloud::AppMetadata](docs/AppMetadata.md)\n - [stcloud::BasicAuthMethodDto](docs/BasicAuthMethodDto.md)\n - [stcloud::BasicOrganizationDto](docs/BasicOrganizationDto.md)\n - [stcloud::BillingInfo](docs/BillingInfo.md)\n - [stcloud::CloudWatchSettings](docs/CloudWatchSettings.md)\n - [stcloud::CreateAppInfo](docs/CreateAppInfo.md)\n - [stcloud::CreateTokenDto](docs/CreateTokenDto.md)\n - [stcloud::Error](docs/Error.md)\n - [stcloud::FilterValue](docs/FilterValue.md)\n - [stcloud::GenericApiResponse](docs/GenericApiResponse.md)\n - [stcloud::Invitation](docs/Invitation.md)\n - [stcloud::NotificationIntegration](docs/NotificationIntegration.md)\n - [stcloud::Plan](docs/Plan.md)\n - [stcloud::ReportInfo](docs/ReportInfo.md)\n - [stcloud::ServiceIntegration](docs/ServiceIntegration.md)\n - [stcloud::SubscriptionDashboardDto](docs/SubscriptionDashboardDto.md)\n - [stcloud::SubscriptionDto](docs/SubscriptionDto.md)\n - [stcloud::UpdateAppInfo](docs/UpdateAppInfo.md)\n - [stcloud::UpdateSubscriptionDto](docs/UpdateSubscriptionDto.md)\n - [stcloud::UpdateTokenDto](docs/UpdateTokenDto.md)\n - [stcloud::UserInfo](docs/UserInfo.md)\n - [stcloud::UserPermissions](docs/UserPermissions.md)\n - [stcloud::UserRole](docs/UserRole.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsematext%2Fsematext-api-client-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsematext%2Fsematext-api-client-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsematext%2Fsematext-api-client-ruby/lists"}