alertmanager

Alertmanager - JavaScript client for alertmanager No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install alertmanager --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your alertmanager from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

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
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var Alertmanager = require('alertmanager');

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

var api = new Alertmanager.ChannelsApi()
var id = "id_example"; // {String} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePolicyChannelsDelete(id, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
Alertmanager.ChannelsApi	deletePolicyChannelsDelete	DELETE /channels/{id}
Alertmanager.ChannelsApi	getPolicyChannelsGet	GET /channels/{id}
Alertmanager.ChannelsApi	getPolicyChannelsGetAll	GET /channels
Alertmanager.ChannelsApi	postPolicyChannelsPost	POST /channels
Alertmanager.ChannelsApi	postPolicyChannelsTest	POST /channels/test
Alertmanager.ChannelsApi	putPolicyChannelsPut	PUT /channels/{id}
Alertmanager.DocsApi	getSwaggerJson	GET /docs/swagger.json
Alertmanager.DocsApi	getSwaggerYml	GET /docs/swagger.yml
Alertmanager.EventsApi	deleteEventsParametersDelete	DELETE /events/parameters/{app_key}
Alertmanager.EventsApi	getEventsGet	GET /events/{id}
Alertmanager.EventsApi	getEventsGetAll	GET /events
Alertmanager.EventsApi	getEventsParametersGet	GET /events/parameters
Alertmanager.EventsApi	postEventsPost	POST /events
Alertmanager.HealthCheckApi	getHealthCheck	GET /health_check
Alertmanager.NotificationsApi	getNotificationLogGet	GET /notifications/{id}
Alertmanager.NotificationsApi	getNotificationLogGetAll	GET /notifications
Alertmanager.NotificationsApi	postNotificationLogResend	POST /notifications/{id}/resend
Alertmanager.PoliciesApi	deletePoliciesDelete	DELETE /policies/{id}
Alertmanager.PoliciesApi	getPoliciesGet	GET /policies/{id}
Alertmanager.PoliciesApi	getPoliciesGetAll	GET /policies
Alertmanager.PoliciesApi	postPoliciesPost	POST /policies
Alertmanager.PoliciesApi	putPoliciesPut	PUT /policies/{id}
Alertmanager.WelcomeApi	getWelcome	GET /

Documentation for Models

• Alertmanager.EventSchema
• Alertmanager.NotificationSchema
• Alertmanager.PaginationSchema
• Alertmanager.PolicyChannelSchema
• Alertmanager.PolicySchema

Documentation for Authorization

Authentication schemes defined for the API:

auth_token

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header