Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 1.37 KB

PingApi.md

File metadata and controls

44 lines (27 loc) · 1.37 KB

\PingApi

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

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

GetPing

string GetPing(ctx, optional) 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.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *PingApiGetPingOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PingApiGetPingOpts struct

Name Type Description Notes
xRequestId optional.String An unique ID for the request

Return type

string

Authorization

basic

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]