cloudreactor_api_client

CloudReactorAPIClient - the Ruby gem for the CloudReactor API

CloudReactor API Documentation

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.3.0
• Package version: 0.3.0.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://cloudreactor.io/

Installation

Build a gem

To build the Ruby code into a gem:

gem build cloudreactor_api_client.gemspec

Then either install the gem locally:

gem install ./cloudreactor_api_client-0.3.0.0.gem

(for development, run gem install --dev ./cloudreactor_api_client-0.3.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 'cloudreactor_api_client', '~> 0.3.0.0'

Install from Git

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

gem 'cloudreactor_api_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

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

# Load the gem
require 'cloudreactor_api_client'

# Setup authorization
CloudReactorAPIClient.configure do |config|
  # Configure Bearer authorization: tokenAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = CloudReactorAPIClient::AlertMethodsApi.new
uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
alert_method = CloudReactorAPIClient::AlertMethod.new({name: 'name_example'}) # AlertMethod | 

begin
  result = api_instance.alert_methods_clone_create(uuid, alert_method)
  p result
rescue CloudReactorAPIClient::ApiError => e
  puts "Exception when calling AlertMethodsApi->alert_methods_clone_create: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.cloudreactor.io/api/v1

Class	Method	HTTP request	Description
CloudReactorAPIClient::AlertMethodsApi	alert_methods_clone_create	POST /alert_methods/uuid/clone/
CloudReactorAPIClient::AlertMethodsApi	alert_methods_create	POST /alert_methods/
CloudReactorAPIClient::AlertMethodsApi	alert_methods_destroy	DELETE /alert_methods/uuid/
CloudReactorAPIClient::AlertMethodsApi	alert_methods_list	GET /alert_methods/
CloudReactorAPIClient::AlertMethodsApi	alert_methods_partial_update	PATCH /alert_methods/uuid/
CloudReactorAPIClient::AlertMethodsApi	alert_methods_retrieve	GET /alert_methods/uuid/
CloudReactorAPIClient::AlertMethodsApi	alert_methods_update	PUT /alert_methods/uuid/
CloudReactorAPIClient::EmailNotificationProfilesApi	email_notification_profiles_clone_create	POST /email_notification_profiles/uuid/clone/
CloudReactorAPIClient::EmailNotificationProfilesApi	email_notification_profiles_create	POST /email_notification_profiles/
CloudReactorAPIClient::EmailNotificationProfilesApi	email_notification_profiles_destroy	DELETE /email_notification_profiles/uuid/
CloudReactorAPIClient::EmailNotificationProfilesApi	email_notification_profiles_list	GET /email_notification_profiles/
CloudReactorAPIClient::EmailNotificationProfilesApi	email_notification_profiles_partial_update	PATCH /email_notification_profiles/uuid/
CloudReactorAPIClient::EmailNotificationProfilesApi	email_notification_profiles_retrieve	GET /email_notification_profiles/uuid/
CloudReactorAPIClient::EmailNotificationProfilesApi	email_notification_profiles_update	PUT /email_notification_profiles/uuid/
CloudReactorAPIClient::PagerdutyProfilesApi	pagerduty_profiles_clone_create	POST /pagerduty_profiles/uuid/clone/
CloudReactorAPIClient::PagerdutyProfilesApi	pagerduty_profiles_create	POST /pagerduty_profiles/
CloudReactorAPIClient::PagerdutyProfilesApi	pagerduty_profiles_destroy	DELETE /pagerduty_profiles/uuid/
CloudReactorAPIClient::PagerdutyProfilesApi	pagerduty_profiles_list	GET /pagerduty_profiles/
CloudReactorAPIClient::PagerdutyProfilesApi	pagerduty_profiles_partial_update	PATCH /pagerduty_profiles/uuid/
CloudReactorAPIClient::PagerdutyProfilesApi	pagerduty_profiles_retrieve	GET /pagerduty_profiles/uuid/
CloudReactorAPIClient::PagerdutyProfilesApi	pagerduty_profiles_update	PUT /pagerduty_profiles/uuid/
CloudReactorAPIClient::RunEnvironmentsApi	run_environments_clone_create	POST /run_environments/uuid/clone/
CloudReactorAPIClient::RunEnvironmentsApi	run_environments_create	POST /run_environments/
CloudReactorAPIClient::RunEnvironmentsApi	run_environments_destroy	DELETE /run_environments/uuid/
CloudReactorAPIClient::RunEnvironmentsApi	run_environments_list	GET /run_environments/
CloudReactorAPIClient::RunEnvironmentsApi	run_environments_partial_update	PATCH /run_environments/uuid/
CloudReactorAPIClient::RunEnvironmentsApi	run_environments_retrieve	GET /run_environments/uuid/
CloudReactorAPIClient::RunEnvironmentsApi	run_environments_update	PUT /run_environments/uuid/
CloudReactorAPIClient::TaskExecutionsApi	task_executions_create	POST /task_executions/
CloudReactorAPIClient::TaskExecutionsApi	task_executions_destroy	DELETE /task_executions/uuid/
CloudReactorAPIClient::TaskExecutionsApi	task_executions_list	GET /task_executions/
CloudReactorAPIClient::TaskExecutionsApi	task_executions_partial_update	PATCH /task_executions/uuid/
CloudReactorAPIClient::TaskExecutionsApi	task_executions_retrieve	GET /task_executions/uuid/
CloudReactorAPIClient::TaskExecutionsApi	task_executions_update	PUT /task_executions/uuid/
CloudReactorAPIClient::TasksApi	tasks_create	POST /tasks/
CloudReactorAPIClient::TasksApi	tasks_destroy	DELETE /tasks/uuid/
CloudReactorAPIClient::TasksApi	tasks_list	GET /tasks/
CloudReactorAPIClient::TasksApi	tasks_partial_update	PATCH /tasks/uuid/
CloudReactorAPIClient::TasksApi	tasks_retrieve	GET /tasks/uuid/
CloudReactorAPIClient::TasksApi	tasks_update	PUT /tasks/uuid/
CloudReactorAPIClient::WorkflowExecutionsApi	workflow_executions_create	POST /workflow_executions/
CloudReactorAPIClient::WorkflowExecutionsApi	workflow_executions_destroy	DELETE /workflow_executions/uuid/
CloudReactorAPIClient::WorkflowExecutionsApi	workflow_executions_list	GET /workflow_executions/
CloudReactorAPIClient::WorkflowExecutionsApi	workflow_executions_partial_update	PATCH /workflow_executions/uuid/
CloudReactorAPIClient::WorkflowExecutionsApi	workflow_executions_retrieve	GET /workflow_executions/uuid/
CloudReactorAPIClient::WorkflowExecutionsApi	workflow_executions_retry_create	POST /workflow_executions/uuid/retry/
CloudReactorAPIClient::WorkflowExecutionsApi	workflow_executions_update	PUT /workflow_executions/uuid/
CloudReactorAPIClient::WorkflowExecutionsApi	workflow_executions_workflow_task_instance_executions_create	POST /workflow_executions/uuid/workflow_task_instance_executions/
CloudReactorAPIClient::WorkflowTaskInstancesApi	workflow_task_instances_create	POST /workflow_task_instances/
CloudReactorAPIClient::WorkflowTaskInstancesApi	workflow_task_instances_destroy	DELETE /workflow_task_instances/uuid/
CloudReactorAPIClient::WorkflowTaskInstancesApi	workflow_task_instances_list	GET /workflow_task_instances/
CloudReactorAPIClient::WorkflowTaskInstancesApi	workflow_task_instances_partial_update	PATCH /workflow_task_instances/uuid/
CloudReactorAPIClient::WorkflowTaskInstancesApi	workflow_task_instances_retrieve	GET /workflow_task_instances/uuid/
CloudReactorAPIClient::WorkflowTaskInstancesApi	workflow_task_instances_update	PUT /workflow_task_instances/uuid/
CloudReactorAPIClient::WorkflowTransitionsApi	workflow_transitions_create	POST /workflow_transitions/
CloudReactorAPIClient::WorkflowTransitionsApi	workflow_transitions_destroy	DELETE /workflow_transitions/uuid/
CloudReactorAPIClient::WorkflowTransitionsApi	workflow_transitions_list	GET /workflow_transitions/
CloudReactorAPIClient::WorkflowTransitionsApi	workflow_transitions_partial_update	PATCH /workflow_transitions/uuid/
CloudReactorAPIClient::WorkflowTransitionsApi	workflow_transitions_retrieve	GET /workflow_transitions/uuid/
CloudReactorAPIClient::WorkflowTransitionsApi	workflow_transitions_update	PUT /workflow_transitions/uuid/
CloudReactorAPIClient::WorkflowsApi	workflows_clone_create	POST /workflows/uuid/clone/
CloudReactorAPIClient::WorkflowsApi	workflows_create	POST /workflows/
CloudReactorAPIClient::WorkflowsApi	workflows_destroy	DELETE /workflows/uuid/
CloudReactorAPIClient::WorkflowsApi	workflows_list	GET /workflows/
CloudReactorAPIClient::WorkflowsApi	workflows_partial_update	PATCH /workflows/uuid/
CloudReactorAPIClient::WorkflowsApi	workflows_retrieve	GET /workflows/uuid/
CloudReactorAPIClient::WorkflowsApi	workflows_update	PUT /workflows/uuid/

Documentation for Models

• CloudReactorAPIClient::AlertMethod
• CloudReactorAPIClient::AwsEcsExecutionMethod
• CloudReactorAPIClient::AwsEcsExecutionMethodCapability
• CloudReactorAPIClient::AwsEcsLaunchType
• CloudReactorAPIClient::AwsEcsRunEnvironmentExecutionMethodCapability
• CloudReactorAPIClient::AwsEcsServiceLoadBalancerDetails
• CloudReactorAPIClient::AwsEcsServiceOptions
• CloudReactorAPIClient::CurrentServiceInfo
• CloudReactorAPIClient::EmailNotificationProfile
• CloudReactorAPIClient::ExecutionMethodCapability
• CloudReactorAPIClient::FailureBehaviorEnum
• CloudReactorAPIClient::Group
• CloudReactorAPIClient::Link
• CloudReactorAPIClient::NameAndUuid
• CloudReactorAPIClient::NotificationSeverity
• CloudReactorAPIClient::PagerDutyProfile
• CloudReactorAPIClient::PaginatedAlertMethodList
• CloudReactorAPIClient::PaginatedEmailNotificationProfileList
• CloudReactorAPIClient::PaginatedPagerDutyProfileList
• CloudReactorAPIClient::PaginatedRunEnvironmentList
• CloudReactorAPIClient::PaginatedTaskExecutionList
• CloudReactorAPIClient::PaginatedTaskList
• CloudReactorAPIClient::PaginatedWorkflowExecutionSummaryList
• CloudReactorAPIClient::PaginatedWorkflowSummaryList
• CloudReactorAPIClient::PaginatedWorkflowTaskInstanceList
• CloudReactorAPIClient::PaginatedWorkflowTransitionList
• CloudReactorAPIClient::PatchedAlertMethod
• CloudReactorAPIClient::PatchedEmailNotificationProfile
• CloudReactorAPIClient::PatchedPagerDutyProfile
• CloudReactorAPIClient::PatchedRunEnvironment
• CloudReactorAPIClient::PatchedTask
• CloudReactorAPIClient::PatchedTaskExecution
• CloudReactorAPIClient::PatchedWorkflow
• CloudReactorAPIClient::PatchedWorkflowExecution
• CloudReactorAPIClient::PatchedWorkflowTaskInstance
• CloudReactorAPIClient::PatchedWorkflowTransition
• CloudReactorAPIClient::PropagateTagsEnum
• CloudReactorAPIClient::RuleTypeEnum
• CloudReactorAPIClient::RunEnvironment
• CloudReactorAPIClient::StartTransitionConditionEnum
• CloudReactorAPIClient::StopReasonEnum
• CloudReactorAPIClient::Task
• CloudReactorAPIClient::TaskExecution
• CloudReactorAPIClient::TaskExecutionStatus
• CloudReactorAPIClient::ThresholdPropertyEnum
• CloudReactorAPIClient::TimeoutBehaviorEnum
• CloudReactorAPIClient::UnknownExecutionMethodCapability
• CloudReactorAPIClient::Workflow
• CloudReactorAPIClient::WorkflowExecution
• CloudReactorAPIClient::WorkflowExecutionRunReason
• CloudReactorAPIClient::WorkflowExecutionStatus
• CloudReactorAPIClient::WorkflowExecutionStopReason
• CloudReactorAPIClient::WorkflowExecutionSummary
• CloudReactorAPIClient::WorkflowSummary
• CloudReactorAPIClient::WorkflowTaskInstance
• CloudReactorAPIClient::WorkflowTaskInstanceExecution
• CloudReactorAPIClient::WorkflowTaskInstanceExecutionBase
• CloudReactorAPIClient::WorkflowTransition
• CloudReactorAPIClient::WorkflowTransitionEvaluation

Documentation for Authorization

tokenAuth

• Type: Bearer authentication