Skip to content

Latest commit

 

History

History
87 lines (52 loc) · 2.7 KB

APIInfoApi.md

File metadata and controls

87 lines (52 loc) · 2.7 KB

\APIInfoApi

All URIs are relative to https://platform.devtest.ringcentral.com

Method HTTP request Description
GetAPIVersion Get /restapi Get API Versions
GetVersionInfo Get /restapi/{apiVersion} Get Version Info
LoadAPIStatus Get /restapi/v1.0/status Get Status

GetAPIVersion

GetVersionsResponse GetAPIVersion(ctx, ) Get API Versions

Since 1.0.0

Returns current API version(s) and server info.

Usage Plan Group

Light

Required Parameters

This endpoint does not need any parameter.

Return type

GetVersionsResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetVersionInfo

GetVersionResponse GetVersionInfo(ctx, apiVersion) Get Version Info

Since 1.0.0

Returns current API version info by apiVersion.

Usage Plan Group

Light

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string API version to be requested, for example 'v1.0'

Return type

GetVersionResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

LoadAPIStatus

LoadAPIStatus(ctx, ) Get Status

Since 1.0.27 (Release 8.3)

Returns the API status; status '200' means the API is working fine, and '503' means it is temporary unavailable.

API Group

Light

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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