Google API Status

The Google API Status check page is an useful tool to quickly check if an API for your domain is failing. This is important as gPanel utilizes API's to read and make the calls necessary for the actions within, I.E. When creating an calendar in gPanel it utilizes the Calendar API in some form to successfully create it for the domain. This is located within the Settings portion of the "Administration module in gPanel. 

 Admin APIs:

 As you've seen there are two different categories present in page. At the top you will see "Admin APIs" then an user selector in the middle followed by the "User APIs" portion. Lets cover the Admin APIs first. 

 Admin APIs allow the administration of Domain resources. Each has an brief description of what it is utilized for within gPanel. 

 Activity Reports:
 Email Audit: Primarily utilized for our Auditing and Gmail Export function. Auditing is the email monitor function found within an users profile. Gmail Export is the mailbox export tool located within the "Tools" module.

 Groups: Primarily utilized for the creation, deletion and updating the names of Groups. Which can be found within "Groups" under the Directory module.

 Group Settings: Primarily used to get, update, read the settings of Groups, such as who can post or view membership. Also located within the Groups portion of the Directory module.

 Mobile Devices: Primarily used in our "Mobile Management" module to approve, wipe and delete devices from your organizations Mobile Management. 

 Organizations: Primarily used within Directory, to create, modify and delete organizational units within your domain. 

 Security: Primarily used for reading the 3 partied applications an user has authorized access to. Which is located under their User Profile. 

 Sites: Primarily used for the "Sites" module within gPanel, as well as creation, share updating & deletion. e

 Usage Reports: Primarily utilized to get User account usage info. Such as the "Last Login" report.

 Users: Primarily used for User Management. The creation, updating and deletion of users and user profile information. 


User APIs:

Now for the "User APIs", these checks are if the API or service is "reachable" via auth. for your Users. This can be checked quickly as well against an user of your choosing by entering the User address in the dynamic field. Let's cover an brief description of each: 

 Calendars: 

 Contacts:

 Drive:

 Email Settings: 

 Spreadsheets: 

 Gmail:

 Gmail Settings:
 That is it for a brief definition of what each represents application wise.

 Enable/Disable API Checks & Notifications:

At the top of the page you will see an notification slider, to enable or disable the check. SImply click on the slider you will see it go to the left for disabled and to the right for enabled.
 The Failure prompt will look like the below, however will state whichever API that is failing for you. 
You can click the "Google API Status page" link and it will bring you to this section of gPanel. The "Click here to learn how to resolve" takes you to our help page for ensuring data and API access is granted properly. There are a lot of factors into why an API may fail, the most common is the service is simply turned "Off" either for an user or for the domain. We also understand that sometimes the access to that service may be required to be off, so to stop receiving these check the "Do not show this notification again" box in the window before closing. 
 Just keep in mind if you do choose this option it will disable the prompt entirely, but can be easily re-enabled from the slider mentioned earlier at the top of the page.

 Then as well you can enable/disable the individual checks for each API. This is usually in case an user may have an service off intentionally, an no longer the application to verify the check. 

 Simply click the slider next to the one desired and you will see it go grey & the green check mark disappear.

 There is also an space to check the API validation of an specific account, this will default to the listed Application Super Admin. However any user account can be entered to check against in page, simply click the field and begin typing the desired one.
 Now to run an manual check with the user entered or just want to check. Click the "curved arrow" icon in the uppermost right hand side for Admin and then in the middle right hand side for User. 

 
   
 



Comments