module Octokit::EnterpriseManagementConsoleClient::ManagementConsole
Methods for the Enterprise Management Console API
@see developer.github.com/v3/enterprise-admin/management_console/
Public Instance Methods
Source
# File lib/octokit/enterprise_management_console_client/management_console.rb, line 54 def config_status octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.') get '/setup/api/configcheck', password_hash end
Get information about the Enterprise installation
@return [Sawyer::Resource] The installation information
Source
# File lib/octokit/enterprise_management_console_client/management_console.rb, line 74 def edit_settings(settings) octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.') queries = password_hash queries[:query][:settings] = settings.to_json.to_s put '/setup/api/settings', queries end
Modify the Enterprise settings
@param settings [Hash] A hash configuration of the new settings
@return [nil]
Source
# File lib/octokit/enterprise_management_console_client/management_console.rb, line 84 def maintenance_status octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.') get '/setup/api/maintenance', password_hash end
Get information about the Enterprise maintenance status
@return [Sawyer::Resource] The maintenance status
Source
# File lib/octokit/enterprise_management_console_client/management_console.rb, line 94 def set_maintenance_status(maintenance) octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.') queries = password_hash queries[:query][:maintenance] = maintenance.to_json.to_s post '/setup/api/maintenance', queries end
Start (or turn off) the Enterprise maintenance mode
@param maintenance [Hash] A hash configuration of the maintenance settings @return [nil]
Source
# File lib/octokit/enterprise_management_console_client/management_console.rb, line 63 def settings octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.') get '/setup/api/settings', password_hash end
Get information about the Enterprise installation
@return [Sawyer::Resource] The settings
Source
# File lib/octokit/enterprise_management_console_client/management_console.rb, line 31 def start_configuration octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.') post '/setup/api/configure', password_hash end
Start a configuration process.
@return nil
Source
# File lib/octokit/enterprise_management_console_client/management_console.rb, line 41 def upgrade(license) octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.') conn = faraday_configuration params = {} params[:license] = Faraday::UploadIO.new(license, 'binary') params[:api_key] = @management_console_password @last_response = conn.post('/setup/api/upgrade', params) end
Upgrade an Enterprise installation
@param license [String] The path to your .ghl license file.
@return nil
Source
# File lib/octokit/enterprise_management_console_client/management_console.rb, line 16 def upload_license(license, settings = nil) octokit_warn('The Management Console API will be deprecated in GitHub Enterprise Server 3.15.0, please use the ManageGHES client instead.') conn = faraday_configuration params = {} params[:license] = Faraday::UploadIO.new(license, 'binary') params[:password] = @management_console_password params[:settings] = settings.to_json.to_s unless settings.nil? @last_response = conn.post('/setup/api/start', params) end
Uploads a license for the first time
@param license [String] The path to your .ghl license file. @param settings [Hash] A hash configuration of the initial settings.
@see docs.github.com/en/enterprise-server@3.4/rest/enterprise-admin/management-console#create-a-github-license @return nil