Categorygithub.com/sematext/sematext-api-client-go

# Packages

No description provided by the author

# README

  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

ClassMethodHTTP requestDescription
AlertNotificationsAPIGetAlertNotificationsForAppUsingPOSTPost /users-web/api/v3/apps/{appID}/notifications/alertsGet alert notifications for an app
AlertNotificationsAPIGetAlertNotificationsForUserUsingPOSTPost /users-web/api/v3/notifications/alertsGet alert notifications for a user
AlertsAPICreateAlertUsingPOSTPost /users-web/api/v3/alertsCreate alert rule
AlertsAPIDeleteAlertRuleUsingDELETEDelete /users-web/api/v3/alerts/{updateableAlertID}Delete alert rule
AlertsAPIDisableAlertRuleUsingPUTPut /users-web/api/v3/alerts/{updateableAlertID}/disableDisable alert rule
AlertsAPIEnableAlertRuleUsingPUTPut /users-web/api/v3/alerts/{updateableAlertID}/enableEnable alert rule
AlertsAPIGetAlertRulesForAppUsingGETGet /users-web/api/v3/apps/{appID}/alertsGet alert rules for an app
AppsAPIGetAppTypesUsingGETGet /users-web/api/v3/apps/typesGet all App types supported for the account identified with apiKey
AppsAPIGetUsingGETGet /users-web/api/v3/apps/{anyStateAppID}Gets defails for one particular App
AppsAPIInviteAppGuestsUsingPOSTPost /users-web/api/v3/apps/guestsInvite guests to an app
AppsAPIListAppsUsersUsingGETGet /users-web/api/v3/apps/usersGet all users of apps accessible to this account
AppsAPIListUsingGETGet /users-web/api/v3/appsGet all apps accessible by account identified with apiKey
AppsAPIUpdateDescriptionUsingPUTPut /users-web/api/v3/apps/{anyStateAppID}/descriptionUpdate description of the app
AppsAPIUpdateUsingPUT1Put /users-web/api/v3/apps/{anyStateAppID}Update app
AwsSettingsControllerAPIUpdateUsingPUTPut /users-web/api/v3/apps/{appID}/awsUpdate App's AWS CloudWatch settings
BillingAPIGetDetailedInvoiceUsingGETGet /users-web/api/v3/billing/invoice/{service}/{year}/{month}Get invoice details
BillingAPIListAvailablePlansUsingGETGet /users-web/api/v3/billing/availablePlansGet available plans
BillingAPIUpdatePlanUsingPUTPut /users-web/api/v3/billing/info/{appID}Update plan for an app
LogsAppAPICreateLogseneApplicationPost /logsene-reports/api/v3/appsCreate Logs App
MetricsAPIListDataSeriesUsingPOSTPost /spm-reports/api/v3/apps/{appID}/metrics/dataGet metrics data points for an app
MetricsAPIListFiltersUsingPOST1Post /spm-reports/api/v3/apps/{appID}/metrics/filtersGet metrics filters and their values for an app
MetricsAPIListMetricsKeysUsingGETGet /spm-reports/api/v3/apps/{appID}/metrics/keysGet metrics keys for an app
MetricsAPIListMetricsUsingGETGet /spm-reports/api/v3/apps/{appID}/metricsGet metrics info for an app
MonitoringAppAPICreateSpmApplication1Post /spm-reports/api/v3/appsCreate Monitoring App
ResetPasswordAPIResetPasswordUsingPOSTPost /users-web/api/v3/account/password/resetReset Password
SavedQueriesAPIDeleteSavedQueryUsingDELETEDelete /users-web/api/v3/savedQueries/{updateableQueryID}Delete saved query
SavedQueriesAPIGetSavedQueriesForAppUsingGETGet /users-web/api/v3/apps/{appID}/savedQueriesGet saved queries for an app
SavedQueriesAPISaveQueryUsingPOSTPost /users-web/api/v3/savedQueriesCreate saved query
SavedQueriesAPISaveQueryUsingPUTPut /users-web/api/v3/savedQueries/{updateableQueryID}Update saved query
SubscriptionsAPIListUsingGET1Get /users-web/api/v3/apps/{appID}/subscriptionsGet subscriptions for an app
SubscriptionsAPISendReportUsingPOSTPost /users-web/api/v3/apps/{appID}/report/sendTrigger emailing of report for an app
TagAPIControllerAPIGetTagNamesUsingGET1Get /spm-reports/api/v3/apps/{addIDs}/tagNamesGets tag names for the given application identifiers appearing in the given time frame.
TagAPIControllerAPIGetUsingGET1Get /spm-reports/api/v3/apps/{addIDs}/tagsGets values for specified tags for the given application identifiers appearing in the given time frame.
TagAPIControllerAPIGetUsingGET2Get /spm-reports/api/v3/apps/{addIDs}/metrics/filtersGets values for specified tags for the given application identifiers appearing in the given time frame.
TokensAPIControllerAPICreateAppTokenPost /users-web/api/v3/apps/{appID}/tokensCreate new app token
TokensAPIControllerAPIDeleteAppToken1Delete /users-web/api/v3/apps/{appID}/tokens/{tokenID}Delete app token
TokensAPIControllerAPIGetAppTokens1Get /users-web/api/v3/apps/{appID}/tokensGet app available tokens
TokensAPIControllerAPIRegenerateAppTokenPost /users-web/api/v3/apps/{appID}/tokens/{tokenID}/regenerateRegenerate app token)
TokensAPIControllerAPIUpdateAppTokenPut /users-web/api/v3/apps/{appID}/tokens/{tokenID}Update app token (enable/disable)

Documentation For Models