Dkron - the Ruby gem for the Dkron REST API

You can communicate with Dkron using a RESTful JSON API over HTTP. Dkron nodes usually listen on port 8080 for API requests. All examples in this section assume that you've found a running leader at localhost:8080. Dkron implements a RESTful JSON API over HTTP to communicate with software clients. Dkron listens in port 8080 by default. All examples in this section assume that you're using the default port. Default API responses are unformatted JSON add the pretty=true param to format the response.

This SDK is automatically generated by the Swagger Codegen project:

• API version: 1
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen

To build the Ruby code into a gem:

gem build dkron-rb.gemspec

Then either install the gem locally:

gem install ./dkron-rb-1.0.0.gem

(for development, run gem install --dev ./dkron-rb-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'dkron-rb', '~> 1.0.0'

If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:

gem 'dkron-rb', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Please follow the installation procedure and then run the following code:

# Load the gem
require 'dkron-rb'

api_instance = Dkron::DefaultApi.new

begin
  result = api_instance.busy
  p result
rescue Dkron::ApiError => e
  puts "Exception when calling DefaultApi->busy: #{e}"
end

All URIs are relative to http://localhost:8080/v1

• Dkron::Execution
• Dkron::Job
• Dkron::Member
• Dkron::Processors
• Dkron::Restore
• Dkron::Status

All endpoints do not require authorization.