Revision as of 19:26, 6 May 2016

Account Management API

The account management API provides methods for managing the account contacts, users and products. Clients can update the status of the account products as well as change (upgrade/downgrade) them.

download this selection of articles as a PDF book

Account Management

• GET /accounts - Returns list of accounts authorized for access with the provided credentials
• GET /accounts/{accountId} - Returns information about an account
• GET /partnerAccounts/{partnerAccountId} - Returns information about an account specified by its partner Id
• PUT /accounts/{accountId} - Updates account status
• PUT /partnerAccounts/{partnerAccountId} - Updates account status for account specified by its partner Id
• DELETE /accounts/{accountId} - Purges an account from the system
• DELETE /partnerAccounts/{partnerAccountId} - Purges an account specified by its partner Id from the system
• GET /accounts/{accountId}/action/interFranchiseMigration - Returns information about an account's migration to another franchise
• POST /accounts/{accountId}/action - Initiate an action on an account

Account Attributes Management

• GET /accounts/{accountId}/attributes - Returns list of attributes
• GET /partnerAccounts/{partnerAccountId}/attributes - Returns list of attributes using Partner Account Id
• POST /accounts/{accountId}/attributes - Creates new attribute
• POST /partnerAccounts/{partnerAccountId}/attributes - Creates new attribute using Partner Account Id
• GET /accounts/{accountId}/attributes/{attribute} - Gets attribute using Account ID
• GET /partnerAccounts/{partnerAccountId}/attributes/{attribute} - Gets attribute using Partner Account Id
• PUT /accounts/{accountId}/attributes/{attribute} - Updates attribute value
• PUT /partnerAccounts/{partnerAccountId}/attributes/{attribute} - Updates attribute value using Partner Account Id
• DELETE /accounts/{accountId}/attributes/{attribute} - Deletes attribute
• DELETE /partnerAccounts/{partnerAccountId}/attributes/{attribute} - Deletes attribute using Partner Account Id

Contacts Management

• GET /accounts/{accountId}/contacts - Returns all contacts for an account
• GET /accounts/{accountId}/contacts/{contactType} - Returns specific contact type for an account
• PUT /accounts/{accountId}/contacts - Set all contacts for an account
• PUT /accounts/{accountId}/contacts/{contactType} - Set specific contact type for an account

Actions

• POST /accounts/{account_number}/contacts/action - Initiate Email Verification Action

ZenDesk SSO Link

• GET /accounts/{accountId}/contacts/{contactType}/supportSSOLink - Returns ZendDesk SSO Link Per Contact Type

Users Management

• GET /accounts/{accountId}/users - Returns a list of users in the account
• POST /accounts/{accountId}/users - Creates a new user in the account
• GET /accounts/{accountId}/user/{userName} - Returns the details of a specific user in the account
• PUT /accounts/{accountId}/user/{userName} - Updates the user details (password, security question/answer)
• PUT /accounts/{accountId}/user - (Deprecated) Updates the user details (password, security question/answer) of a user
• DELETE /accounts/{accountId}/user/{userName} - Deletes a user
• GET /accounts/{accountId}/user/{userName}/roles - Returns the list of roles of a user
• PUT /accounts/{accountId}/user/{userName}/roles - Updates the list of roles of a user

Products Management

• GET /accounts/{accountId}/products - Gets all products for an account
• GET /accounts/{accountId}/products/{productId} - Get information about a product
• PUT /accounts/{accountId}/products/{productId} - Update the status of a product
• POST /accounts/{accountId}/products/{productId}/action - Perform an action (e.g: upgrade/downgrade) for a product
• GET /accounts/{accountId}/products/{productId}/services - List services for a specific product
• GET /accounts/{accountId}/products/{productId}/services/{serviceId} - Get information about a specific service
• PUT /accounts/{accountId}/products/{productId}/services/{serviceId} - Update the status of a specific service
• GET /accounts/{accountId}/products/{productId}/services/{serviceId}/?getTargetServiceSpecifications=1 - Get allowed specific service changes
• POST /accounts/{accountId}/products/{productId}/services/{serviceId}/action - Perform an action (e.g: upgrade/downgrade) for a specific service

Products Bandwidth Management

• GET /accounts/{accountId}/products/{productId}/bandwidth/daily?filterType={filterType}&from={filterStartDate}&to={filterEndDate} - Get a report on the daily bandwidth usage of the product
• GET /accounts/{accountId}/products/{productId}/bandwidth/weekly?filterType={filterType}&from={filterStartDate}&to=filterEndDate} - Get a report on the weekly bandwidth usage of the product
• GET /accounts/{accountId}/products/{productId}/bandwidth/monthly?filterType={filterType}&from={filterStartDate}&to=filterEndDate} - Get a report on the monthly bandwidth usage of the product
• GET /accounts/{accountId}/products/{productId}/bandwidth/yearly?filterType={filterType}&from={filterStartDate}&to=filterEndDate} - Get a report on the yearly bandwidth usage of the product

Each bandwidth usage is filtered by the traffic type(www or ftp), the start date and the end date in ISO format(eg. 2013-20-02).

Products Usage Management

• GET /accounts/{accountId}/products/{productId}/usage - Get an aggregated services usage report of a product

Payment info

• GET /accounts/{accountId}/paymentInfo - Get a list of active payment methods
• POST /accounts/{accountId}/paymentInfo - Add a payment method for a given account
• PUT /accounts/{accountId}/paymentInfo/default - Set the default payment method
• DELETE /accounts/{accountId}/paymentInfo/default - Unset the default payment method
• GET /accounts/{accountId}/paymentInfo/{paymentInfoId} - Get information about an active payment method
• DELETE /accounts/{accountId}/paymentInfo/{paymentInfoId} - Remove an active payment method
• POST /accounts/{accountId}/paymentInfo/{paymentInfoId}/payment - Make a one-time payment toward the account balance

Transactions

• GET /accounts/{accountId}/transaction - Get a list of account's transactions
• GET /accounts/{accountId}/transaction?filterType={filterType} - Get a list of account's transactions filtered by Transaction type
• GET /accounts/{accountId}/transaction?sortField={sortField} - Get a list of account's transactions sorted by sortField param

Invoices

• GET /accounts/{accountId}/invoices - Get a list of account's invoices
• GET /accounts/{accountId}/invoices?filterStatus={filterStatus} - Get a list of account's invoices filtered by Invoice status
• GET /accounts/{accountId}/invoices?sortField={sortField} - Get a list of account's invoices sorted by sortField param
• GET /accounts/{accountId}/invoices/{invoiceId} - Get invoice info or pdf

Invoice Transactions

• GET /accounts/{accountId}/invoices/{invoiceId}/transactions - Get a list of invoice transactions

Account Discount

• GET /accounts/{accountId}/discount - Get account level discount

Security/Firewall Group

A Security/Firewall Group defines firewall rules for your Server. You have the ability to configure your firewall connections and secure your network as required. You may have one or multiple servers behind a firewall group. Hostway provides a default firewall group, and typical firewall rules are already configured. You can create multiple firewall groups as needed.

• GET /accounts/{accountId}/os-security-groups - Get a list of account's firewall groups
• POST /accounts/{accountId}/os-security-groups - Create firewall group for account
• GET /accounts/{accountId}/os-security-groups/{groupId} - Get firewall group details
• PUT /accounts/{accountId}/os-security-groups/{groupId} - Update firewall group
• DELETE /accounts/{accountId}/os-security-groups/{groupId} - Delete firewall group
• POST /accounts/{accountId}/os-security-group-rules - Create firewall group rule
• DELETE /accounts/{accountId}/os-security-group-rules/{ruleId} - Delete firewall group rule

See also

• Common Features