Child pages
  • WHM API 1 Functions - backup_does_client_id_have_google_credentials
Skip to end of metadata
Go to start of metadata

Description

This function returns whether a Google Drive client ID credential file exists.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/backup_does_client_id_have_google_credentials?api.version=1&client_id=aBcdeFgHIjK123
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/backup_does_client_id_have_google_credentials?api.version=1&client_id=aBcdeFgHIjK123
 Command Line
whmapi1 backup_does_client_id_have_google_credentials client_id=aBcdeFgHIjK123


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
   "data":{
      "exists":1
   },
   "metadata":{
      "reason":"OK",
      "command":"backup_does_client_id_have_google_credentials",
      "result":1,
      "version":1
   }
}
 Output (XML)
<result>
   <data>
      <exists>1</exists>
   </data>
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>backup_does_client_id_have_google_credentials</command>
   </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
client_idstring

Required

The user's Google Drive client ID.

A valid client ID. aBcdeFgHIjK123

Returns

ReturnTypeDescriptionPossible valuesExample
existsBooleanWhether Google credentials exist for the Google Drive client ID.
  • 1 — Google Drive credentials exist.
  • 0 — Google Drive credentials do not exist.
1