AHSAY API PDFJune 16, 2020
5. Configure AhsayRDR. AhsayOBS Host Name. 9 External API References. 29 March Update: FreeBSD. 5 Configure AhsayRDR. According to the documentation the following should be returned from the API call. Howeverm the ones in bold are missing whenever I try to. PHP API wrapper for AhsayOBS 6 & 7. Contribute to hannesbe/php-ahsay-api- wrapper development by creating an account on GitHub.
|Published (Last):||16 October 2011|
|PDF File Size:||19.12 Mb|
|ePub File Size:||16.50 Mb|
|Price:||Free* [*Free Regsitration Required]|
MyClient Enterprise allows you to create deeper integration with your own systems by providing external forms and API methods. Each form or method is protected by an access token, which can be generated from the “External wpi and API methods” link on the “System Settings” page. When creating the access token for a form, you may optionally specify a URL to redirect to when the form has been completed.
If no URL is entered, upon completion the form will display the content set in an appropriate template. MyClient allows you and your resellers to embed the Customer Signup form into your own website.
Ahsay Knowledge Base & Discussion Forum • GetBackupJobReport API not returning all values
By specifying a reseller when creating the access token, the form will display the selected plan group and automatically assign the new customer to the correct owner. If the form is completed and no redirect URL is specified by the access token, this form displays the content from the “New Customer Confirmation external form ” template.
The status code ranges from upon success, and upon error. The message parameter provides a human-readable English description of any errors, or may contain a more complex object depending on the API call in question.
This API allows you to verify your network connectivity and authentication credentials against the MyClient server. This API allows you to retrieve the result of a search. This API allows you to create a new Ahsay account. The created account will be added to a new MyClient record.
The created account follows the same processes used when creating an account from within MyClient, including respecting your settings regarding email alerts, usergroup overrides, server selection and welcome emails. An unsuccessful response from this API will include a human-readable error message, tailored to the level of access granted by the supplied access token. This API allows you to list Ahsay accounts.
This API will only return a list of direct customers. Access tokens for resellers who are parent resellers of other sub-resellers will not see their subreseller customers included in the results from this API call. This API allows you to retrieve specific information about an Ahsay accounts. For more information about the results produced, please see the documentation for the ahsay-get-info-multi API call. This call requires that the reseller in question would normally have permission to view this customer within the main MyClient portal.
This API allows you to suspend or unsuspend Ahsay accounts. This call requires that the reseller in question would normally have permission to perform this action.
External Forms and API | MyClient, the ultimate management portal for Ahsay backup servers
Connectivity ahsau This API allows you to verify your network connectivity and authentication credentials against the MyClient server. Mandatory if the action parameter was event-usernameevent-backupset or event-backupjob. Mandatory if the action parameter was event-backupset or event-backupjob. Mandatory if the action parameter was event-backupjob. Export data This API allows you to retrieve the result of a search.
Parameter Description action Must be export auth A valid access token search One of search-customers-ahsaysearch-customers-asigrasearch-backupsetssearch-backupjobssearch-shadowprotect-volumes or search-servers sid A search ID. Parameter Description action Must be create-reseller-office auth A valid access token office-name The company name for the new reseller office operator-first-name System Operator’s wpi name operator-last-name System Operator’s last name operator-email System Operator’s email address, used absay log in with operator-password Optional System Operator’s password.
Must conform to your configured system password policy permission-group-id Optional Permission group ID for this reseller office. Parameter Description action Must be ahsay-create auth A whsay access token email The customer’s email address username Username for the new account password Password for the new account quota-gb Quota for the new account.
Must be a positive number of gigabytes is-trial Optional Whether to create the account in Trial mode.
External Forms and API
Must be either “Y” or “N”. Default zero unlimited customer-name Optional The customer’s full company name phone Optional The customer’s contact phone number first-name Optional The first name for the wpi contact person last-name Optional The last name for the primary contact person address1 Optional The customer’s address address2 Optional The customer’s address, continued address3 Optional The customer’s address, continued address-city Optional The customer’s city address-country Optional The customer’s country address-postcode Optional The customer’s postcode plan-name Optional The plan this customer will use reseller-name Optional The reseller to be assigned to this customer.
Ignored if the reseller’s office name is not unique or the ‘auth’ access token doesn’t belong to the primary office.
This API call will return the following fields for each matching Ahsay account: Retrieve information about specific account This API allows you to retrieve specific information about an Ahsay accounts. Can be retrieved via apu ahsay-get-info call. The value should be a number of gigabytes. Live demo Sign up.
Optional Ahsay Backupset ID. Optional Ahsay Backupjob ID. One of search-customers-ahsaysearch-customers-asigrasearch-backupsetssearch-backupjobssearch-shadowprotect-volumes or search-servers. Optional System Operator’s password. Must conform to your configured system password policy.
Optional Permission group ID whsay this reseller office. Optional Whether to create the account in Trial mode.
Optional The reseller to be assigned to this customer.