Skip to content

Latest commit

 

History

History
107 lines (74 loc) · 3.24 KB

QuotasSettingsApi.md

File metadata and controls

107 lines (74 loc) · 3.24 KB
Raw

purity_fb_1dot12.QuotasSettingsApi

All URIs are relative to https://purity_fb_server/api

Method HTTP request Description
list_quotas_settings GET /1.12/quotas/settings
update_quotas_settings PATCH /1.12/quotas/settings

list_quotas_settings

QuotasSettingResponse list_quotas_settings()

List quotas notification settings.

Example

from purity_fb import PurityFb, rest

fb = PurityFb('10.255.8.20') # assume the array IP is 10.255.8.20
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print('Exception when logging in to the array: %s\n' % e)
if res:
    try:
        # check the contact info being sent to end users and groups regarding their quotas, and
        # check if direct notifications to them are enabled
        res = fb.quotas_settings.list_quotas_settings()
        # print the result of our list for record keeping
        print(res)
    except rest.ApiException as e:
        print("Exception when listing quotas settings: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

QuotasSettingResponse

Authorization

AuthTokenHeader

HTTP request headers

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

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

update_quotas_settings

QuotasSettingResponse update_quotas_settings(quotas_setting)

Update quotas notification settings.

Example

from purity_fb import PurityFb, QuotasSetting, rest

fb = PurityFb('10.255.8.20') # assume the array IP is 10.255.8.20
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print('Exception when logging in to the array: %s\n' % e)
if res:
    try:
        # set our contact info to a person and their email, and enable direct notification of
        # users and groups regarding their quotas
        new_contact = 'John Doe - [email protected]'
        update_settings = QuotasSetting(contact=new_contact, direct_notifications_enabled=True)
        res = fb.quotas_settings.update_quotas_settings(quotas_setting=update_settings)
        # print the result of our update for record keeping
        print(res)
    except rest.ApiException as e:
        print("Exception when updating quotas settings: %s\n" % e)

Parameters

Name Type Description Notes
quotas_setting QuotasSetting

Return type

QuotasSettingResponse

Authorization

AuthTokenHeader

HTTP request headers

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

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