Customer Management
Customer management methods in JSON-RPC API
A customer is a company (or a group within a company) that consumes or distributes backup services and are known as Partners within the JSON-RPC API methods. Customers are organized in a hierarchy with Distributor at the top level.
Customers own backup devices. Each customer is identified by a unique name or ID.
Below is the list of primary methods that let you manage customers.
- Adding a new customer (the AddPartner method)
- Getting a list of customers for a company (the EnumeratePartners method)
- Getting a list of customer properties (the EnumeratePartnerProperties method)
- Getting a list of child customers (the EnumerateChildPartners method)
- Getting customer information by name (the GetPartnerInfo method)
- Getting customer information by ID (the GetPartnerInfoById method)
- Getting customer information by UID (the GetPartnerInfoByUid method)
- Getting customer information history (the GetPartnerInfoHistory method)
- Getting customer state (the GetPartnerState method)
- Getting a customer tree (the GetPartnerTree method)
- Regenerate the customer UID (the RegeneratePartnerUid method)
- Changing the properties of a customer (the ModifyPartner method)
- Removing a customer (the RemovePartner method)
You can identify other customer management methods in the schema by the word Partner in their names.
We are deprecating GetPartnerInfo. This method relies on partner names to identify partners. Because multiple partners can now share the same name, GetPartnerInfo can no longer reliably identify a single partner. See Migrating from GetPartnerInfo to GetPartnerInfoById for details.
Updated 28 days ago
Did this page help you?