Skip to content

sematext/sematext-api-client-go

Repository files navigation

  sematext-api-client-go


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


License


One of a family of clients in following flavours:


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.

Prerequisites

  • Go - v1.13.8

Installation

Put the package under your project folder and add the following in import:

import "./stcloud"

Authentication

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

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the Apache License - see the LICENSE file for details

Acknowledgements

This API client was initially generated by the swagger-codegen project.

  • API version: v3
  • Package version: 1.0.0

Reference

All URIs are relative to https://localhost

Class Method HTTP request Description
AlertNotificationsAPI GetAlertNotificationsForAppUsingPOST Post /users-web/api/v3/apps/{appID}/notifications/alerts Get alert notifications for an app
AlertNotificationsAPI GetAlertNotificationsForUserUsingPOST Post /users-web/api/v3/notifications/alerts Get alert notifications for a user
AlertsAPI CreateAlertUsingPOST Post /users-web/api/v3/alerts Create alert rule
AlertsAPI DeleteAlertRuleUsingDELETE Delete /users-web/api/v3/alerts/{updateableAlertID} Delete alert rule
AlertsAPI DisableAlertRuleUsingPUT Put /users-web/api/v3/alerts/{updateableAlertID}/disable Disable alert rule
AlertsAPI EnableAlertRuleUsingPUT Put /users-web/api/v3/alerts/{updateableAlertID}/enable Enable alert rule
AlertsAPI GetAlertRulesForAppUsingGET Get /users-web/api/v3/apps/{appID}/alerts Get alert rules for an app
AppsAPI GetAppTypesUsingGET Get /users-web/api/v3/apps/types Get all App types supported for the account identified with apiKey
AppsAPI GetUsingGET Get /users-web/api/v3/apps/{anyStateAppID} Gets defails for one particular App
AppsAPI InviteAppGuestsUsingPOST Post /users-web/api/v3/apps/guests Invite guests to an app
AppsAPI ListAppsUsersUsingGET Get /users-web/api/v3/apps/users Get all users of apps accessible to this account
AppsAPI ListUsingGET Get /users-web/api/v3/apps Get all apps accessible by account identified with apiKey
AppsAPI UpdateDescriptionUsingPUT Put /users-web/api/v3/apps/{anyStateAppID}/description Update description of the app
AppsAPI UpdateUsingPUT1 Put /users-web/api/v3/apps/{anyStateAppID} Update app
AwsSettingsControllerAPI UpdateUsingPUT Put /users-web/api/v3/apps/{appID}/aws Update App's AWS CloudWatch settings
BillingAPI GetDetailedInvoiceUsingGET Get /users-web/api/v3/billing/invoice/{service}/{year}/{month} Get invoice details
BillingAPI ListAvailablePlansUsingGET Get /users-web/api/v3/billing/availablePlans Get available plans
BillingAPI UpdatePlanUsingPUT Put /users-web/api/v3/billing/info/{appID} Update plan for an app
LogsAppAPI CreateLogseneApplication Post /logsene-reports/api/v3/apps Create Logs App
MetricsAPI ListDataSeriesUsingPOST Post /spm-reports/api/v3/apps/{appID}/metrics/data Get metrics data points for an app
MetricsAPI ListFiltersUsingPOST1 Post /spm-reports/api/v3/apps/{appID}/metrics/filters Get metrics filters and their values for an app
MetricsAPI ListMetricsKeysUsingGET Get /spm-reports/api/v3/apps/{appID}/metrics/keys Get metrics keys for an app
MetricsAPI ListMetricsUsingGET Get /spm-reports/api/v3/apps/{appID}/metrics Get metrics info for an app
MonitoringAppAPI CreateSpmApplication1 Post /spm-reports/api/v3/apps Create Monitoring App
ResetPasswordAPI ResetPasswordUsingPOST Post /users-web/api/v3/account/password/reset Reset Password
SavedQueriesAPI DeleteSavedQueryUsingDELETE Delete /users-web/api/v3/savedQueries/{updateableQueryID} Delete saved query
SavedQueriesAPI GetSavedQueriesForAppUsingGET Get /users-web/api/v3/apps/{appID}/savedQueries Get saved queries for an app
SavedQueriesAPI SaveQueryUsingPOST Post /users-web/api/v3/savedQueries Create saved query
SavedQueriesAPI SaveQueryUsingPUT Put /users-web/api/v3/savedQueries/{updateableQueryID} Update saved query
SubscriptionsAPI ListUsingGET1 Get /users-web/api/v3/apps/{appID}/subscriptions Get subscriptions for an app
SubscriptionsAPI SendReportUsingPOST Post /users-web/api/v3/apps/{appID}/report/send Trigger emailing of report for an app
TagAPIControllerAPI GetTagNamesUsingGET1 Get /spm-reports/api/v3/apps/{addIDs}/tagNames Gets tag names for the given application identifiers appearing in the given time frame.
TagAPIControllerAPI GetUsingGET1 Get /spm-reports/api/v3/apps/{addIDs}/tags Gets values for specified tags for the given application identifiers appearing in the given time frame.
TagAPIControllerAPI GetUsingGET2 Get /spm-reports/api/v3/apps/{addIDs}/metrics/filters Gets values for specified tags for the given application identifiers appearing in the given time frame.
TokensAPIControllerAPI CreateAppToken Post /users-web/api/v3/apps/{appID}/tokens Create new app token
TokensAPIControllerAPI DeleteAppToken1 Delete /users-web/api/v3/apps/{appID}/tokens/{tokenID} Delete app token
TokensAPIControllerAPI GetAppTokens1 Get /users-web/api/v3/apps/{appID}/tokens Get app available tokens
TokensAPIControllerAPI RegenerateAppToken Post /users-web/api/v3/apps/{appID}/tokens/{tokenID}/regenerate Regenerate app token)
TokensAPIControllerAPI UpdateAppToken Put /users-web/api/v3/apps/{appID}/tokens/{tokenID} Update app token (enable/disable)

Documentation For Models