Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.14 KB

PingApi.md

File metadata and controls

56 lines (37 loc) · 1.14 KB

SwaggerClient::PingApi

All URIs are relative to http://localhost/api/v2.0

Method HTTP request Description
ping_get GET /ping Ping Harbor to check if it's alive.

ping_get

String ping_get

Ping Harbor to check if it's alive.

This API simply replies a pong to indicate the process to handle API is up, disregarding the health status of dependent components.

Example

# load the gem
require 'harbor_swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure HTTP basic authorization: basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = SwaggerClient::PingApi.new

begin
  #Ping Harbor to check if it's alive.
  result = api_instance.ping_get
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling PingApi->ping_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

basic

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain