@sematext/sematext-api-client v0.5.0

  sematext-api-client-javascript

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-javascript
  • Contents
  • Getting Started
    • Installation
      • Node.js
      • Webpack Configuration
  • Authentication
  • Testing
  • Documentation for API Endpoints
  • 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.

Installation

Node.js

Install via:

npm install @sematext/sematext-api-client --save

const Stcloud = require("@sematext/sematext-api-client")

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Authentication

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 instruction and execute the following JS code:

var SematextApiClientJavascript = require('sematext-api-client-javascript')

var defaultClient = SematextApiClientJavascript.ApiClient.instance

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key']
api_key.apiKey = 'YOUR API KEY'
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"

var api = new SematextApiClientJavascript.AlertNotificationsApi()

var appId = 789 // {Number} appId

var timeInterval = new SematextApiClientJavascript.AlertNotificationRequest() // {AlertNotificationRequest} Time Interval

api.getAlertNotificationsForAppUsingPOST(appId, timeInterval).then(
  function (data) {
    console.log('API called successfully. Returned data: ' + data)
  },
  function (error) {
    console.error(error)
  }
)

Testing

Note: Tests are currently inhibited by a Mocha dependancy on Yargs. This client is generated code so this should have litle impact. Marking as a pre-release until this is resolved upstream.

Documentation for API Endpoints

All URIs are relative to https://localhost

Documentation for Models

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